Deployment

Deployment Options

keycloak-agent exposes its MCP server (console script keycloak-mcp) four ways. Pick the row that matches where the server runs relative to your MCP client, then copy the matching mcp_config.json below. Replace the <your-…> placeholders with the values from the Configuration / Environment Variables section.

#	Option	Transport	Where it runs	mcp_config.json key
1	stdio	stdio	client launches a subprocess	command
2	Streamable-HTTP (local)	streamable-http	a local network port	command or url
3	Local container / uv	stdio or streamable-http	Docker / Podman / uv on this host	command or url
4	Remote URL	streamable-http	a remote host behind Caddy	url

1. stdio (local subprocess)

The client launches the server over stdio via uvx — best for local IDEs (Cursor, Claude Desktop, VS Code):

{
  "mcpServers": {
    "keycloak-mcp": {
      "command": "uvx",
      "args": ["--from", "keycloak-agent", "keycloak-mcp"],
      "env": {
        "KEYCLOAK_URL": "<your-keycloak_url>",
        "KEYCLOAK_PASSWORD": "<your-keycloak_password>",
        "KEYCLOAK_USERNAME": "<your-keycloak_username>"
      }
    }
  }
}

2. Streamable-HTTP (local process)

Run the server as a long-lived HTTP process:

uvx --from keycloak-agent keycloak-mcp --transport streamable-http --host 0.0.0.0 --port 8000
curl -s http://localhost:8000/health        # {"status":"OK"}

Then either let the client launch it:

{
  "mcpServers": {
    "keycloak-mcp": {
      "command": "uvx",
      "args": ["--from", "keycloak-agent", "keycloak-mcp", "--transport", "streamable-http", "--port", "8000"],
      "env": {
        "TRANSPORT": "streamable-http",
        "HOST": "0.0.0.0",
        "PORT": "8000",
        "KEYCLOAK_URL": "<your-keycloak_url>",
        "KEYCLOAK_PASSWORD": "<your-keycloak_password>",
        "KEYCLOAK_USERNAME": "<your-keycloak_username>"
      }
    }
  }
}

…or connect to the already-running process by URL:

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

3. Local container / uv

(a) Launch a container directly from mcp_config.json (stdio over the container — no ports to manage). Swap docker for podman for a daemonless runtime:

{
  "mcpServers": {
    "keycloak-mcp": {
      "command": "docker",
      "args": [
        "run", "-i", "--rm",
        "-e", "TRANSPORT=stdio",
        "-e", "KEYCLOAK_URL=<your-keycloak_url>",
        "-e", "KEYCLOAK_PASSWORD=<your-keycloak_password>",
        "-e", "KEYCLOAK_USERNAME=<your-keycloak_username>",
        "knucklessg1/keycloak-agent:latest"
      ]
    }
  }
}

(b) Run a local streamable-http container, then connect by URL:

docker run -d --name keycloak-mcp -p 8000:8000 \
  -e TRANSPORT=streamable-http \
  -e PORT=8000 \
  -e KEYCLOAK_URL="<your-keycloak_url>" \
  -e KEYCLOAK_PASSWORD="<your-keycloak_password>" \
  -e KEYCLOAK_USERNAME="<your-keycloak_username>" \
  knucklessg1/keycloak-agent:latest
# or, from a clone of this repo:
docker compose -f docker/mcp.compose.yml up -d

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

(c) From a local checkout with uv:

uv run keycloak-mcp --transport streamable-http --port 8000

4. Remote URL (deployed behind Caddy)

When the server is deployed remotely (e.g. as a Docker service) and published through Caddy on the internal *.arpa zone, connect with the "url" key — no local process or image required:

{
  "mcpServers": {
    "keycloak-mcp": { "url": "http://keycloak-mcp.arpa/mcp" }
  }
}

Caddy reverse-proxies http://keycloak-mcp.arpa to the container's :8000 streamable-http listener; http://keycloak-mcp.arpa/health returns {"status":"OK"} when the service is live.

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

keycloak-agent ships two console scripts: an MCP server (keycloak-mcp) exposing the typed tool surface, and an optional Pydantic-AI agent server (keycloak-agent) that consumes those tools. Deploy the MCP server on its own for a policy router / agent to call, or add the agent server for autonomous operation.

Run the MCP server

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

stdio (default)streamable-httpsse

keycloak-mcp

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

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

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

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

Health check (HTTP transports):

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

Configuration (environment)

keycloak-agent is configured entirely from the environment. The required set:

Var	Default	Meaning
KEYCLOAK_URL	http://localhost:8080	Keycloak base admin URL
KEYCLOAK_USERNAME	admin	Admin account username
KEYCLOAK_PASSWORD	admin_secure_password	Admin account password
KEYCLOAK_REALM	master	Realm name

Plus HOST / PORT / TRANSPORT for HTTP transports. The full set is documented in .env.example; copy it to .env and fill in your values. The server registers its tools and remains inactive on administrative writes when credentials are absent.

Docker Compose

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

services:
  keycloak-agent:
    image: knucklessg1/keycloak-agent:latest
    container_name: keycloak-agent
    hostname: keycloak-agent
    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 KEYCLOAK_* values
docker compose -f docker/compose.yml up -d
docker compose -f docker/compose.yml logs -f

Run the agent server

The optional agent server (keycloak-agent console script) starts a Pydantic-AI agent that consumes the MCP tools. Point it at a running MCP server with --mcp-url, or let it launch one from a bundled mcp_config.json:

# Connect the agent to an already-deployed MCP HTTP server
keycloak-agent --mcp-url http://keycloak-agent:8000/mcp --host 0.0.0.0 --port 9000

The agent server listens on :9000 by default. A companion Compose file deploys it alongside the MCP server, wiring MCP_URL to the MCP service by container name:

services:
  keycloak-agent-server:
    image: knucklessg1/keycloak-agent:latest
    container_name: keycloak-agent-server
    hostname: keycloak-agent-server
    restart: always
    entrypoint: ["keycloak-agent"]
    env_file:
      - .env
    environment:
      - MCP_URL=http://keycloak-agent:8000/mcp
      - HOST=0.0.0.0
      - PORT=9000
    ports:
      - "9000:9000"
    depends_on:
      - keycloak-agent

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

Behind a Caddy reverse proxy

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

# Internal (self-signed) — homelab .arpa zone
keycloak-agent.arpa {
    tls internal
    reverse_proxy keycloak-agent:8000
}

# Public — automatic Let's Encrypt
keycloak-agent.example.com {
    reverse_proxy keycloak-agent: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.arpa:5380/api/zones/records/add" \
  --data-urlencode "token=$TECHNITIUM_DNS_TOKEN" \
  --data-urlencode "domain=keycloak-agent.arpa" \
  --data-urlencode "zone=arpa" \
  --data-urlencode "type=A" \
  --data-urlencode "ipAddress=10.0.0.10" \
  --data-urlencode "ttl=3600"

…or add an A record keycloak-agent.arpa → <caddy-host-ip> in the Technitium web console (http://technitium.arpa: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 key):

{
  "mcpServers": {
    "keycloak_agent": {
      "command": "uv",
      "args": ["run", "keycloak-mcp"],
      "env": {
        "KEYCLOAK_URL": "http://your-keycloak:8080",
        "KEYCLOAK_USERNAME": "admin",
        "KEYCLOAK_PASSWORD": "admin_secure_password",
        "KEYCLOAK_REALM": "master"
      }
    }
  }
}

For a remote HTTP server, point the client at http://keycloak-agent.arpa/mcp instead.