MCP Registry Publisher Tool

The MCP Registry Publisher Tool is designed to publish Model Context Protocol (MCP) server details to an MCP registry. This tool currently only handles GitHub authentication via device flow and manages the publishing process.

Building the Tool

You can build the publisher tool using the provided build script:

# Make the build script executable
chmod +x build.sh

# Build for current platform
./build.sh

# Build for all supported platforms (optional)
./build.sh --all

The compiled binary will be placed in the bin directory.

Usage

# Basic usage
./bin/mcp-publisher --registry-url <REGISTRY_URL> --mcp-file <PATH_TO_MCP_FILE>

# Force a new login even if a token exists
./bin/mcp-publisher --registry-url <REGISTRY_URL> --mcp-file <PATH_TO_MCP_FILE> --login

Command-line Arguments

--registry-url: URL of the MCP registry (required)
--mcp-file: Path to the MCP configuration file (required)
--login: Force a new GitHub authentication even if a token already exists

Authentication

The tool uses GitHub device flow authentication:

When first run (or with --login flag), the tool will initiate the GitHub device flow
You'll be provided with a URL and a code to enter
After successful authentication, the tool saves the token locally for future use

NOTE : Authentication is made on behalf of a GitHubApp which you must install on the repository you're publishing.

Example

Prepare your mcp.json file with your server details:

{
  "name": "io.github.yourusername/your-repository",
  "description": "Your MCP server description",
  "version_detail": {
    "version": "1.0.0"
  },
  "registries": [
    {
      "name": "npm",
      "package_name": "your-npm-package",
      "license": "MIT",
      "command_arguments": {
        "sub_commands": [
          {
            "name": "start",
            "description": "Start the server",
            "named_arguments": null
          }
        ],
        "positional_arguments": null,
        "environment_variables": [
          {
            "name": "PORT",
            "description": "Port to run the server on",
            "required": false
          }
        ],
        "named_arguments": null
      }
    }
  ],
  "remotes": [
    {
      "transporttype": "http",
      "url": "http://yourdomain.com/api"
    }
  ]
}

Run the publisher tool:

./bin/mcp-publisher --registry-url "https://mcp-registry.example.com" --mcp-file "./mcp.json"

Follow the authentication instructions in the terminal if prompted.
Upon successful publication, you'll see a confirmation message.

Important Notes

The authentication token is saved in a file named .mcpregistry_token in the current directory
The tool requires an active internet connection to authenticate with GitHub and communicate with the registry
Make sure the repository and package mentioned in your mcp.json file exist and are accessible

2.9 KiB Raw Blame History