extremecanada/sonic-mcp-community-server repository overview

⁠SONiC MCP Community Server

A Model Context Protocol (MCP) server for SONiC switches. Exposes 55 tools — reads, mutations, fabric-level diagnostics, and LLDP-based inventory discovery — that any AI agent or plain HTTP client can use to inspect and safely change a SONiC fabric.

Pair with extremecanada/sonic-mcp-community-client⁠ for the web UI.

⁠📂 Before you pull — host directories

The image runs as non-root user mcp (uid 1000). If a bind-mount source doesn't exist when the container starts, Docker creates it as root and the container user can't write to it. Symptoms: adding a switch via the UI returns 500, mutations.jsonl never appears, snapshot saves fail silently. Pre-create the dirs yourself so they land with sensible ownership:

mkdir -p config logs snapshots

# Most dev machines already have uid 1000 as the first user — check:
id -u                # if this prints 1000, you're done

# If your uid is different, align ownership with the container user:
sudo chown -R 1000:1000 config logs snapshots

./config/ holds the operator's lab definition — back this up. ./logs/mutations.jsonl is the audit trail — keep it on durable storage.

⁠🚀 Quick start

docker pull extremecanada/sonic-mcp-community-server:latest

docker run -d --name sonic-mcp \
  -p 8000:8000 \
  -e SONIC_DEFAULT_USERNAME=admin \
  -e SONIC_DEFAULT_PASSWORD=YourPaSsWoRd \
  -e MCP_MUTATIONS_ENABLED=1 \
  -v $(pwd)/config:/app/config \
  -v $(pwd)/logs:/app/logs \
  -v $(pwd)/snapshots:/app/snapshots \
  extremecanada/sonic-mcp-community-server:latest

curl http://localhost:8000/tools | jq 'length'   # → 55

That's it. Point it at any SONiC switch reachable from the container over RESTCONF (:443) and SSH (:22).

⁠🧱 docker-compose

services:
  mcp:
    image: extremecanada/sonic-mcp-community-server:latest
    container_name: sonic-mcp
    restart: unless-stopped
    ports: ["8000:8000"]
    env_file: .env
    volumes:
      - ./config:/app/config          # inventory.json + fabric_intent.json (hot-reloaded)
      - ./logs:/app/logs              # mutation ledger (JSONL)
      - ./snapshots:/app/snapshots    # saved config_db.json dumps
    environment:
      - SONIC_INVENTORY_PATH=/app/config/inventory.json
      - SONIC_FABRIC_INTENT_PATH=/app/config/fabric_intent.json

Create .env alongside:

SONIC_DEFAULT_USERNAME=admin
SONIC_DEFAULT_PASSWORD=YourPaSsWoRd
MCP_MUTATIONS_ENABLED=1
SONIC_VERIFY_TLS=false

Then: docker compose up -d.

⁠🔑 Environment variables

⁠📂 Volumes

Nothing lab-specific is baked into the image — every credential, intent, and snapshot lives on the host.

⁠🔌 Endpoints

⁠🛡️ Safety tiers

Every mutation is triple-gated:

1. MCP_MUTATIONS_ENABLED=0 → 403 on every write tool
2. Per-tool requires_confirmation → client must send confirm=true
3. Auto-mode allow-list → gates agentic callers

Every successful mutation lands in /app/logs/mutations.jsonl with pre/post state. rollback_mutation replays any reversible entry.

⁠🧰 Companion client

The web UI with fabric graph, AI console, mutation-confirm modal, command palette, intent editor, and row actions is a separate image:

docker pull extremecanada/sonic-mcp-community-client:latest

See extremecanada/sonic-mcp-community-client⁠ for its own quickstart.

⁠🔗 Links

• Source: https://github.com/YuryOstrovsky/sonic-mcp-community-server⁠
• Client repo: https://github.com/YuryOstrovsky/sonic-mcp-community-client⁠
• Client image: extremecanada/sonic-mcp-community-client⁠
• License: Apache-2.0

⁠⚠️ Notes

• This build has no auth on the REST API. Put it on a trusted network (VPN, Tailscale, Cloudflare Access, reverse-proxy with auth).
• The container runs as non-root user mcp (uid 1000) with no-new-privileges. Host-side bind-mounts inherit that uid.
• Tags: :latest, :<major>, :<major>.<minor>, :<full-semver>. Pin to an exact version in production.