Skip to main content

Caddy MCP

Status Version License

Documentation — Installation, deployment, usage across the API, agent, and MCP interfaces, and guidance for provisioning the Caddy backing server are maintained in the official documentation.

Caddy Reverse Proxy administrative and configuration orchestrator. Built with the highest architectural standards, incorporating dynamic facades, custom API routing, and FastMCP tool decoration.

Table of Contents


Overview

Caddy MCP provides a high-performance, model-optimized interface to Caddy capabilities. It isolates the model from underlying API transport complexity, ensuring safe, idempotent, and highly traceable system interactions.


Features

  • Dynamic Facade Orchestration: Integrates multi-inheritance clients cleanly under a single facade.
  • Battle-Tested Resilience: Out-of-the-box credential authentication, connection polling, and request retry strategies.
  • FastMCP Declarative Tools: Fast, native schema registration with full inline validation.
  • Complete Test Intent Diversity: Deep, automated unit, integration, and mock tests ensuring high code coverage.

⚙️ Dynamic Tool Selection & Visibility

This MCP server supports dynamic toolset selection and visibility filtering at runtime. This allows the operator to restrict the set of exposed tools to prevent blowing up the LLM's context window.

The operator can configure tool filtering via multiple input channels:

  • CLI Arguments: Pass --tools or --toolsets (or their disabled counterparts --disabled-tools and --disabled-toolsets) during startup.
  • Environment Variables: Define standard environment variables:
    • MCP_ENABLED_TOOLS / MCP_DISABLED_TOOLS
    • MCP_ENABLED_TAGS / MCP_DISABLED_TAGS
  • HTTP SSE Request Headers: Pass custom headers during transport initialization:
    • x-mcp-enabled-tools / x-mcp-disabled-tools
    • x-mcp-enabled-tags / x-mcp-disabled-tags
  • HTTP SSE Request Query Parameters: Append query parameters directly to the operator's transport connection URL:
    • ?tools=tool1,tool2
    • ?tags=tag1

When query strings or parameters are provided, an LLM-free Knowledge Graph resolution layer (using DynamicToolOrchestrator) matches query intents against known tool tags, names, or descriptions, with safe fallback and automated 24-hour background cache refreshing.


Installation

Pick the extra that matches what the operator want to run:

Extra Installs Use when
caddy-mcp[mcp] Connector-focused MCP server (agent-connector-sdk[mcp] — FastMCP/FastAPI + epistemic-graph[full]) The operator only run the MCP server (smallest install / image)
caddy-mcp[agent] Agent runtime (agent-connector-sdk[agent-runtime,logfire] — model orchestration + epistemic-graph[full]) The operator run the integrated agent
caddy-mcp[all] Everything (mcp + agent) Development / both surfaces
# Connector-focused MCP server (includes the shared graph engine)
uv pip install "caddy-mcp[mcp]"

# Agent runtime (adds model orchestration to the shared graph engine)
uv pip install "caddy-mcp[agent]"

# Everything (development)
uv pip install "caddy-mcp[all]"      # or: python -m pip install "caddy-mcp[all]"

Container images (:mcp vs :agent)

One multi-stage docker/Dockerfile builds two right-sized images, selected by --target:

Image tag Build target Contents Entrypoint
example/caddy-mcp:mcp --target mcp caddy-mcp[mcp] — connector-focused, includes epistemic-graph[full]; no model-orchestration stack caddy-mcp
example/caddy-mcp@sha256:<digest> --target agent (default) caddy-mcp[agent] — agent runtime, model orchestration + epistemic-graph[full] caddy-agent
docker build --target mcp   -t example/caddy-mcp:mcp    docker/   # connector-focused MCP server
docker build --target agent -t example/caddy-mcp:agent-local docker/   # agent runtime

docker/mcp.compose.yml runs the connector-focused :mcp server; docker/agent.compose.yml runs the agent (immutable agent digest) with a co-located :mcp sidecar.

Knowledge-graph database (epistemic-graph)

Both [mcp] and [agent] carry the epistemic-graph engine through the required Agent Utilities core dependency (epistemic-graph[full]). The [mcp] extra keeps the server connector-focused; [agent] also enables model orchestration. Local deployments can use the bundled engine. For production or shared state, run epistemic-graph as a dedicated database service and configure the runtime to use it. Deployment recipes (single-node + Raft HA), connection configuration, and architecture diagrams are documented in the epistemic-graph deployment guide.


Usage

The operator can start the FastMCP server in stdio mode via Python module execution:

import asyncio
from caddy_mcp.mcp_server import get_mcp_instance

