docs: Add preview disclaimer note to public documentation
Add a `<Note>` component to all MDX files in `docs/modelcontextprotocol-io/` informing readers that the MCP Registry is currently in preview and that breaking changes or data resets may occur before general availability. The note also directs users to report issues on GitHub at https://github.com/modelcontextprotocol/registry/issues Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
Jonathan Hefner
parent
4fb32e5e2e
commit
817e12161d
11 changed files with 44 additions and 0 deletions
|
|
@ -3,6 +3,10 @@ title: The MCP Registry
|
|||
sidebarTitle: About
|
||||
---
|
||||
|
||||
<Note>
|
||||
The MCP Registry is currently in preview. Breaking changes or data resets may occur before general availability. If you encounter any issues, please report them on [GitHub](https://github.com/modelcontextprotocol/registry/issues).
|
||||
</Note>
|
||||
|
||||
The MCP Registry is the official centralized metadata repository for publicly accessible MCP servers, backed by major trusted contributors to the MCP ecosystem such as Anthropic, GitHub, PulseMCP, and Microsoft.
|
||||
|
||||
The MCP Registry provides:
|
||||
|
|
|
|||
|
|
@ -3,6 +3,10 @@ title: How to Authenticate When Publishing to the Official MCP Registry
|
|||
sidebarTitle: Authentication
|
||||
---
|
||||
|
||||
<Note>
|
||||
The MCP Registry is currently in preview. Breaking changes or data resets may occur before general availability. If you encounter any issues, please report them on [GitHub](https://github.com/modelcontextprotocol/registry/issues).
|
||||
</Note>
|
||||
|
||||
You must authenticate before publishing to the official MCP Registry. The MCP Registry supports different authentication methods. Which authentication method you choose determines the namespace of your server's name.
|
||||
|
||||
If you choose GitHub-based authentication, your server's name in `server.json` **MUST** be of the form `io.github.username/*` (or `io.github.orgname/*`). For example, `io.github.alice/weather-server`.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,10 @@ title: Frequently Asked Questions
|
|||
sidebarTitle: FAQ
|
||||
---
|
||||
|
||||
<Note>
|
||||
The MCP Registry is currently in preview. Breaking changes or data resets may occur before general availability. If you encounter any issues, please report them on [GitHub](https://github.com/modelcontextprotocol/registry/issues).
|
||||
</Note>
|
||||
|
||||
## General
|
||||
|
||||
### What is the difference between "Official MCP Registry", "MCP Registry", "MCP registry", "MCP Registry API", etc?
|
||||
|
|
|
|||
|
|
@ -3,6 +3,10 @@ title: How to Automate Publishing with GitHub Actions
|
|||
sidebarTitle: GitHub Actions
|
||||
---
|
||||
|
||||
<Note>
|
||||
The MCP Registry is currently in preview. Breaking changes or data resets may occur before general availability. If you encounter any issues, please report them on [GitHub](https://github.com/modelcontextprotocol/registry/issues).
|
||||
</Note>
|
||||
|
||||
## Step 1: Create a Workflow File
|
||||
|
||||
In your server project directory, create a `.github/workflows/publish-mcp.yml` file. Here is an example for npm-based local server, but the MCP Registry publishing steps are the same for all package types:
|
||||
|
|
|
|||
|
|
@ -3,6 +3,10 @@ title: The MCP Registry Moderation Policy
|
|||
sidebarTitle: Moderation Policy
|
||||
---
|
||||
|
||||
<Note>
|
||||
The MCP Registry is currently in preview. Breaking changes or data resets may occur before general availability. If you encounter any issues, please report them on [GitHub](https://github.com/modelcontextprotocol/registry/issues).
|
||||
</Note>
|
||||
|
||||
**TL;DR**: The MCP Registry is quite permissive! We only remove illegal content, malware, spam, and completely broken servers.
|
||||
|
||||
## Scope
|
||||
|
|
|
|||
|
|
@ -3,6 +3,10 @@ title: MCP Registry Supported Package Types
|
|||
sidebarTitle: Package Types
|
||||
---
|
||||
|
||||
<Note>
|
||||
The MCP Registry is currently in preview. Breaking changes or data resets may occur before general availability. If you encounter any issues, please report them on [GitHub](https://github.com/modelcontextprotocol/registry/issues).
|
||||
</Note>
|
||||
|
||||
# Package Types
|
||||
|
||||
The MCP Registry supports several different package types, and each package type has its own verification method.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,10 @@ title: "Quickstart: Publish an MCP Server to the MCP Registry"
|
|||
sidebarTitle: "Quickstart: Publish a Server"
|
||||
---
|
||||
|
||||
<Note>
|
||||
The MCP Registry is currently in preview. Breaking changes or data resets may occur before general availability. If you encounter any issues, please report them on [GitHub](https://github.com/modelcontextprotocol/registry/issues).
|
||||
</Note>
|
||||
|
||||
This tutorial will show you how to publish an MCP server written in TypeScript to the MCP Registry using the official `mcp-publisher` CLI tool.
|
||||
|
||||
## Prerequisites
|
||||
|
|
|
|||
|
|
@ -3,6 +3,10 @@ title: MCP Registry Aggregators
|
|||
sidebarTitle: Registry Aggregators
|
||||
---
|
||||
|
||||
<Note>
|
||||
The MCP Registry is currently in preview. Breaking changes or data resets may occur before general availability. If you encounter any issues, please report them on [GitHub](https://github.com/modelcontextprotocol/registry/issues).
|
||||
</Note>
|
||||
|
||||
Aggregators are downstream consumers of the MCP Registry that provide additional value. For example, a server marketplace that provides user ratings and security scanning.
|
||||
|
||||
The MCP Registry provides an unauthenticated read-only REST API that aggregators can use to populate their data stores. Aggregators are expected to scrape data on a regular but infrequent basis (e.g., once per hour), and persist the data in their own data store. The MCP Registry **does not provide uptime or data durability guarantees**.
|
||||
|
|
|
|||
|
|
@ -3,6 +3,10 @@ title: Publishing Remote Servers
|
|||
sidebarTitle: Remote Servers
|
||||
---
|
||||
|
||||
<Note>
|
||||
The MCP Registry is currently in preview. Breaking changes or data resets may occur before general availability. If you encounter any issues, please report them on [GitHub](https://github.com/modelcontextprotocol/registry/issues).
|
||||
</Note>
|
||||
|
||||
The MCP Registry supports remote MCP servers via the `remotes` property in `server.json`:
|
||||
|
||||
```json server.json highlight={7-12}
|
||||
|
|
|
|||
|
|
@ -3,6 +3,10 @@ title: Official MCP Registry Terms of Service
|
|||
sidebarTitle: Terms of Service
|
||||
---
|
||||
|
||||
<Note>
|
||||
The MCP Registry is currently in preview. Breaking changes or data resets may occur before general availability. If you encounter any issues, please report them on [GitHub](https://github.com/modelcontextprotocol/registry/issues).
|
||||
</Note>
|
||||
|
||||
**Effective date: 2025-09-02**
|
||||
|
||||
## Overview
|
||||
|
|
|
|||
|
|
@ -3,6 +3,10 @@ title: Versioning Published MCP Servers
|
|||
sidebarTitle: Versioning
|
||||
---
|
||||
|
||||
<Note>
|
||||
The MCP Registry is currently in preview. Breaking changes or data resets may occur before general availability. If you encounter any issues, please report them on [GitHub](https://github.com/modelcontextprotocol/registry/issues).
|
||||
</Note>
|
||||
|
||||
MCP servers **MUST** define a version string in `server.json`. For example:
|
||||
|
||||
```json server.json highlight={6}
|
||||
|
|
|
|||
Loading…
Reference in a new issue