AgentHubAgentHub

UniFi Gateway MCP Setup & Guide

MCP ServerMCP RegistryOfficial

io.github.pete-builds/unifi · v0.29.0

Safe-by-default UniFi MCP: Network + Protect + Access, multi-site, dry-run, audit log.

Copy the install config on this page first, then verify docs and permissions upstream.

Overview

Safe-by-default UniFi MCP: Network + Protect + Access, multi-site, dry-run, audit log. UniFi Gateway is a MCP Server listed from MCP Registry. Transports: streamable-http. This page includes an overview, setup tutorial, install commands, and use cases for Trae, Tongyi Lingma, Cursor, Claude Code, and VS Code.

Use cases

AgentHub Verified AvailabilityTested & Ready

Automated pipeline validated install commands, protocol & client compatibility

Verified At2026-11-15
Install Snippets TestedCLI & JSON config syntax verified
Protocol Handshake ReadyComplies with JSON-RPC 2.0 specifications
Origin Registry ActiveSourced from official-mcp-registry
Verified ClientsClaude Code、Claude Desktop、Cursor 等
Security Tier: A+ 级 · 官方认证推荐 (A+)·Maintained by official/verified teams, audited for standard MCP protocol compliance.

Copy by platform

Choose your platform

  1. Open or create .cursor/mcp.json in your project root
  2. Click Copy config and paste; merge only this mcpServers entry if others exist
  3. Replace <placeholders> in env with real secrets (see Environment variables below)
  4. Save, then Cmd+Shift+P → Reload Window

Pre-fill Environment Variables (Optional)

Requiredsecret
secret
secret
Privacy Guarantee: Keys are replaced 100% locally in your browser memory and are NEVER uploaded or stored on any server.
Click to copy snippet
{
  "mcpServers": {
    "unifi": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/pete-builds/mcp-unifi:0.29.0"
      ],
      "env": {
        "MCP_UNIFI_AUTH_TOKENS": "<MCP_UNIFI_AUTH_TOKENS>"
      }
    }
  }
}

Setup tutorial

  1. Open the UniFi Gateway page and confirm this MCP Server (source: MCP Registry).
  2. Copy the Cursor, Claude Code, or VS Code snippet.
  3. Merge it into mcpServers and replace env placeholders with real secrets.
  4. Reload the window, then call the MCP tools from your agent chat.

Install commands

Install commands and setup steps are in the HTML so search engines and no-JS browsers can read them without running client JavaScript.

Claude Code (local)

  1. Install Claude Code CLI
  2. Copy the command below, replace <placeholders> with real env values, then run in terminal
  3. See Environment variables below if listed
claude mcp add unifi --env MCP_UNIFI_AUTH_TOKENS=<MCP_UNIFI_AUTH_TOKENS> -- docker run -i --rm ghcr.io/pete-builds/mcp-unifi:0.29.0

Cursor — .cursor/mcp.json (local)

  1. Open or create .cursor/mcp.json in your project root
  2. Click Copy config and paste; merge only this mcpServers entry if others exist
  3. Replace <placeholders> in env with real secrets (see Environment variables below)
  4. Save, then Cmd+Shift+P → Reload Window
{
  "mcpServers": {
    "unifi": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/pete-builds/mcp-unifi:0.29.0"
      ],
      "env": {
        "MCP_UNIFI_AUTH_TOKENS": "<MCP_UNIFI_AUTH_TOKENS>"
      }
    }
  }
}

VS Code — .vscode/mcp.json (local)

  1. Install GitHub Copilot in VS Code with MCP support
  2. Open or create .vscode/mcp.json in your project root
  3. Click Copy config and paste; merge only this mcpServers entry if others exist
  4. Replace <placeholders> in env with real secrets
  5. Save and Developer: Reload Window
{
  "mcpServers": {
    "unifi": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/pete-builds/mcp-unifi:0.29.0"
      ],
      "env": {
        "MCP_UNIFI_AUTH_TOKENS": "<MCP_UNIFI_AUTH_TOKENS>"
      }
    }
  }
}