async def main():
    mcp = get_mcp_instance()
    # Execute stdio loop or launch server
    print("MCP Server ready.")

if __name__ == "__main__":
    asyncio.run(main())

For direct shell start, ran:

python -m caddy_mcp.mcp_server

Environment Variables

Package environment variables

Variable Example Description
CADDY_URL http://localhost:2019 Caddy Administration API URL endpoint
CADDY_TOKEN secret-injected Optional bearer token if API is secured
CADDY_MCP_BASE_URL http://localhost:2019 Alternate Caddy Admin API URL (fallback when CADDY_URL is unset)
CADDY_MCP_USERNAME — Basic-auth username for the Caddy Admin API
CADDY_MCP_PASSWORD secret-injected Basic-auth password for the Caddy Admin API
CADDY_TLS_PROFILE — Verify TLS certificates when calling the Caddy Admin API
CADDY_TLS_PROFILE_REF —
CONFIGTOOL true Toggle the Caddy config / debug / PKI / reverse-proxy tools
KG_INGESTTOOL true Toggle the SDK-registered graph topology ingestion tool
CADDY_MCP_AGENT_IMAGE — Operator-approved immutable image@sha256 reference for the Compose service

Inherited agent-connector-sdk variables (apply to every connector)

Variable Example Description
TRANSPORT stdio MCP transport: stdio | streamable-http | sse
HOST 127.0.0.1 Loopback bind host (set an authenticated ingress explicitly)
PORT 8000 Bind port (HTTP transports)
MCP_ENABLED_TOOLS — Comma-separated tool allow-list
MCP_DISABLED_TOOLS — Comma-separated tool deny-list
MCP_ENABLED_TAGS — Comma-separated tag allow-list
MCP_DISABLED_TAGS — Comma-separated tag deny-list
EUNOMIA_TYPE none Authorization mode: none | embedded | remote
EUNOMIA_POLICY_FILE mcp_policies.json Embedded Eunomia policy file
EUNOMIA_REMOTE_URL — Remote Eunomia authorization server URL
ENABLE_OTEL False Enable OpenTelemetry export
OTEL_EXPORTER_OTLP_ENDPOINT — OTLP collector endpoint
MCP_CLIENT_AUTH — Outbound MCP child auth: oidc-client-credentials | basic | none
OIDC_CLIENT_ID — OIDC client id (service-account auth)
OIDC_CLIENT_SECRET_REF secret://identity/oidc-client-secret Runtime secret reference for the OIDC service account
MCP_BASIC_AUTH_USERNAME — HTTP Basic username (MCP_CLIENT_AUTH=basic)
MCP_BASIC_AUTH_PASSWORD_REF secret://identity/mcp-basic-password Runtime secret reference for HTTP Basic auth (MCP_CLIENT_AUTH=basic)
DEBUG False Verbose logging
PYTHONUNBUFFERED 1 Unbuffered stdout (recommended in containers)
MCP_URL http://localhost:8000/mcp URL of the MCP server the agent connects to
PROVIDER — Operator-configured LLM provider for the agent
MODEL_ID — Operator-configured model id for the agent
ENABLE_WEB_UI True Serve the AG-UI web interface

10 package + 23 inherited variable(s). Auto-generated from .env.example + the shared agent-connector-sdk set — do not edit.

Every variable the server reads, grouped by purpose. A local template is provided inside .env.example — copy it as .env and fill out the operator's specific service endpoint parameters before starting execution.

Connection & Credentials

Variable Description Default
CADDY_URL Caddy Administration API URL endpoint http://localhost:2019
CADDY_TOKEN Optional bearer token if the Admin API is secured —

MCP server / transport

Variable Description Default
TRANSPORT stdio, streamable-http, or sse stdio
HOST Bind host (HTTP transports) 0.0.0.0
PORT Bind port (HTTP transports) 8000
MCP_TOOL_MODE Tool surface: condensed, verbose, or both condensed
MCP_ENABLED_TOOLS / MCP_DISABLED_TOOLS Comma-separated tool allow/deny list —
MCP_ENABLED_TAGS / MCP_DISABLED_TAGS Comma-separated tag allow/deny list —
DEBUG Verbose logging False
PYTHONUNBUFFERED Unbuffered stdout (recommended in containers) 1

Tool toggles

Each action-routed tool can be disabled individually via its toggle env var (set to false). See the MCP Tools table above for the authoritative names.

Variable Description Default
CONFIGTOOL Toggle the Caddy config / debug / PKI / reverse-proxy tools True

Telemetry & governance

