Big docs tidy up in preparation for launch (#364)
## 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
This commit is contained in:
adam jones
GitHub
parent
e9884c1d7b
commit
2e7108d366
7 changed files with 1200 additions and 376 deletions
21
docs/guides/README.md
Normal file
21
docs/guides/README.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# How-To Guides
|
||||
|
||||
Problem-oriented guides for specific tasks with the MCP Registry.
|
||||
|
||||
## Publishing Servers
|
||||
|
||||
- [Publish a server](publishing/publish-server.md)
|
||||
- [GitHub Actions](publishing/github-actions.md)
|
||||
|
||||
## Consuming Registry Data
|
||||
|
||||
- [Use the REST API](consuming/use-rest-api.md)
|
||||
|
||||
## Contributing
|
||||
|
||||
- [Add package registry](contributing/add-package-registry.md)
|
||||
|
||||
## Administration
|
||||
|
||||
- [Admin operations](administration/admin-operations.md)
|
||||
- [Moderation guidelines](administration/moderation-guidelines.md)
|
||||
46
docs/guides/administration/admin-operations.md
Normal file
46
docs/guides/administration/admin-operations.md
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
# Admin Operations
|
||||
|
||||
This is a brief guide for admins and moderators managing content on the registry. All actions should be taken in line with the [moderation guidelines](moderation-guidelines.md).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Admin account with @modelcontextprotocol.io email
|
||||
- If you are a maintainer and would like an account, ask in the Discord
|
||||
- `gcloud` CLI installed and configured
|
||||
- `curl` and `jq` installed
|
||||
|
||||
## Authentication
|
||||
|
||||
```bash
|
||||
# Run this, then run the export command it outputs
|
||||
./tools/admin/auth.sh
|
||||
```
|
||||
|
||||
## Edit a Server
|
||||
|
||||
Step 1: Download Server
|
||||
|
||||
```bash
|
||||
export SERVER_ID="<server-uuid>"
|
||||
curl -s "https://registry.modelcontextprotocol.io/v0/servers/${SERVER_ID}" > server.json
|
||||
```
|
||||
|
||||
Step 2: Open `server.json` and make changes. You cannot change the server name.
|
||||
|
||||
Step 3: Push Changes
|
||||
|
||||
```bash
|
||||
curl -X PUT "https://registry.modelcontextprotocol.io/v0/servers/${SERVER_ID}" \
|
||||
-H "Authorization: Bearer ${REGISTRY_TOKEN}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "{\"server\": $(cat server.json)}"
|
||||
```
|
||||
|
||||
## Takedown a Server
|
||||
|
||||
```bash
|
||||
export SERVER_ID="<server-uuid>"
|
||||
./tools/admin/takedown.sh
|
||||
```
|
||||
|
||||
This soft deletes the server. If you need to delete the content of a server (usually only where legally necessary), use the edit workflow above to scrub it all.
|
||||
60
docs/guides/administration/moderation-guidelines.md
Normal file
60
docs/guides/administration/moderation-guidelines.md
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
# Moderation Guidelines
|
||||
|
||||
Guidelines for server publishers on the Official MCP Registry.
|
||||
|
||||
## TL;DR
|
||||
|
||||
We're quite permissive! We only remove illegal content, malware, spam and completely broken servers.
|
||||
|
||||
We don't make guarantees about our moderation, and subregistries should take our data "as is", assuming minimal to no moderation.
|
||||
|
||||
## Scope
|
||||
|
||||
These guidelines apply to the **Official MCP Registry** at `registry.modelcontextprotocol.io`.
|
||||
|
||||
Subregistries may have their own moderation policies. If you have questions about content on a specific subregistry, please contact them directly.
|
||||
|
||||
## Disclaimer
|
||||
|
||||
We have limited active moderation capabilities, and this is a community supported projects. We largely rely on upstream package registries (like NPM, PyPi, and Docker) or downstream subregistries (like the GitHub MCP Registry) to do more in-depth moderation.
|
||||
|
||||
This means there may be content in the registry that should be removed under these guidelines, which we haven't yet removed. You should treat registry data accordingly.
|
||||
|
||||
## What We Remove
|
||||
|
||||
We'll remove servers that contain:
|
||||
|
||||
- Illegal content, which includes obscene content, copyright violations, and hacking tools
|
||||
- Malware, regardless of intentions
|
||||
- Spam, especially mass-created servers that disrupt the registry. Examples:
|
||||
- The same server being submitted multiple times under different names.
|
||||
- The server doesn't do anything but provide a fixed response with some marketing copy.
|
||||
- The server description is stuffed with marketing copy, and its implementation is unrelated to its name or description.
|
||||
- Non-functioning servers
|
||||
|
||||
## What We Don't Remove
|
||||
|
||||
Generally, we believe in keeping the registry open and pushing moderation to subregistries. We therefore **won't** remove servers that are:
|
||||
|
||||
- Low quality or buggy servers
|
||||
- Servers with security vulnerabilities
|
||||
- Do the same thing as other servers
|
||||
- Provide or contain adult content
|
||||
|
||||
## How Removal Works
|
||||
|
||||
When we remove a server:
|
||||
|
||||
- It's set to "deleted" status but remains accessible via the API
|
||||
- This allows subregistries to remove it from their indexes
|
||||
- In extreme cases, we may overwrite or erase details of a server, e.g. where the metadata itself is unlawful
|
||||
|
||||
## Appeals
|
||||
|
||||
Think we made a mistake? Open an issue on our [GitHub repository](https://github.com/modelcontextprotocol/registry) with:
|
||||
- The ID and name of your server
|
||||
- Why you believe it doesn't meet the criteria for removal above
|
||||
|
||||
## Changes to this policy
|
||||
|
||||
We're still learning how to best run the MCP registry! As such, we might end up changing this policy in the future.
|
||||
77
docs/guides/consuming/use-rest-api.md
Normal file
77
docs/guides/consuming/use-rest-api.md
Normal file
|
|
@ -0,0 +1,77 @@
|
|||
# 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 pagination
|
||||
- **`GET /v0/servers/{id}`** - Get full server details including packages and configuration
|
||||
|
||||
See the [interactive API documentation](https://registry.modelcontextprotocol.io/docs) 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](https://github.com/modelcontextprotocol/registry/issues/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](../administration/moderation-guidelines.md), suggesting it is illegal, malware or spam.
|
||||
|
||||
### Filtering & Enhancement
|
||||
|
||||
The official registry has a [permissive moderation policy](../administration/moderation-guidelines.md), 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:
|
||||
|
||||
```json
|
||||
{
|
||||
"$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_detail": {
|
||||
"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](../../reference/api/) 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](../../reference/server-json/generic-server-json.md).
|
||||
56
docs/guides/contributing/add-package-registry.md
Normal file
56
docs/guides/contributing/add-package-registry.md
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
# Adding a new package registry
|
||||
|
||||
The MCP Registry project is a **metaregistry**, meaning that it hosts metadata for MCP servers but does not host the code for the servers directly.
|
||||
|
||||
For local MCP servers, the MCP Registry has pointers in the `packages` node of the [`server.json`](../../reference/server-json/generic-server-json.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_type` string enum in the [`server.json` schema](../../reference/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.
|
||||
|
||||
For the sake of illustration, this document will use npm (the Node.js package manager) as an example at each step.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
The package registry must meet the following requirements:
|
||||
|
||||
1. The package registry supports packaging and executing CLI apps. Local MCP servers use the [stdio transport](https://modelcontextprotocol.io/docs/concepts/transports#standard-input%2Foutput-stdio).
|
||||
- npm CLI tools typically express their CLI commands in the [`bin` property of the package.json](https://docs.npmjs.com/cli/v11/configuring-npm/package-json#bin)
|
||||
1. The package registry (or associated client tooling) has a widely accepted **single-shot** CLI command.
|
||||
- npm's `npx` tool executes CLI commands using a [documented execution heuristic](https://docs.npmjs.com/cli/v11/commands/npx#description)
|
||||
- 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 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](../../reference/server-json/server.schema.json)
|
||||
- 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`](../../reference/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.
|
||||
- Add a sample, minimal `server.json` to the [`server.json` examples](../../reference/server-json/generic-server-json.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`
|
||||
- Update the publishing documentation:
|
||||
- Add a new publishing guide: `docs/guides/publishing/publish-[yourregistry].md`, following the pattern of existing publishing guides (e.g., `publish-npm.md`, `publish-pypi.md`)
|
||||
- Include instructions on how to prepare packages for your registry, including any specific validation requirements
|
||||
- Update `docs/guides/publishing/README.md` to reference your new publishing guide
|
||||
331
docs/guides/publishing/github-actions.md
Normal file
331
docs/guides/publishing/github-actions.md
Normal file
|
|
@ -0,0 +1,331 @@
|
|||
# Automate Publishing with GitHub Actions
|
||||
|
||||
Set up automated MCP server publishing using GitHub Actions.
|
||||
|
||||
## What You'll Learn
|
||||
|
||||
By the end of this tutorial, you'll have:
|
||||
- A GitHub Actions workflow that automatically publishes your server
|
||||
- Understanding of GitHub OIDC authentication
|
||||
- Knowledge of best practices for automated publishing
|
||||
- Working examples for Node.js, Python, and Docker projects
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Already published your server manually (complete [Publishing Tutorial](publish-server.md) first)
|
||||
- GitHub repository with your MCP server code
|
||||
- Basic understanding of CI/CD concepts
|
||||
- 20-30 minutes
|
||||
|
||||
## GitHub Actions Setup
|
||||
|
||||
### Step 1: Create Workflow File
|
||||
|
||||
Create `.github/workflows/publish-mcp.yml` in your repository:
|
||||
|
||||
```yaml
|
||||
name: Publish to MCP Registry
|
||||
|
||||
on:
|
||||
push:
|
||||
tags: ['v*'] # Triggers on version tags like v1.0.0
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
id-token: write # Required for OIDC authentication
|
||||
contents: read
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Node.js # Adjust for your language
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: '20'
|
||||
registry-url: 'https://registry.npmjs.org'
|
||||
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
|
||||
- name: Run tests
|
||||
run: npm test
|
||||
|
||||
- name: Build package
|
||||
run: npm run build
|
||||
|
||||
- name: Publish to npm
|
||||
run: npm publish
|
||||
env:
|
||||
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||
|
||||
- name: Install MCP Publisher
|
||||
run: |
|
||||
# Build publisher from source (requires Go)
|
||||
git clone https://github.com/modelcontextprotocol/registry publisher-repo
|
||||
cd publisher-repo
|
||||
make publisher
|
||||
cp cmd/publisher/bin/mcp-publisher ../mcp-publisher
|
||||
cd ..
|
||||
chmod +x mcp-publisher
|
||||
|
||||
- name: Login to MCP Registry
|
||||
run: ./mcp-publisher login github-oidc
|
||||
|
||||
- name: Publish to MCP Registry
|
||||
run: ./mcp-publisher publish
|
||||
```
|
||||
|
||||
### Step 2: Configure Secrets
|
||||
|
||||
For npm publishing, add your NPM token to repository secrets:
|
||||
|
||||
1. Go to repository Settings → Secrets and variables → Actions
|
||||
2. Add `NPM_TOKEN` with your npm access token
|
||||
|
||||
**Note:** GitHub OIDC authentication requires no additional secrets for MCP Registry publishing.
|
||||
|
||||
### Step 3: Tag and Release
|
||||
|
||||
Create a version tag to trigger the workflow:
|
||||
|
||||
```bash
|
||||
git tag v1.0.0
|
||||
git push origin v1.0.0
|
||||
```
|
||||
|
||||
The workflow will:
|
||||
1. Run tests
|
||||
2. Build your package
|
||||
3. Publish to npm
|
||||
4. Automatically authenticate with the MCP Registry
|
||||
5. Publish updated server.json
|
||||
|
||||
## Authentication Methods by CI Platform
|
||||
|
||||
### GitHub Actions - OIDC (Recommended)
|
||||
|
||||
```yaml
|
||||
- name: Login to MCP Registry
|
||||
run: mcp-publisher login github-oidc
|
||||
```
|
||||
|
||||
**Advantages:**
|
||||
- No secrets to manage
|
||||
- Automatically scoped to your repository
|
||||
- Most secure option
|
||||
|
||||
### GitHub Actions - Personal Access Token
|
||||
|
||||
```yaml
|
||||
- name: Login to MCP Registry
|
||||
run: mcp-publisher login github --token ${{ secrets.GITHUB_TOKEN }}
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.MCP_GITHUB_TOKEN }}
|
||||
```
|
||||
|
||||
Add `MCP_GITHUB_TOKEN` secret with a GitHub PAT that has repo access.
|
||||
|
||||
### DNS Authentication (Any CI)
|
||||
|
||||
For custom domain namespaces (`com.yourcompany/*`):
|
||||
|
||||
```yaml
|
||||
- name: Login to MCP Registry
|
||||
run: |
|
||||
echo "${{ secrets.MCP_PRIVATE_KEY }}" > key.pem
|
||||
mcp-publisher login dns --domain yourcompany.com --private-key-file key.pem
|
||||
```
|
||||
|
||||
Add your Ed25519 private key as `MCP_PRIVATE_KEY` secret.
|
||||
|
||||
## Language-Specific Examples
|
||||
|
||||
### Python Project
|
||||
|
||||
```yaml
|
||||
name: Publish Python MCP Server
|
||||
|
||||
on:
|
||||
push:
|
||||
tags: ['v*']
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
id-token: write
|
||||
contents: read
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.11'
|
||||
|
||||
- name: Install Poetry
|
||||
run: pipx install poetry
|
||||
|
||||
- name: Build package
|
||||
run: poetry build
|
||||
|
||||
- name: Publish to PyPI
|
||||
run: poetry publish
|
||||
env:
|
||||
POETRY_PYPI_TOKEN_PYPI: ${{ secrets.PYPI_TOKEN }}
|
||||
|
||||
- name: Install MCP Publisher
|
||||
run: |
|
||||
git clone https://github.com/modelcontextprotocol/registry publisher-repo
|
||||
cd publisher-repo && make publisher && cd ..
|
||||
cp publisher-repo/cmd/publisher/bin/mcp-publisher mcp-publisher
|
||||
|
||||
- name: Publish to MCP Registry
|
||||
run: |
|
||||
./mcp-publisher login github-oidc
|
||||
./mcp-publisher publish
|
||||
```
|
||||
|
||||
### Docker Project
|
||||
|
||||
```yaml
|
||||
name: Publish Docker MCP Server
|
||||
|
||||
on:
|
||||
push:
|
||||
tags: ['v*']
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
id-token: write
|
||||
contents: read
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Setup Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Login to Docker Hub
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
username: ${{ secrets.DOCKER_USERNAME }}
|
||||
password: ${{ secrets.DOCKER_PASSWORD }}
|
||||
|
||||
- name: Extract version
|
||||
id: version
|
||||
run: echo "version=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Build and push
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
context: .
|
||||
push: true
|
||||
tags: yourname/your-server:${{ steps.version.outputs.version }}
|
||||
labels: |
|
||||
io.modelcontextprotocol.server.name=io.github.yourname/your-server
|
||||
|
||||
- name: Install MCP Publisher
|
||||
run: |
|
||||
git clone https://github.com/modelcontextprotocol/registry publisher-repo
|
||||
cd publisher-repo && make publisher && cd ..
|
||||
cp publisher-repo/cmd/publisher/bin/mcp-publisher mcp-publisher
|
||||
|
||||
- name: Publish to MCP Registry
|
||||
run: |
|
||||
./mcp-publisher login github-oidc
|
||||
./mcp-publisher publish
|
||||
```
|
||||
|
||||
|
||||
## Best Practices
|
||||
|
||||
### 1. Version Alignment
|
||||
|
||||
Keep your package version and server.json version in sync:
|
||||
|
||||
```yaml
|
||||
- name: Update server.json version
|
||||
run: |
|
||||
VERSION=${GITHUB_REF#refs/tags/v}
|
||||
jq --arg version "$VERSION" '.version_detail.version = $version' server.json > tmp.json
|
||||
mv tmp.json server.json
|
||||
```
|
||||
|
||||
### 2. Conditional Publishing
|
||||
|
||||
Only publish to registry after package publishing succeeds:
|
||||
|
||||
```yaml
|
||||
- name: Publish to npm
|
||||
run: npm publish
|
||||
id: npm-publish
|
||||
|
||||
- name: Publish to MCP Registry
|
||||
if: steps.npm-publish.outcome == 'success'
|
||||
run: ./mcp-publisher publish
|
||||
```
|
||||
|
||||
### 3. Test Before Publishing
|
||||
|
||||
Include validation in your workflow:
|
||||
|
||||
```yaml
|
||||
- name: Validate server.json
|
||||
run: |
|
||||
# Validate against schema
|
||||
curl -s https://static.modelcontextprotocol.io/schemas/2025-07-09/server.schema.json | \
|
||||
jq . > schema.json
|
||||
npx ajv-cli validate -s schema.json -d server.json
|
||||
|
||||
# Test with publisher
|
||||
./mcp-publisher init --validate-only
|
||||
```
|
||||
|
||||
### 4. Notification Setup
|
||||
|
||||
Get notified of publishing status:
|
||||
|
||||
```yaml
|
||||
- name: Notify on success
|
||||
if: success()
|
||||
run: |
|
||||
curl -X POST "${{ secrets.WEBHOOK_URL }}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"text": "✅ MCP server ${{ github.repository }} published successfully"}'
|
||||
|
||||
- name: Notify on failure
|
||||
if: failure()
|
||||
run: |
|
||||
curl -X POST "${{ secrets.WEBHOOK_URL }}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"text": "❌ MCP server ${{ github.repository }} publishing failed"}'
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**"Publisher binary not found"** - Ensure you download the correct binary for your CI platform (linux/mac/windows).
|
||||
|
||||
**"Authentication failed"** - For GitHub OIDC, verify `id-token: write` permission is set. For other methods, check secret configuration.
|
||||
|
||||
**"Package validation failed"** - Ensure your package was published successfully before MCP Registry publishing runs.
|
||||
|
||||
**"Version already exists"** - Each server.json version must be unique. Consider using build numbers: `1.0.0-build.123`.
|
||||
|
||||
## What You've Accomplished
|
||||
|
||||
You now have automated MCP server publishing that:
|
||||
- Triggers on version tags
|
||||
- Runs tests before publishing
|
||||
- Publishes to package registry first
|
||||
- Automatically publishes to MCP Registry
|
||||
- Handles authentication securely
|
||||
- Provides failure notifications
|
||||
|
||||
Your MCP server publishing is now fully automated - just tag a release and everything happens automatically!
|
||||
309
docs/guides/publishing/publish-server.md
Normal file
309
docs/guides/publishing/publish-server.md
Normal file
|
|
@ -0,0 +1,309 @@
|
|||
# Publish Your MCP Server
|
||||
|
||||
Complete guide to publishing an MCP server to the registry.
|
||||
|
||||
## What You'll Learn
|
||||
|
||||
By the end of this tutorial, you'll have:
|
||||
- Created a server.json file for your MCP server
|
||||
- Authenticated with the registry
|
||||
- Successfully published your server
|
||||
- Verified your server appears in the registry
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- An MCP server you've already built ([follow this guide if you don't have one already](https://modelcontextprotocol.io/quickstart/server))
|
||||
- Your server published to a package registry (npm, PyPI, Docker Hub, etc.)
|
||||
|
||||
## Step 1: Install the Publisher CLI
|
||||
|
||||
<!-- TODO: update once #358 solved -->
|
||||
|
||||
Download and build the MCP publisher tool:
|
||||
|
||||
```bash
|
||||
# Clone the registry repository (requires Go 1.24+)
|
||||
git clone https://github.com/modelcontextprotocol/registry
|
||||
cd registry
|
||||
make publisher
|
||||
|
||||
# The binary will be at cmd/publisher/bin/mcp-publisher
|
||||
export PATH=$PATH:$(pwd)/cmd/publisher/bin
|
||||
```
|
||||
|
||||
## Step 2: Initialize Your server.json
|
||||
|
||||
Navigate to your server's directory and create a template:
|
||||
|
||||
```bash
|
||||
cd /path/to/your/mcp-server
|
||||
mcp-publisher init
|
||||
```
|
||||
|
||||
This creates a `server.json` with auto-detected values. You'll see something like:
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "https://static.modelcontextprotocol.io/schemas/2025-07-09/server.schema.json",
|
||||
"name": "io.github.yourname/your-server",
|
||||
"description": "A description of your MCP server",
|
||||
"version_detail": {
|
||||
"version": "1.0.0"
|
||||
},
|
||||
"packages": [
|
||||
{
|
||||
"registry_type": "npm",
|
||||
"identifier": "your-package-name",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Step 3: Configure Your Server Details
|
||||
|
||||
Edit the generated `server.json`:
|
||||
|
||||
### Choose Your Namespace
|
||||
|
||||
The `name` field determines authentication requirements:
|
||||
|
||||
- **`io.github.yourname/*`** - Requires GitHub authentication
|
||||
- **`com.yourcompany/*`** - Requires DNS or HTTP domain verification
|
||||
|
||||
### Add Package Validation
|
||||
|
||||
Your package must include validation metadata to prove ownership.
|
||||
|
||||
|
||||
<details>
|
||||
<summary><strong>📦 NPM Packages</strong></summary>
|
||||
|
||||
### Requirements
|
||||
Add an `mcpName` field to your `package.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "your-npm-package",
|
||||
"version": "1.0.0",
|
||||
"mcpName": "io.github.username/server-name"
|
||||
}
|
||||
```
|
||||
|
||||
### How It Works
|
||||
- Registry fetches `https://registry.npmjs.org/your-npm-package`
|
||||
- Checks that `mcpName` field matches your server name
|
||||
- Fails if field is missing or doesn't match
|
||||
|
||||
### Example server.json
|
||||
```json
|
||||
{
|
||||
"name": "io.github.username/server-name",
|
||||
"packages": [
|
||||
{
|
||||
"registry_type": "npm",
|
||||
"identifier": "your-npm-package",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
The official MCP registry currently only supports the NPM public registry (`https://registry.npmjs.org`).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>🐍 PyPI Packages</strong></summary>
|
||||
|
||||
### Requirements
|
||||
Include your server name in your package README file using this format:
|
||||
|
||||
**MCP name format**: `mcp-name: io.github.username/server-name`
|
||||
|
||||
Add it to your README.md file (which becomes the package description on PyPI).
|
||||
|
||||
### How It Works
|
||||
- Registry fetches `https://pypi.org/pypi/your-package/json`
|
||||
- Passes if `mcp-name: server-name` is in the README content
|
||||
|
||||
### Example server.json
|
||||
```json
|
||||
{
|
||||
"name": "io.github.username/server-name",
|
||||
"packages": [
|
||||
{
|
||||
"registry_type": "pypi",
|
||||
"identifier": "your-pypi-package",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
The official MCP registry currently only supports the official PyPI registry (`https://pypi.org`).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>📋 NuGet Packages</strong></summary>
|
||||
|
||||
### Requirements
|
||||
Include your server name in your package's README using this format:
|
||||
|
||||
**MCP name format**: `mcp-name: io.github.username/server-name`
|
||||
|
||||
Add a README file to your NuGet package that includes the server name.
|
||||
|
||||
### How It Works
|
||||
- Registry fetches README from `https://api.nuget.org/v3-flatcontainer/{id}/{version}/readme`
|
||||
- Passes if `mcp-name: server-name` is found in the README content
|
||||
|
||||
### Example server.json
|
||||
```json
|
||||
{
|
||||
"name": "io.github.username/server-name",
|
||||
"packages": [
|
||||
{
|
||||
"registry_type": "nuget",
|
||||
"identifier": "Your.NuGet.Package",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
The official MCP registry currently only supports the official NuGet registry (`https://api.nuget.org`).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>🐳 Docker/OCI Images</strong></summary>
|
||||
|
||||
### Requirements
|
||||
Add an annotation to your Docker image:
|
||||
|
||||
```dockerfile
|
||||
LABEL io.modelcontextprotocol.server.name="io.github.username/server-name"
|
||||
```
|
||||
|
||||
### How It Works
|
||||
- Registry authenticates with Docker Hub using public token
|
||||
- Fetches image manifest using Docker Registry v2 API
|
||||
- Checks that `io.modelcontextprotocol.server.name` annotation matches your server name
|
||||
- Fails if annotation is missing or doesn't match
|
||||
|
||||
### Example server.json
|
||||
```json
|
||||
{
|
||||
"name": "io.github.username/server-name",
|
||||
"packages": [
|
||||
{
|
||||
"registry_type": "oci",
|
||||
"identifier": "yourusername/your-mcp-server",
|
||||
"version": "1.0.0"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
The identifier is `namespace/repository`, and version is the tag and optionally digest.
|
||||
|
||||
The official MCP registry currently only supports the official Docker registry (`https://docker.io`).
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>📁 MCPB Packages</strong></summary>
|
||||
|
||||
### Requirements
|
||||
**MCP reference** - MCPB package URLs must contain "mcp" somewhere within them, to ensure the correct artifact has been uploaded. This may be with the `.mcpb` extension or in the name of your repository.
|
||||
|
||||
### Example server.json
|
||||
```json
|
||||
{
|
||||
"name": "io.github.username/server-name",
|
||||
"packages": [
|
||||
{
|
||||
"registry_type": "mcpb",
|
||||
"identifier": "https://github.com/you/your-repo/releases/download/v1.0.0/server.mcpb"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
The official MCP registry currently only supports artifacts hosted on GitHub or GitLab releases.
|
||||
|
||||
</details>
|
||||
|
||||
## Step 4: Authenticate
|
||||
|
||||
Choose your authentication method based on your namespace:
|
||||
|
||||
### GitHub Authentication (for io.github.* namespaces)
|
||||
|
||||
```bash
|
||||
mcp-publisher login github
|
||||
```
|
||||
|
||||
This opens your browser for OAuth authentication.
|
||||
|
||||
### DNS Authentication (for custom domains)
|
||||
|
||||
```bash
|
||||
# Generate keypair
|
||||
openssl genpkey -algorithm Ed25519 -out key.pem
|
||||
|
||||
# Get public key for DNS record
|
||||
echo "_mcp-registry.yourcompany.com. IN TXT \"v=MCPv1; k=ed25519; p=$(openssl pkey -in key.pem -pubout -outform DER | tail -c 32 | base64)\""
|
||||
|
||||
# Add the TXT record to your DNS, then login
|
||||
mcp-publisher login dns --domain yourcompany.com --private-key $(openssl pkey -in key.pem -noout -text | grep -A3 "priv:" | tail -n +2 | tr -d ' :\n')
|
||||
```
|
||||
|
||||
## Step 5: Publish Your Server
|
||||
|
||||
With authentication complete, publish your server:
|
||||
|
||||
```bash
|
||||
mcp-publisher publish
|
||||
```
|
||||
|
||||
You'll see output like:
|
||||
```
|
||||
✓ Validating server.json
|
||||
✓ Checking package ownership
|
||||
✓ Publishing to registry
|
||||
✓ Server published successfully!
|
||||
|
||||
Your server is now available at:
|
||||
https://registry.modelcontextprotocol.io/servers/io.github.yourname/weather-server
|
||||
```
|
||||
|
||||
## Step 6: Verify Publication
|
||||
|
||||
Check that your server appears in the registry:
|
||||
|
||||
```bash
|
||||
curl https://registry.modelcontextprotocol.io/servers/io.github.yourname/weather-server
|
||||
```
|
||||
|
||||
You should see your server metadata returned as JSON.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
**"Package validation failed"** - Ensure your package includes the required validation metadata (mcpName field, README mention, or Docker label).
|
||||
|
||||
**"Authentication failed"** - Verify you've correctly set up DNS records or are logged into the right GitHub account.
|
||||
|
||||
**"Namespace not authorized"** - Your authentication method doesn't match your chosen namespace format.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- **Update your server**: Publish new versions with updated server.json files
|
||||
- **Set up CI/CD**: Automate publishing with [GitHub Actions](github-actions.md)
|
||||
- **Learn more**: Understand [server.json format](../../reference/server-json/generic-server-json.md) in depth
|
||||
|
||||
## What You've Accomplished
|
||||
|
||||
You've successfully published your first MCP server to the registry! Your server is now discoverable by MCP clients and can be installed by users worldwide.
|
||||
Loading…
Reference in a new issue