The publishing guide incorrectly suggested users could verify their
server by directly accessing `/servers/{server-name}` or
`/v0/servers/{server-name}`, but the API only supports:
1. **Search by name**: `GET /v0/servers?search={server-name}`
2. **Get by UUID**: `GET /v0/servers/{uuid}`
This PR updates the documentation to show the correct verification
method using the search endpoint.
Fixes #410
3.7 KiB
Consuming Registry Data via REST API
Integration patterns and best practices for building applications that consume MCP registry data.
Key details
Base URL: https://registry.modelcontextprotocol.io
Authentication: Not required for read-only access
GET /v0/servers- List all servers with paginationGET /v0/servers/{id}- Get server details by UUID
See the interactive API documentation for complete request/response schemas.
Disclaimer: The official registry provides no uptime or data durability guarantees. You should design your applications to handle service downtime via caching.
Building a subregistry
Create enhanced registries - ETL official registry data and add your own metadata like ratings, security scans, or compatibility info.
For now we recommend scraping the GET /v0/servers endpoint on some regular basis. In the future we might provide a filter for updated_at (#291) to get only recently changed servers.
Servers are generally immutable, except for the status field which can be updated to deleted (among other states). For these packages, we recommend you also update the status field to deleted or remove the package from your registry quickly. This is because this status generally indicates it has violated our permissive moderation guidelines, suggesting it is illegal, malware or spam.
Filtering & Enhancement
The official registry has a permissive moderation policy, so you may want to implement your own filtering on top of registry data.
You can also add custom metadata to servers using the _meta field. For example, user ratings, download counts, or security scan results. If you do this, we recommend you put this under a key that is namespaced to your organization, for example:
{
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-07-09/server.schema.json",
"name": "io.github.yourname/weather-server",
"description": "MCP server for weather data access",
"status": "active",
"version": "1.0.0",
"packages": [
{
"registry_type": "npm",
"identifier": "weather-mcp-server",
"version": "1.0.0"
}
],
"_meta": {
"com.example.subregistry/custom": {
"user_rating": 4.5,
"download_count": 12345,
"security_scan": {
"last_scanned": "2024-06-01T12:00:00Z",
"vulnerabilities_found": 0
}
}
}
}
Providing an API
We recommend that your subregistry provides an API meeting the registry API specification, so it's easy for clients to switch between registries. See the registry API documentation for details.
MCP Client Integration
Convert registry data to client configuration - Fetch servers and transform package information into your MCP client's config format.
We highly recommend using a subregistry rather than fetching data from the official registry directly. You might want to make this configurable so that users of your client can choose their preferred registry, for example we expect that some enterprise users may have their own registry.
Your client should gracefully handle registries that meet the minimum spec, i.e. avoid hard dependencies on _meta fields.
Filtering
You likely should filter out servers that are not active in the status field.
Running servers
You can use the packages or remotes field to determine how to run a server. More details of these fields are in the server.json documentation.