Variable Description Default
ENABLE_OTEL Enable OpenTelemetry export True
OTEL_EXPORTER_OTLP_ENDPOINT OTLP collector endpoint —
OTEL_EXPORTER_OTLP_PUBLIC_KEY / OTEL_EXPORTER_OTLP_SECRET_KEY OTLP auth keys —
OTEL_EXPORTER_OTLP_PROTOCOL OTLP protocol (e.g. http/protobuf) —
EUNOMIA_TYPE Authorization mode: none, embedded, remote none
EUNOMIA_POLICY_FILE Embedded policy file mcp_policies.json
EUNOMIA_REMOTE_URL Remote Eunomia server URL —

Agent CLI (full [agent] runtime only)

Variable Description Default
MCP_URL URL of the MCP server the agent connects to http://localhost:8000/mcp
PROVIDER LLM provider (e.g. openai) openai
MODEL_ID Model id (e.g. gpt-4o) gpt-4o
ENABLE_WEB_UI Serve the AG-UI web interface True

MCP Tools

The table below is auto-generated from the live server — do not edit by hand.

Intent tools

MCP Tool Kind Description
caddy_ingest_topology intent Natively ingest the live Caddy topology into epistemic-graph as typed nodes.
caddy_mcp_config intent Manage Caddy configuration and server control.
caddy_mcp_debug intent Inspect Caddy observability and profiling endpoints (metrics, expvar, pprof).
caddy_mcp_pki intent Manage Caddy PKI app CAs and certificates.
caddy_mcp_reverse_proxy intent Query Caddy reverse proxy upstream health and status.

5 intent tool(s) · 0 operation(s). Call an operation as act(action='<operation>', params={...}) (ask for reads); find(action='describe', params={'action': '<operation>'}) returns its arguments. An operation is enabled unless its <DOMAIN>TOOL toggle is set false. Auto-generated — do not edit.

See docs/overview.md or docs/concepts.md for deeper operational examples.


MCP Configuration Examples

Install the connector-focused [mcp] extra. Examples use caddy-mcp[mcp] to add FastMCP / FastAPI through agent-connector-sdk[mcp]; the required Agent Utilities core still carries epistemic-graph[full]. The [agent-runtime] extra additionally enables model orchestration.

stdio Transport (local IDEs — Cursor, Claude Desktop, VS Code)

{
  "mcpServers": {
    "caddy-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "caddy-mcp[mcp]",
        "caddy-mcp"
      ],
      "env": {
        "CADDY_MCP_BASE_URL": "http://localhost:2019",
        "CADDY_TOKEN": "your_secure_bearer_token",
        "CADDY_URL": "http://localhost:2019",
        "CONFIGTOOL": "true",
        "KG_INGESTTOOL": "true"
      }
    }
  }
}

Runtime references require an alias-aware launcher such as Arbora. Other launchers must omit those entries and inject the resolved values through their own runtime secret boundary.

Streamable-HTTP Transport (networked / production)

{
  "mcpServers": {
    "caddy-mcp": {
      "command": "uvx",
      "args": [
        "--from",
        "caddy-mcp[mcp]",
        "caddy-mcp",
        "--transport",
        "streamable-http",
        "--port",
        "8000"
      ],
      "env": {
        "TRANSPORT": "streamable-http",
        "HOST": "127.0.0.1",
        "PORT": "8000",
        "CADDY_MCP_BASE_URL": "http://localhost:2019",
        "CADDY_TOKEN": "your_secure_bearer_token",
        "CADDY_URL": "http://localhost:2019",
        "CONFIGTOOL": "true",
        "KG_INGESTTOOL": "true"
      }
    }
  }
}

Alternatively, connect to a pre-deployed Streamable-HTTP instance by url:

{
  "mcpServers": {
    "caddy-mcp": {
      "url": "http://localhost:8000/caddy-mcp/mcp"
    }
  }
}

Run a reviewed container image as a least-privilege stdio child (no listener or published port):

docker run -i --rm \
  --read-only \
  --cap-drop=ALL \
  --security-opt=no-new-privileges \
  --pids-limit=256 \
  --tmpfs /tmp:rw,noexec,nosuid,nodev,size=64m \
  -e TRANSPORT=stdio \
  -e CADDY_MCP_BASE_URL=http://localhost:2019 \
  -e CADDY_TOKEN=your_secure_bearer_token \
  -e CADDY_URL=http://localhost:2019 \
  -e CONFIGTOOL=true \
  -e KG_INGESTTOOL=true \
  registry.example.invalid/caddy-mcp@sha256:<digest> caddy-mcp

