MCP Runtime Platform documentation

Learn how to deploy, operate, and extend MCP Runtime Platform. The docs cover setup, registry workflows, TLS, CLI commands, and operational guidance.

Start quickstart CLI reference

Docs overview

Prerequisites and local setup requirements.
Platform setup and server deployment workflow.
Registry, ingress, and TLS configuration.
Operational commands and troubleshooting.

Active development

MCP Runtime Platform is under active development. APIs, commands, and behavior may change, and production usage is not recommended yet.

Prerequisites

Install the required tools before setup:

Go 1.24+
Make
kubectl (v1.34.x tested)
Docker

Quickstart

Clone the repo, build the CLI, and run setup:

              $ git clone https://mcp-runtime.git
              
              $ cd mcp-runtime
              
              $ make deps && make build
              
              $ ./bin/mcp-runtime setup

Check platform status and deploy your first server:

              $ ./bin/mcp-runtime status
              
              $ cat > .mcp/metadata.yaml << 'EOF'
              
              version: v1
              
              servers:
              
                - name: my-server
              
                  route: /my-server/mcp
              
                  port: 8088
              
              EOF
              
              $ docker build -t my-server:latest .
              
              $ ./bin/mcp-runtime registry push --image my-server:latest
              
              $ ./bin/mcp-runtime pipeline generate --dir .mcp --output manifests/
              
              $ ./bin/mcp-runtime pipeline deploy --dir manifests/

Your server will be available at http://<ingress-host>/my-server/mcp.

Registry

The platform deploys an internal registry by default. To use an external registry, provision it before setup.

$ ./bin/mcp-runtime registry provision --url registry.example.com

Ingress + TLS

Traefik is installed automatically (HTTP). For HTTPS, install cert-manager, create a CA secret, and run setup with TLS.

              $ helm install cert-manager jetstack/cert-manager \
              
                --namespace cert-manager --create-namespace \
              
                --set crds.enabled=true
              
              $ kubectl create secret tls mcp-runtime-ca \
              
                --cert=ca.crt --key=ca.key -n cert-manager
              
              $ ./bin/mcp-runtime setup --with-tls

CLI reference

Common commands:

              $ ./bin/mcp-runtime setup
              
              $ ./bin/mcp-runtime status
              
              $ ./bin/mcp-runtime registry
              
              $ ./bin/mcp-runtime server
              
              $ ./bin/mcp-runtime pipeline
              
              $ ./bin/mcp-runtime cluster

Examples

Explore the examples/ directory for working metadata and server layouts, including:

example-app/ - Simple HTTP server with env vars.
metadata.yaml - Multi-server configuration.
mcpserver-example.yaml - Direct CRD definition.

Troubleshooting

Check status and logs when the platform is unhealthy:

              $ ./bin/mcp-runtime status
              
              $ kubectl logs -n mcp-runtime deployment/mcp-runtime-operator-controller-manager
              
              $ kubectl logs -n registry deployment/registry