modelcontextprotocol/registry
Watch
1
0
Fork
You've already forked registry
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update docs for new package registry contributions (#362)

Browse source 
Following PR #350, added documentation for new validation requirements:
- Registry validators now require ownership verification metadata
- Updated prerequisites to include validation mechanism requirement
- Added implementation steps for registry validators
- Included validation examples for existing registries (npm, pypi,
nuget, oci, mcpb)

Fixes #361

Generated with [Claude Code](https://claude.ai/code)

---------

Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Co-authored-by: adam jones <domdomegg@users.noreply.github.com>
This commit is contained in:
adam jones 2025-09-05 16:42:08 +01:00 • committed by GitHub
commit e4002fd19d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 19 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/new_package_registry.md
View file

@ -4,7 +4,7 @@ The MCP Registry project is a **metaregistry**, meaning that it hosts metadata f
For local MCP servers, the MCP Registry has pointers in the `packages` node of the [`server.json`](server-json/README.md) schema that refer to packages in supported package managers.
The list of supported package managers for hosting MCP servers is defined by the `properties.packages[N].properties.registry_name` string enum in the [`server.json` schema](server-json/server.schema.json). For example, this could be "npm" (for npmjs.com packages) or "pypi" (for PyPI packages).
The list of supported package managers for hosting MCP servers is defined by the `properties.packages[N].properties.registry_type` string enum in the [`server.json` schema](server-json/server.schema.json). For example, this could be "npm" (for npmjs.com packages) or "pypi" (for PyPI packages).
For remote MCP servers, the package registry is not relevant. The MCP client consumes the server via a URL instead of by downloading and running a package. In other words, this document only applies to local MCP servers.
@ -21,19 +21,32 @@ The package registry must meet the following requirements:
- For example, the MCP client can map the `server.json` metadata to an `npx` CLI execution, with args and environment variables populated via user input.
1. The package registry supports anonymous package downloads. This allows the MCP client software to use the metadata found in the MCP registry to discover, download, and execute package-based local MCP servers with minimal user intervention.
- `npx` by default connects to the public npmjs.com registry, allowing simple consumption of public npm packages.
1. The package registry should support a validation mechanism to verify ownership of the server name. This prevents misattribution and ensures that only the actual package owner can reference their packages in server registrations. For example:
- npm requires an `mcpName` field in `package.json` that matches the server name being registered
- PyPI requires a `mcp-name:` line in the package README/description
- Each registry type must implement a validation mechanism accessible via public API
## Steps
These steps are currently very brief because the MCP Registry service is not yet deployed to production. These steps may evolve as additional validations or details are discovered and mandated.
These steps may evolve as additional validations or details are discovered and mandated.
1. [Create a feature request issue](https://github.com/modelcontextprotocol/registry/issues/new?template=feature_request.md) on the MCP Registry repository to begin the discussion about adding the package registry.
- Example for NuGet: https://github.com/modelcontextprotocol/registry/issues/126
1. Open a PR with the following changes:
- Update the [`server.json` schema](server-json/server.schema.json)
- Add your package registry name to the `registry_name` enum value array.
- Add your package registry name to the `registry_type` example array.
- Add your package registry base url to the `registry_base_url` example array.
- Add the single-shot CLI command name to the `runtime_hint` example value array.
- Update the [`openapi.yaml`](openapi.yaml)
- Add your package registry name to the `registry_name` enum value array.
- Update the [`openapi.yaml`](server-registry-api/openapi.yaml)
- Add your package registry name to the `registry_type` enum value array.
- Add your package registry base url to the `registry_base_url` enum value array.
- Add the single-shot CLI command name to the `runtime_hint` example value array.
- This duplicates the previous step and will be improved with [issue #159](https://github.com/modelcontextprotocol/registry/issues/159).
- Add a sample, minimal `server.json` to the [`server.json` examples](server-json/examples.md).
- Implement a registry validator:
- Create a new validator file: `internal/validators/registries/yourregistry.go`, following the pattern of existing validators. Examples:
- **npm**: Checks for an `mcpName` field in `package.json` that matches the server name
- **PyPI**: Searches for `mcp-name: server-name` format in the package README content
- **NuGet**: Looks for `mcp-name: server-name` format in the package README file
- **Docker/OCI**: Validates a Docker image label `io.modelcontextprotocol.server.name` in the image manifest
- Add corresponding unit tests: `internal/validators/registries/yourregistry_test.go`
- Register your validator in `internal/validators/validators.go`