For containerized network HTTP, supply an authenticated TLS ingress (or direct server TLS), exact MCP_ALLOWED_HOSTS, and an exact trusted-proxy CIDR policy through the operator-owned deployment profile. The generator does not emit an unauthenticated non-loopback listener.

Auto-generated from the code-read env surface (package vars) — do not edit.

Architecture

This package uses the standardized Agent-Utilities dynamic facade architecture:

graph TD
    User([User Agent]) --> Server[FastMCP Server]
    Server --> Facade[Api Dynamic Facade]
    Facade --> ClientBase[ApiClientBase]
    Facade --> Auth[Credentials Auth Handler]
    ClientBase --> Service([External Service API])

Deployment

Bare-Metal (Standard pip)

  1. Set up the operator's Python virtual environment (>= 3.10).
  2. Install the package: pip install .[all]
  3. Export credentials:
    export CADDY_URL="http://localhost:2019"
    
  4. Run: python -m caddy_mcp.mcp_server

Container (Docker Compose)

A standard compose structure is provided inside the docker/ folder. Build and deploy:

docker compose -f docker/compose.yml up --build -d

Additional Deployment Options

caddy-mcp can run as a local stdio process or container, or behind a remote network boundary. The Deployment guide carries the detailed transport contract.

  • Local container — launch a reviewed immutable image as a least-privilege stdio child with no listener or published port.
  • Remote URL — connect through an operator-supplied authenticated HTTPS ingress. Keep its URL, outbound identity references, trust profile, and exact MCP_ALLOWED_HOSTS in AgentConfig.

Contributing

Please audit all code changes against the repository's contribution and review requirements, and run:

pre-commit run --all-files

Documentation

The complete documentation is published as the official documentation site and is the recommended reference for installation, deployment, and day-to-day operation.

Page Contents
Installation pip, source, extras, prebuilt Docker image
Deployment run the MCP and agent servers, Compose, Caddy + Technitium, env config
Usage the MCP tools, the Api client, the agent
Backing Platform deploy Caddy with Docker and connect the Admin API
Overview integration architecture and tool surface
Concepts concept registry (CONCEPT:CADDY-*)

AGENTS.md is the canonical contributor/agent guidance.

License

This project is licensed under the MIT License. See the LICENSE file for complete details.

Deploy with agent-connector-sdk-deployment

Provision this package with the consolidated agent-connector-sdk-deployment workflow. It selects an installed-package, editable-source, or immutable-container path; records only runtime secret and TLS-profile references in AgentConfig; and runs doctor, registration, policy, observability, and rollback gates. Ask your agent to "deploy caddy-mcp with agent-connector-sdk-deployment".

Install mode Command
Installed package uv tool install "caddy-mcp[mcp]", then run caddy-mcp
Editable source uv pip install -e ".[agent]", then run caddy-mcp
Immutable container deploy registry.example.invalid/caddy-mcp@sha256:<digest> through the operator-selected orchestrator

The repository embeds no deployment profile, credential value, certificate path, or environment-specific endpoint. Supply those at runtime through AgentConfig and the configured secret provider.

Governed capability contract

This package ships a compact canonical skill surface with specialist procedures kept as referenced workflows. The current MCP tools, skill metadata, connector_manifest.yml, ontology, mappings, shapes, fixtures, migrations, tool-schema fingerprints, and certification metadata form one versioned capability contract. Validate them together; do not rely on stale tool names or historical per-task skill wrappers.

Runtime endpoints, credentials, certificate trust, tenant identity, retention, and observability policy are deployment inputs and are never packaged values. See Configuration, trust, and privacy before enabling a network transport, connector ingestion, Arbora delegation, or trace export.

Metadata

Release files for caddy-mcp 2.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for caddy-mcp 2.3.0
File Interpreter ABI Platform
caddy_mcp-2.3.0-py3-none-any.whl Python 3 none any Details

Release files / caddy_mcp-2.3.0-py3-none-any.whl

Download URL caddy_mcp-2.3.0-py3-none-any.whl
Size 50.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4a2c8167629855cf016dd5f81485c19679b383dff94daeb061aa9717140f3245
BLAKE2b-256 checksum
How to use checksums
9c4b13d0f6bc3a6b77b3629b568aab48931658218f2c22c56ae8493c49867b38
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.4

Release history Release notifications | RSS feed

This release

2.3.0 This release

1 release file

2.2.1

1 release file

2.2.0

1 release file

1.0.1

2 release files

0.34.0

2 release files

0.32.0

2 release files

0.31.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page