Claude Desktop — claude_desktop_config.json (local)

  1. Open Claude Desktop claude_desktop_config.json (see remote guide for paths)
  2. Click Copy config and merge under mcpServers
  3. Replace <placeholders> in env with real secrets
  4. Fully quit and restart Claude Desktop
{
  "mcpServers": {
    "unifi": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/pete-builds/mcp-unifi:0.29.0"
      ],
      "env": {
        "MCP_UNIFI_AUTH_TOKENS": "<MCP_UNIFI_AUTH_TOKENS>"
      }
    }
  }
}

Trae — .trae/mcp.json (local)

  1. Trae → Settings → MCP, or edit .trae/mcp.json / global mcp.json
  2. Click Copy config and merge mcpServers
  3. Replace <placeholders> in env with real secrets
  4. Save and reload Trae
{
  "mcpServers": {
    "unifi": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/pete-builds/mcp-unifi:0.29.0"
      ],
      "env": {
        "MCP_UNIFI_AUTH_TOKENS": "<MCP_UNIFI_AUTH_TOKENS>"
      }
    }
  }
}

Cherry Studio — MCP settings (local)

  1. Cherry Studio → Settings → MCP Servers → Add (STDIO)
  2. Or import JSON: click Copy config and merge mcpServers
  3. Replace <placeholders> in env; ensure Node.js / uv (npx, uvx) are installed
  4. Enable the server and check tools load
{
  "mcpServers": {
    "unifi": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/pete-builds/mcp-unifi:0.29.0"
      ],
      "env": {
        "MCP_UNIFI_AUTH_TOKENS": "<MCP_UNIFI_AUTH_TOKENS>"
      }
    }
  }
}

Tongyi Lingma — MCP config (local)

  1. Lingma Settings → MCP → + → STDIO or config file
  2. Click Copy config and merge mcpServers
  3. Replace <placeholders> in env; need Node.js 18+ (npx) or uv (uvx)
  4. Confirm connected before using tools in agent chat
{
  "mcpServers": {
    "unifi": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/pete-builds/mcp-unifi:0.29.0"
      ],
      "env": {
        "MCP_UNIFI_AUTH_TOKENS": "<MCP_UNIFI_AUTH_TOKENS>"
      }
    }
  }
}

Windsurf — mcp_config.json (local)

  1. Edit ~/.codeium/windsurf/mcp_config.json
  2. Click Copy config and merge mcpServers (stdio same as Cursor)
  3. Replace <placeholders> in env, save, refresh Cascade
{
  "mcpServers": {
    "unifi": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/pete-builds/mcp-unifi:0.29.0"
      ],
      "env": {
        "MCP_UNIFI_AUTH_TOKENS": "<MCP_UNIFI_AUTH_TOKENS>"
      }
    }
  }
}

Cline — MCP Servers (local)

  1. Cline panel → Settings → MCP Servers
  2. Click Copy config and merge
  3. Replace <placeholders> in env, then save
{
  "mcpServers": {
    "unifi": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/pete-builds/mcp-unifi:0.29.0"
      ],
      "env": {
        "MCP_UNIFI_AUTH_TOKENS": "<MCP_UNIFI_AUTH_TOKENS>"
      }
    }
  }
}

WorkBuddy — .workbuddy/mcp.json (local)

  1. Edit ~/.workbuddy/mcp.json (user) or project .workbuddy/mcp.json
  2. Or Plugins → MCP Servers → Configure MCP and paste the JSON below
  3. Replace <placeholders> in env; on Windows prefer absolute paths for command/scripts
  4. Save, restart WorkBuddy, confirm connector status is green
{
  "mcpServers": {
    "unifi": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "ghcr.io/pete-builds/mcp-unifi:0.29.0"
      ],
      "env": {
        "MCP_UNIFI_AUTH_TOKENS": "<MCP_UNIFI_AUTH_TOKENS>"
      }
    }
  }
}

Troubleshooting & Common ErrorsFAQ

