2e7108d366## Motivation and Context Docs currently don't have very clear organisation, and don't explain core flows. This fixes #89 (although we still might want to push these to `https://modelcontextprotocol.io/docs/`), based on the plan there. One minor change from that plan is that I merged tutorials and guides, because they ended up basically being duplicates which I thought would be annoying for us to keep in sync. Additionally in the Diátaxis framework, tutorials and guides are separated by whether they are focused on acquisition of skills (e.g. in a learning environment) or application of skills (e.g. in a work environment). I expect the registry to be something that will be used occasionally in a work environment, rather than a fundamental 'learnable' skill so I think it's reasonable not to have tutorials and fold these into guides. ## How Has This Been Tested? - Read through all these updated docs - Unit and integration tests (that previously used examples.md and use the schema) working - Ran `npx markdown-link-check .` to check all the links work ## Breaking Changes Links to old docs will break, but I don't think there are any. All internal links have been checked and updated. ## Types of changes <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [x] Documentation update
48 lines
2.1 KiB
Markdown
48 lines
2.1 KiB
Markdown
# Official MCP Registry API
|
|
|
|
This document describes the API for the official MCP Registry hosted at `registry.modelcontextprotocol.io`.
|
|
|
|
This API is based on the [generic registry API](./generic-registry-api.md) with additional endpoints and authentication. For practical examples of consuming the API, see the [API usage guide](../../guides/consuming/use-rest-api.md). For publishing servers using the API, see the [publishing guide](../../guides/publishing/publish-server.md).
|
|
|
|
## Base URLs
|
|
|
|
- **Production**: `https://registry.modelcontextprotocol.io`
|
|
- **Staging**: `https://staging.registry.modelcontextprotocol.io`
|
|
|
|
## Interactive Documentation
|
|
|
|
- **[Live API Docs](https://registry.modelcontextprotocol.io/docs)** - Stoplight elements with try-it-now functionality
|
|
- **[OpenAPI Spec](https://registry.modelcontextprotocol.io/openapi.yaml)** - Complete machine-readable specification
|
|
|
|
## Extensions
|
|
|
|
The official registry implements the [Generic Registry API](./generic-registry-api.md) with the following specific configurations and extensions:
|
|
|
|
### Authentication
|
|
|
|
Publishing requires namespace-based authentication:
|
|
|
|
- **GitHub OAuth** - For `io.github.*` namespaces
|
|
- **GitHub OIDC** - For publishing from GitHub Actions
|
|
- **DNS verification** - For domain-based namespaces (`com.example.*`)
|
|
- **HTTP verification** - For domain-based namespaces (`com.example.*`)
|
|
|
|
See [Publisher Commands](../cli/commands.md) for authentication setup.
|
|
|
|
### Package Validation
|
|
|
|
The official registry enforces additional [package validation requirements](../server-json/official-registry-requirements.md) when publishing.
|
|
|
|
### Additional endpoints
|
|
|
|
#### Auth endpoints
|
|
- POST `/v0/auth/dns` - Exchange signed DNS challenge for auth token
|
|
- POST `/v0/auth/http` - Exchange signed HTTP challenge for auth token
|
|
- POST `/v0/auth/github-at` - Exchange GitHub access token for auth token
|
|
- POST `/v0/auth/github-oidc` - Exchange GitHub OIDC token for auth token
|
|
- POST `/v0/auth/oidc` - Exchange Google OIDC token for auth token (for admins)
|
|
|
|
#### Admin endpoints
|
|
- GET `/metrics` - Prometheus metrics endpoint
|
|
- GET `/v0/health` - Basic health check endpoint
|
|
- PUT `/v0/servers/{id}` - Edit existing server
|