Skip to content

MCP Runtime Documentation

Documentation for using and operating the MCP Runtime platform — a Kubernetes-native control plane for internal Model Context Protocol (MCP) servers.

Served at docs.mcpruntime.org as a generated MkDocs site. Source remains plain Markdown in this directory.

Map

Page What it covers
Getting started Install prerequisites, run setup, deploy your first MCP server.
Architecture How the platform is built: control plane, operator, request path, services.
Runtime Control-plane responsibilities, core resources, reconciliation outputs.
CLI Every mcp-runtime command, flag, and operational flow.
Sentinel Governed request path, policy enforcement, audit, and observability.
API reference CRD fields, gateway headers, runtime/governance/analytics HTTP APIs.
Cluster readiness Per-distribution prerequisites (k3s / kind / minikube / kubeadm).
Internals Source-tree walkthroughs for contributors.

Where to start

Status

Alpha. The architecture is stable enough to evaluate. The API and UX are still evolving — treat the v1alpha1 types as the source of truth.

Production deploy (GitHub Actions)

The deploy-docs job in .github/workflows/ci.yaml syncs docs/ to your remote host and, by default, builds/runs a Docker container there.

Docker build context is this docs/ directory:

  • Dockerfile builds a static MkDocs site and packages it in nginx.
  • nginx.conf serves the generated site for docs.mcpruntime.org with MkDocs directory URL handling, static asset caching, gzip, and basic hardening headers.
  • mkdocs.yml defines nav/theme/site settings.
  • requirements.txt pins MkDocs dependencies.

Required GitHub secrets:

  • DOCS_DEPLOY_HOST
  • DOCS_DEPLOY_USER
  • DOCS_DEPLOY_PATH
  • DOCS_DEPLOY_SSH_KEY

Optional GitHub secrets:

  • DOCS_HOST_PORT=8081
  • DOCS_CONTAINER_PORT=80
  • DOCS_CONTAINER_NAME=mcp-runtime-docs
  • DOCS_IMAGE_NAME=mcp-runtime-docs:latest
  • DOCS_DEPLOY_COMMAND (if set, CI runs this instead of the default Docker build/run sequence)