Common connection errors and verified fixes for UniFi Gateway

Getting 'connection closed' or exit code 1 in Cursor / Claude Code for UniFi Gateway?

Usually caused by missing runtime paths or IDE environment inheritance. Fix steps: 1. Verify Node.js 18+ (npx) or Python 3.10+ (uvx) is installed; 2. Run 'which npx' or 'which uvx' in terminal, and replace 'command' with absolute path; 3. Reload or restart the client window after modifying config.

Fix Snippet
# Check binary path in terminal:
which npx
node -v
Getting 'spawn npx ENOENT' or 'command not found'?

The editor background process does not inherit your full terminal PATH. Solution: Globally install the package, or set the absolute binary path (e.g. C:\Program Files\nodejs\npx.cmd on Windows, or /usr/local/bin/npx on macOS).

Missing required environment variable or authentication failure?

UniFi Gateway requires environment variables (MCP_UNIFI_AUTH_TOKENS). Ensure you have added valid keys under the 'env' object in your config file without trailing whitespace.

Fix Snippet
// .cursor/mcp.json 或 claude_desktop_config.json
{
  "env": {
    "MCP_UNIFI_AUTH_TOKENS": "your_actual_key_here"
  }
}

Tool Mock Playground

Sandbox

UniFi Gateway Tool Interface Simulation · Preview tool schema & outputs without local runtime

Sandbox Ready
fn: unifiExecute the core tool interface of UniFi Gateway
Request ArgumentsJSON Schema
{
  "target": "UniFi Gateway",
  "action": "execute",
  "options": {
    "mode": "standard",
    "timeoutMs": 5000
  }
}
💡Parameters generated dynamically by Agent runtime
Agent Tool Output

Click 'Run Mock' above

to preview the raw response returned to the LLM

Env: AgentHub Virtual SandboxJSON-RPC 2.0

Decision Guide: Why & When to Use

Assess suitability before installing to save trial-and-error time

Best Suited For
  • PR review
  • Changelog generation
  • Cross-repo issue search
When NOT to Use
  • Replacing human security audit
  • Unauthorized repo access
Recommended Workflow Pairing:View Scenario →

UniFi Gateway + Scenario Prompt → Complete Agent Automation

MCP hands-on: install to visible results

Follow the full lab (expected UI/output + contrast checks). After installing this item, verify with the tutorial prompts.

Open tutorial →

Related resources

Often paired with

insurance-advisor-china

v2.4.21

SkillClawHub7410.3k

io.clawhub.mnetfairy/insurance-advisor-china

中国大陆AI保险顾问。为个人和家庭提供全方位的保险咨询、产品对比、方案设计、投保指导。当用户询问保险配置、保险方案、产品对比、重疾险/医疗险/寿险/意外险/储蓄险推荐、保费计算、保障缺口分析、需求分析、核保合规、理赔等问题时使用。发布产物仅含 SKILL.md + 3 个只读参考文件(references/products.json、insurance-knowledge.md、compliance.md)+ 3 个运行时脚本(needs_analyzer / premium_calculator / plan_designer);数据清洗脚本与回归测试脚本是本地维护工具,不随发布产物分发。

source

ai-insurance-advisor

v2.4.21

SkillClawHub8110.4k

io.clawhub.mnetfairy/ai-insurance-advisor

中国大陆保险顾问。本 skill 覆盖 8 项能力:保险需求分析(needs_analyzer.py)、产品对比(premium_calculator.py + 本地 products.json)、保费计算(premium_calculator.py)、方案设计(plan_designer.py)、保险知识问答(insurance-knowledge.md)、合规要点提示(compliance.md)、朋友圈/社交营销文案生成(agent LLM 生成,无专属脚本)、培训话术支持(agent LLM 生成,无专属脚本)。不提供核保预审、理赔代办、代理人展业工具等能力——这些场景请转人工或调用专业服务。发布产物仅含 SKILL.md + 3 个只读参考文件 + 3 个运行时脚本(needs_analyzer / premium_calculator / plan_designer);数据清洗与回归测试脚本为本地维护工具,不随发布产物分发。

