UniFi Gateway MCP Setup & Guide

{
  "id": "io.github.pete-builds/unifi",
  "type": "mcp-server",
  "version": "0.25.0",
  "displayName": "UniFi Gateway",
  "description": "Safe-by-default UniFi MCP: Network + Protect + Access, multi-site, dry-run, audit log.",
  "repository": {
    "url": "https://github.com/pete-builds/mcp-unifi",
    "source": "github"
  },
  "homepage": "https://pete-builds.github.io/mcp-unifi/",
  "distribution": {
    "packages": [
      {
        "registryType": "oci",
        "identifier": "ghcr.io/pete-builds/mcp-unifi:0.25.0",
        "runtimeHint": "docker",
        "transport": "streamable-http",
        "environmentVariables": [
          {
            "name": "STUB_MODE",
            "description": "When true, the server returns realistic mock data and requires no UniFi hardware. Defaults to true so the image is functional out of the box."
          },
          {
            "name": "UNIFI_HOST",
            "description": "IP address or hostname of the UniFi OS gateway (UCG-Fiber, UDM Pro, etc). Required when STUB_MODE=false and MCP_UNIFI_CONTROLLERS_FILE is unset."
          },
          {
            "name": "UNIFI_API_KEY",
            "description": "Local API key generated under Settings -> Control Plane -> Integrations on the gateway. Required when STUB_MODE=false and MCP_UNIFI_CONTROLLERS_FILE is unset.",
            "isSecret": true
          },
          {
            "name": "UNIFI_SITE",
            "description": "UniFi controller site name. Defaults to 'default'."
          },
          {
            "name": "UNIFI_VERIFY_SSL",
            "description": "Whether to verify the gateway's TLS certificate. Defaults to false because most home gateways use a self-signed cert."
          },
          {
            "name": "MCP_UNIFI_CONTROLLERS_FILE",
            "description": "Path to a YAML file describing multiple named controllers for multi-site management. When set, the legacy UNIFI_HOST / UNIFI_API_KEY env vars are ignored. Each entry needs name, host, api_key, and optionally port, site, verify_ssl."
          },
          {
            "name": "MCP_UNIFI_MODULES_ENABLED",
            "description": "Comma-separated list of modules to load. Known values: 'network', 'protect', 'access'. Defaults to 'network'. Set to 'network,protect,access' to enable Protect and Access tools alongside Network. Access currently ships read-only; door unlocks and credential issuance require session-token auth and are deferred."
          },
          {
            "name": "UNIFI_ACCESS_HOST",
            "description": "UniFi Access hub IP or hostname. Required when the access module is enabled and STUB_MODE=false. Often the same host as UNIFI_HOST."
          },
          {
            "name": "UNIFI_ACCESS_API_KEY",
            "description": "UniFi Access API key. Separate from the Network API key; generated on the Access controller's developer settings. Required when the access module is enabled and STUB_MODE=false.",
            "isSecret": true
          },
          {
            "name": "UNIFI_ACCESS_PORT",
            "description": "HTTPS port for the Access hub. Defaults to 12445 (the direct Access app port)."
          },
          {
            "name": "MCP_UNIFI_AUDIT_SINK",
            "description": "Audit log sink. One of 'file' (default), 'stdout', or 'syslog'. Every tool call is recorded to a JSONL stream with secrets scrubbed."
          },
          {
            "name": "MCP_UNIFI_AUDIT_PATH",
            "description": "Path for the audit log file when MCP_UNIFI_AUDIT_SINK=file. Defaults to audit.jsonl in the process CWD."
          }
        ]
      }
    ],
    "remotes": []
  },
  "dependencies": [],
  "installTargets": [
    "claude-code",
    "claude-desktop",
    "cursor",
    "vscode",
    "trae",
    "cherry-studio",
    "lingma",
    "windsurf",
    "cline",
    "workbuddy"
  ],
  "keywords": [],
  "provenance": {
    "origin": "official-mcp-registry",
    "originalId": "io.github.pete-builds/unifi",
    "originalUrl": "https://registry.modelcontextprotocol.io/v0.1/servers/io.github.pete-builds%2Funifi/versions/latest",
    "isOfficial": true,
    "status": "active"
  }
}