base on A community driven registry service for Model Context Protocol (MCP) servers. # MCP Registry A community driven registry service for Model Context Protocol (MCP) servers. ## Development Status This project is being built in the open and is currently in the early stages of development. Please see the [overview discussion](https://github.com/modelcontextprotocol/registry/discussions/11) for the project scope and goals. If you would like to contribute, please check out the [contributing guidelines](CONTRIBUTING.md). ## Overview The MCP Registry service provides a centralized repository for MCP server entries. It allows discovery and management of various MCP implementations with their associated metadata, configurations, and capabilities. ## Features - RESTful API for managing MCP registry entries (list, get, create, update, delete) - Health check endpoint for service monitoring - Support for various environment configurations - Graceful shutdown handling - MongoDB and in-memory database support - Comprehensive API documentation - Pagination support for listing registry entries ## Getting Started ### Prerequisites - Go 1.18 or later - MongoDB - Docker (optional, but recommended for development) ## Running The easiest way to get the registry running is to use `docker compose`. This will setup the MCP Registry service, import the seed data and run MongoDB in a local Docker environment. ```bash # Build the Docker image docker build -t registry . # Run the registry and MongoDB with docker compose docker compose up ``` This will start the MCP Registry service and MongoDB with Docker, exposing it on port 8080. ## Building If you prefer to run the service locally without Docker, you can build and run it directly using Go. ```bash # Build a registry executable go build ./cmd/registry ``` This will create the `registry` binary in the current directory. You'll need to have MongoDB running locally or with Docker. By default, the service will run on `http://localhost:8080`. ## Project Structure ``` ├── api/ # OpenApi specification ├── cmd/ # Application entry points ├── config/ # Configuration files ├── internal/ # Private application code │ ├── api/ # HTTP server and request handlers │ ├── config/ # Configuration management │ ├── model/ # Data models │ └── service/ # Business logic ├── pkg/ # Public libraries ├── scripts/ # Utility scripts └── tools/ # Command line tools └── publisher/ # Tool to publish MCP servers to the registry ``` ## API Documentation The API is documented using Swagger/OpenAPI. You can access the interactive Swagger UI at: ``` /v0/swagger/index.html ``` This provides a complete reference of all endpoints with request/response schemas and allows you to test the API directly from your browser. ## API Endpoints ### Health Check ``` GET /v0/health ``` Returns the health status of the service: ```json { "status": "ok" } ``` ### Registry Endpoints #### List Registry Server Entries ``` GET /v0/servers ``` Lists MCP registry server entries with pagination support. Query parameters: - `limit`: Maximum number of entries to return (default: 30, max: 100) - `cursor`: Pagination cursor for retrieving next set of results Response example: ```json { "servers": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "name": "Example MCP Server", "url": "https://example.com/mcp", "description": "An example MCP server", "created_at": "2025-05-17T17:34:22.912Z", "updated_at": "2025-05-17T17:34:22.912Z" } ], "metadata": { "next_cursor": "123e4567-e89b-12d3-a456-426614174000", "count": 30 } } ``` #### Get Server Details ``` GET /v0/servers/{id} ``` Retrieves detailed information about a specific MCP server entry. Path parameters: - `id`: Unique identifier of the server entry Response example: ```json { "id": "01129bff-3d65-4e3d-8e82-6f2f269f818c", "name": "io.github.gongrzhe/redis-mcp-server", "description": "A Redis MCP server (pushed to https://github.com/modelcontextprotocol/servers/tree/main/src/redis) implementation for interacting with Redis databases. This server enables LLMs to interact with Redis key-value stores through a set of standardized tools.", "repository": { "url": "https://github.com/GongRzhe/REDIS-MCP-Server", "source": "github", "id": "907849235" }, "version_detail": { "version": "0.0.1-seed", "release_date": "2025-05-16T19:13:21Z", "is_latest": true }, "packages": [ { "registry_name": "docker", "name": "@gongrzhe/server-redis-mcp", "version": "1.0.0", "package_arguments": [ { "description": "Docker image to run", "is_required": true, "format": "string", "value": "mcp/redis", "default": "mcp/redis", "type": "positional", "value_hint": "mcp/redis" }, { "description": "Redis server connection string", "is_required": true, "format": "string", "value": "redis://host.docker.internal:6379", "default": "redis://host.docker.internal:6379", "type": "positional", "value_hint": "host.docker.internal:6379" } ] } ] } ``` #### Publish a Server Entry ``` POST /v0/publish ``` Publishes a new MCP server entry to the registry. Authentication is required via Bearer token in the Authorization header. Headers: - `Authorization`: Bearer token for authentication (e.g., `Bearer your_token_here`) - `Content-Type`: application/json Request body example: ```json { "description": "<your description here>", "name": "io.github.<owner>/<server-name>", "packages": [ { "registry_name": "npm", "name": "@<owner>/<server-name>", "version": "0.2.23", "package_arguments": [ { "description": "Specify services and permissions.", "is_required": true, "format": "string", "value": "-s", "default": "-s", "type": "positional", "value_hint": "-s" } ], "environment_variables": [ { "description": "API Key to access the server", "name": "API_KEY" } ] },{ "registry_name": "docker", "name": "@<owner>/<server-name>-cli", "version": "0.123.223", "runtime_hint": "docker", "runtime_arguments": [ { "description": "Specify services and permissions.", "is_required": true, "format": "string", "value": "--mount", "default": "--mount", "type": "positional", "value_hint": "--mount" } ], "environment_variables": [ { "description": "API Key to access the server", "name": "API_KEY" } ] } ], "repository": { "url": "https://github.com/<owner>/<server-name>", "source": "github" }, "version_detail": { "version": "0.0.1-<publisher_version>" } } ``` Response example: ```json { "message": "Server publication successful", "id": "1234567890abcdef12345678" } ``` ### Ping Endpoint ``` GET /v0/ping ``` Simple ping endpoint that returns environment configuration information: ```json { "environment": "dev", "version": "registry-<sha>" } ``` ## Configuration The service can be configured using environment variables: | Variable | Description | Default | |----------|-------------|---------| | `MCP_REGISTRY_APP_VERSION` | Application version | `dev` | | `MCP_REGISTRY_DATABASE_TYPE` | Database type | `mongodb` | | `MCP_REGISTRY_COLLECTION_NAME` | MongoDB collection name | `servers_v2` | | `MCP_REGISTRY_DATABASE_NAME` | MongoDB database name | `mcp-registry` | | `MCP_REGISTRY_DATABASE_URL` | MongoDB connection string | `mongodb://localhost:27017` | | `MCP_REGISTRY_GITHUB_CLIENT_ID` | GitHub App Client ID | | | `MCP_REGISTRY_GITHUB_CLIENT_SECRET` | GitHub App Client Secret | | | `MCP_REGISTRY_LOG_LEVEL` | Log level | `info` | | `MCP_REGISTRY_SEED_FILE_PATH` | Path to import seed file | `data/seed.json` | | `MCP_REGISTRY_SEED_IMPORT` | Import `seed.json` on first run | `true` | | `MCP_REGISTRY_SERVER_ADDRESS` | Listen address for the server | `:8080` | ## Testing Run the test script to validate API endpoints: ```bash ./scripts/test_endpoints.sh ``` You can specify specific endpoints to test: ```bash ./scripts/test_endpoints.sh --endpoint health ./scripts/test_endpoints.sh --endpoint servers ``` ## License See the [LICENSE](LICENSE) file for details. ## Contributing See the [CONTRIBUTING](CONTRIBUTING.md) file for details. ", Assign "at most 3 tags" to the expected json: {"id":"13826","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"