Watch

adam jones 91b3e414ec

docs: fix server lookup instructions in publishing guide (#411 )

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

2025-09-10 09:32:18 -07:00

1.7 KiB

Raw Blame History

Generic Registry API Specification

A standardized RESTful HTTP API for MCP registries to provide consistent endpoints for discovering and retrieving MCP servers.

Also see:

For guidance consuming the API, see the consuming guide.

Browse the Complete API Specification

📋 View the full API specification interactively: Open openapi.yaml in an OpenAPI viewer like Stoplight Elements.

The official registry has some more endpoints and restrictions on top of this. See the official registry API spec for details.

Quick Reference

Core Endpoints

GET /v0/servers - List all servers with pagination
GET /v0/servers/{id} - Get server details by UUID
POST /v0/publish - Publish new server (optional, registry-specific authentication)

Authentication

Read operations: No authentication required
Write operations: Registry-specific authentication (if supported)

Content Type

All requests and responses use application/json

Basic Example: List Servers

curl https://registry.example.com/v0/servers?limit=10

{
  "servers": [
    {
      "name": "io.modelcontextprotocol/filesystem",
      "description": "Filesystem operations server", 
      "status": "active",
      "version": "1.0.2"
    }
  ],
  "metadata": {
    "count": 10,
    "next_cursor": "eyJ..."
  }
}

For complete endpoint documentation, view the OpenAPI specification in a schema viewer.

1.7 KiB Raw Blame History