MCP tunnels is a Research Preview feature. Request access to try it.
The proxy reads its configuration from /etc/mcp-gateway/config.yaml (Compose) or the rendered ConfigMap (Helm, populated from gateway.config.*).
| Field | Description | Default |
|---|---|---|
listen_addr | Address and port to listen on. | Required |
log_level | Logging verbosity: debug, info, warn, or error. | info |
shutdown_timeout | How long to wait for in-flight requests during graceful shutdown. | 30s |
tunnel_domain | Base domain assigned to the tunnel. When set, route lookup strips this suffix from incoming hostnames so routes keys can be bare subdomains (wiki). When empty, routes keys must be exact full hostnames. | Required for the subdomain-key form used in this guide |
tls.cert_file | Path to the server TLS certificate. | Required |
tls.key_file | Path to the server TLS private key. | Required |
routes | Flat map of subdomain (or full hostname) to upstream URL (map[string]string, not a list). Exact match is tried first, then prefix match against tunnel_domain. The match is on the hostname only; the request path and query string are forwarded to the upstream untouched. The upstream value must be exactly scheme://host:port (port is mandatory; including a path is rejected at config load with invalid upstream (must be scheme://host:port)). | Required |
upstream.allowed_ips | IPv4 CIDR ranges or single addresses the proxy is permitted to connect to. Mutually exclusive with disable_ip_validation. | RFC1918 private ranges |
upstream.disable_ip_validation | Disable upstream IP validation entirely. Mutually exclusive with allowed_ips. | false |
upstream.tls.ca_file | CA bundle for validating upstream TLS. | None |
upstream.tls.include_system_cas | Also trust the system CA bundle for upstream TLS. | false |
For https:// upstream routes, set at least one of upstream.tls.ca_file or upstream.tls.include_system_cas; otherwise the proxy has no trust anchor for the upstream certificate.
See the MCP tunnels Admin API reference for all endpoints, request and response schemas, and per-language examples.
All MCP tunnels endpoints require a bearer token with the org:manage_tunnels scope obtained through Workload Identity Federation. Admin API keys are not accepted.
Required headers on every request:
| Header | Value |
|---|---|
Authorization | Bearer <token> (the WIF-exchanged token) |
anthropic-version | 2023-06-01 |
anthropic-beta | mcp-tunnels-2026-05-19 |
The setup binary generates compliant certificates automatically. These requirements apply only if you issue certificates through your own PKI.
Upload with POST /v1/organizations/tunnels/{tunnel_id}/certificates. A tunnel can hold up to two active CA certificates at a time, which allows zero-downtime rotation.
BasicConstraints extension present with CA:TRUE, marked critical.SubjectKeyIdentifier extension present.KeyUsage includes keyCertSign.Presented by the proxy during the inner TLS handshake.
AuthorityKeyIdentifier extension present and matching the CA's SubjectKeyIdentifier.<route>.<tunnel-domain>. A wildcard *.<tunnel-domain> covers all routes.ExtendedKeyUsage extension is present, it includes serverAuth.The setup binary generates an ECDSA P-256 CA with five-year validity and an RSA 4096-bit server certificate with a wildcard SAN and 90-day validity.
The setup binary ships inside the mcp-proxy image. Run it with docker compose run --rm setup <subcommand> (Compose) or rely on the chart's hooks and CronJobs (Helm).
setup initAttaches to the tunnel you created in the Console, generates a CA and server certificate, registers the CA, retrieves the tunnel token, and writes all outputs to the destination.
| Flag | Description | Default |
|---|---|---|
--api-url | Claude API base URL. Also read from API_URL. | Required |
--tunnel-id | Tunnel ID to attach to (tnl_...). Also read from TUNNEL_ID. | Required |
--output | Output destination: dir:/path or k8s-secret:NAME. | k8s-secret:mcp-gateway (auto-detected when running in a Kubernetes pod; required otherwise) |
--cert-duration | Server certificate validity period. | (90 days) |
The command authenticates through Workload Identity Federation. It reads ANTHROPIC_FEDERATION_RULE_ID, ANTHROPIC_ORGANIZATION_ID, ANTHROPIC_WORKSPACE_ID (optional), and exactly one of ANTHROPIC_IDENTITY_TOKEN_FILE or ANTHROPIC_IDENTITY_TOKEN. See the WIF reference for the current semantics of these variables; the setup binary derives the service account from the federation rule, so it does not require ANTHROPIC_SERVICE_ACCOUNT_ID separately.
setup renew-certIssues a new server certificate signed by the stored CA. Makes no API calls.
| Flag | Description | Default |
|---|---|---|
--output | Output destination: dir:/path or k8s-secret:NAME. | k8s-secret:mcp-gateway (auto-detected when running in a Kubernetes pod; required otherwise) |
--cert-duration | New certificate validity period. | 2160h (90 days) |
--renew-before | Skip renewal if the existing certificate has more than this duration remaining. | 0 (always renew) |
Setting --renew-before=720h makes the command a no-op when more than 30 days of validity remain, so it's safe to run on a fixed schedule.
Was this page helpful?
2160h--token-version | Change-detection string. A new value triggers token rotation on re-run. | None |