Deployment¶

Deployment Options¶

egeria-mcp supports local stdio, a loopback-only development listener, a least-privilege stdio container, and a remote authenticated HTTPS boundary. Provider endpoint, credential, selector, identity, and trust material are supplied at runtime through AgentConfig; none is stored in this repository.

Installed stdio process¶

{
  "mcpServers": {
    "egeria": {
      "command": "egeria-mcp",
      "args": [],
      "env": {"MCP_TOOL_MODE": "intent"}
    }
  }
}

Loopback development listener¶

egeria-mcp --transport streamable-http --host 127.0.0.1 --port 8000

Do not expose this listener beyond loopback. Network deployments require direct TLS or an explicitly trusted TLS-terminating ingress, configured authentication, exact MCP_ALLOWED_HOSTS, and an exact trusted-proxy CIDR policy.

Least-privilege local container¶

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 \
  registry.example.invalid/egeria-mcp@sha256:<digest> egeria-mcp

The operator projects the selected AgentConfig profile into the process at runtime; the image remains immutable and contains no environment connection profile.

Remote authenticated HTTPS endpoint¶

{
  "mcpServers": {
    "egeria": {"url": "https://service.example.invalid/mcp"}
  }
}

Store the real remote URL, outbound identity reference, and TLS-profile reference in AgentConfig, not in MCP client JSON or documentation.

This page covers running egeria-mcp as a long-lived server: the transports, a Docker Compose stack, putting it behind a Caddy reverse proxy, and giving it a DNS name with Technitium. To provision the Egeria platform it connects to, see Backing Platform.

egeria-mcp ships an MCP server (console script egeria-mcp). It does not include a separate A2A agent server — it is a typed, deterministic tool surface a policy router / agent calls. (Ecosystem packages that do ship an agent server expose a second *-agent console script and an agent.compose.yml.)

Run the MCP server¶

The transport is selected with --transport (or the TRANSPORT env var):

stdio (default)streamable-httpsse

egeria-mcp

For IDE / desktop MCP clients that launch the server as a subprocess.

egeria-mcp --transport streamable-http --host 0.0.0.0 --port 8000

A network server with a /health endpoint and /mcp route.

egeria-mcp --transport sse --host 0.0.0.0 --port 8000

Health check (HTTP transports):

curl -s http://localhost:8000/health        # {"status":"OK"}

Configuration (environment)¶

egeria-mcp is configured entirely from the environment. The required set:

Var	Default	Meaning
`EGERIA_PLATFORM_URL`	`https://localhost:9443`	OMAG platform URL
`EGERIA_VIEW_SERVER`	`qs-view-server`	View server name
`EGERIA_USER`	(unset)	User id
`EGERIA_USER_PASSWORD`	(unset)	Password / token, injected at runtime
`EGERIA_TLS_PROFILE`	(unset)	Optional runtime TLS profile selector; trust material remains outside durable configuration
`EGERIA_ENABLE_WRITE`	`False`	Gate every write/harvest tool
`EGERIATOOL`	`True`	Register the Egeria tool set

Plus HOST / PORT / TRANSPORT for HTTP transports. Every optional harvest connector (ServiceNow, ERPNext, GitLab, …) reads its own credentials — the full set, grouped by source system, is documented in .env.example. Copy it to .env and fill in only what you use.

Docker Compose¶

The repo ships docker/mcp.compose.yml. It reads a sibling .env and publishes the HTTP server on :8000:

services:
  egeria-mcp:
    image: example/egeria-mcp@sha256:<digest>
    container_name: egeria-mcp
    hostname: egeria-mcp
    restart: always
    env_file:
      - .env
    environment:
      - PYTHONUNBUFFERED=1
      - HOST=0.0.0.0
      - PORT=8000
      - TRANSPORT=streamable-http
    ports:
      - "8000:8000"
    healthcheck:
      test: ["CMD", "python3", "-c", "import urllib.request; urllib.request.urlopen('http://localhost:8000/health')"]
      interval: 30s
      timeout: 10s
      retries: 3

cp .env.example .env          # then edit EGERIA_* values
docker compose -f docker/mcp.compose.yml up -d
docker compose -f docker/mcp.compose.yml logs -f

Behind a Caddy reverse proxy¶

Expose the HTTP server on a hostname with automatic TLS. Add to your Caddyfile:

# Internal (self-signed) — homelab .example.invalid zone
egeria-mcp.example.invalid {
    tls internal
    reverse_proxy egeria-mcp:8000
}

# Public — automatic Let's Encrypt
egeria-mcp.example.com {
    reverse_proxy egeria-mcp:8000
}

Reload Caddy:

docker compose -f services/caddy/compose.yml exec caddy caddy reload --config /etc/caddy/Caddyfile

DNS with Technitium¶

Point the hostname at the host running Caddy. Via the Technitium API:

curl -s "http://technitium.example.invalid:5380/api/zones/records/add" \
  --data-urlencode "token=$TECHNITIUM_DNS_TOKEN" \
  --data-urlencode "domain=egeria-mcp.example.invalid" \
  --data-urlencode "zone=arpa" \
  --data-urlencode "type=A" \
  --data-urlencode "ipAddress=192.0.2.10" \
  --data-urlencode "ttl=3600"

…or add an A record egeria-mcp.example.invalid → <caddy-host-ip> in the Technitium web console (http://technitium.example.invalid:5380). The ecosystem technitium-dns-mcp automates this as a tool.

Register with an MCP client¶

Add to your client's mcp_config.json (multiplexer nickname eg):

{
  "mcpServers": {
    "egeria-mcp": {
      "command": "uv",
      "args": ["run", "egeria-mcp"],
      "env": {
        "EGERIA_PLATFORM_URL": "https://your-egeria:9443",
        "EGERIA_VIEW_SERVER": "qs-view-server",
        "EGERIA_USER": "erinoverview",
        "EGERIA_USER_PASSWORD": "secret"
      }
    }
  }
}

For a remote HTTP server, point the client at http://egeria-mcp.example.invalid/mcp instead.