source

中文公文写作

v2.0.63

SkillClawHub7412k

io.clawhub.gongyu0918-debug/chinese-official-writing

用于中文公文、事务性材料和新闻稿件的起草、改写、压缩、润色、审校、文种核对、去口语化、降 AI 味及 Word 格式处理,适用于机关、企事业单位、学校和新闻机构。涵盖申请、请示、报告、通知、通告、意见、决定、决议、议案、公报、命令、函、复函、批复、说明、方案、纪要、公告、公示、通报、制度、规定、办法、细则、操作规程、工作要点、总结、调研、讲话、致辞、主持词、述职、可研、审查材料、技术需求、新闻消息、编者按、新闻评论,以及采购、整改、反馈和 AI 算力等场景。

source

Keep exploring AgentHub

Most people compare similar tools or check scenario guides before installing—start here.

Listing badge: put AgentHub on your site

Copy either snippet into your project homepage, docs, or GitHub README. The badge is a hotlinked SVG — nothing to host — and it links back to this page so visitors can find the install steps.

PreviewListed on AgentHub: UniFi Gateway
HTML
<a href="https://myagenthub.cn/p/io.github.pete-builds/unifi" title="Listed on AgentHub: UniFi Gateway" target="_blank" rel="noopener">
  <img src="https://myagenthub.cn/badge/io.github.pete-builds/unifi?lang=en" alt="Listed on AgentHub: UniFi Gateway" height="20" style="border:0"/>
</a>
Markdown (GitHub README)
[![Listed on AgentHub: UniFi Gateway](https://myagenthub.cn/badge/io.github.pete-builds/unifi?lang=en)](https://myagenthub.cn/p/io.github.pete-builds/unifi)

Badges are generated on the fly from /badge/<package-id>, so name and listing changes propagate automatically. Keep the link target unchanged — it is what counts as the referral.

Unified Manifest

{
  "id": "io.github.pete-builds/unifi",
  "type": "mcp-server",
  "version": "0.29.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.29.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. Set to false to manage a real gateway, which then needs UNIFI_HOST plus UNIFI_API_KEY (or UNIFI_API_KEY_FILE), or MCP_UNIFI_CONTROLLERS_FILE. In either mode the HTTP transport will not start without MCP_UNIFI_AUTH_TOKENS."
          },
          {
            "name": "MCP_UNIFI_AUTH_TOKENS",
            "description": "Bearer tokens that HTTP clients must present. Required: the streamable-http transport exits at startup with 'HTTP transport requires MCP_UNIFI_AUTH_TOKENS' when it is empty. Comma-separated; each entry is a bare token (named client-N automatically) or a 'name:token' pair. Generate one with `openssl rand -hex 32`.",
            "isRequired": true,
            "isSecret": true
          },
          {
            "name": "MCP_UNIFI_READONLY",
            "description": "When true, every tool that changes state is hidden from tools/list and refused on tools/call; read tools are unaffected. Defense in depth on top of a read-only UniFi API key. Defaults to false."
          },
          {
            "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, unless UNIFI_API_KEY_FILE is used instead.",
            "isSecret": true
          },
          {
            "name": "UNIFI_API_KEY_FILE",
            "description": "Path to a file inside the container that holds the local API key, for a Docker or Kubernetes secret mount. Wins over UNIFI_API_KEY when both are set. A controller configured this way verifies the gateway's TLS certificate unless UNIFI_VERIFY_SSL is set to false."
          },
          {
            "name": "UNIFI_PINNED_CERT",
            "description": "Path to a file inside the container that holds the gateway's own certificate in PEM, recorded with mcp-unifi-pin-cert. When set, that certificate is the only one the server accepts from the gateway, and a mismatch fails every request. Do not set UNIFI_VERIFY_SSL to false alongside it: the server refuses to start."
          },
          {
            "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"
  }
}
UniFi Gateway MCP Setup & Guide - AgentHub