AgentHubAgentHub

UniFi Site Manager and Network (unof… MCP Setup & Guide

MCP ServerMCP RegistryOfficial

io.github.mguttmann/the-real-unifi-mcp · v0.4.0

Unofficial MCP server for the UniFi Site Manager and Network cloud APIs, with a write-confirm guard.

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

Overview

Unofficial MCP server for the UniFi Site Manager and Network cloud APIs, with a write-confirm guard. UniFi Site Manager and Network (unofficial) is a MCP Server listed from MCP Registry. Transports: stdio. 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-10-31
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
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": {
    "the-real-unifi-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "the-real-unifi-mcp"
      ],
      "env": {
        "UNIFI_API_KEY": "<UNIFI_API_KEY>"
      }
    }
  }
}

Setup tutorial

  1. Open the UniFi Site Manager and Network (unofficial) 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 the-real-unifi-mcp --env UNIFI_API_KEY=<UNIFI_API_KEY> -- npx -y the-real-unifi-mcp

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": {
    "the-real-unifi-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "the-real-unifi-mcp"
      ],
      "env": {
        "UNIFI_API_KEY": "<UNIFI_API_KEY>"
      }
    }
  }
}

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": {
    "the-real-unifi-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "the-real-unifi-mcp"
      ],
      "env": {
        "UNIFI_API_KEY": "<UNIFI_API_KEY>"
      }
    }
  }
}

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": {
    "the-real-unifi-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "the-real-unifi-mcp"
      ],
      "env": {
        "UNIFI_API_KEY": "<UNIFI_API_KEY>"
      }
    }
  }
}

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": {
    "the-real-unifi-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "the-real-unifi-mcp"
      ],
      "env": {
        "UNIFI_API_KEY": "<UNIFI_API_KEY>"
      }
    }
  }
}

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": {
    "the-real-unifi-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "the-real-unifi-mcp"
      ],
      "env": {
        "UNIFI_API_KEY": "<UNIFI_API_KEY>"
      }
    }
  }
}

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": {
    "the-real-unifi-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "the-real-unifi-mcp"
      ],
      "env": {
        "UNIFI_API_KEY": "<UNIFI_API_KEY>"
      }
    }
  }
}

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": {
    "the-real-unifi-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "the-real-unifi-mcp"
      ],
      "env": {
        "UNIFI_API_KEY": "<UNIFI_API_KEY>"
      }
    }
  }
}

Cline — MCP Servers (local)

  1. Cline panel → Settings → MCP Servers
  2. Click Copy config and merge
  3. Replace <placeholders> in env, then save
{
  "mcpServers": {
    "the-real-unifi-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "the-real-unifi-mcp"
      ],
      "env": {
        "UNIFI_API_KEY": "<UNIFI_API_KEY>"
      }
    }
  }
}

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": {
    "the-real-unifi-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "the-real-unifi-mcp"
      ],
      "env": {
        "UNIFI_API_KEY": "<UNIFI_API_KEY>"
      }
    }
  }
}

Troubleshooting & Common ErrorsFAQ

Common connection errors and verified fixes for UniFi Site Manager and Network (unofficial)

Getting 'connection closed' or exit code 1 in Cursor / Claude Code for UniFi Site Manager and Network (unofficial)?

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 Site Manager and Network (unofficial) requires environment variables (UNIFI_API_KEY). 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": {
    "UNIFI_API_KEY": "your_actual_key_here"
  }
}

Tool Mock Playground

Sandbox

UniFi Site Manager and Network (unofficial) Tool Interface Simulation · Preview tool schema & outputs without local runtime

Sandbox Ready
fn: the_real_unifi_mcpExecute the core tool interface of UniFi Site Manager and Network (unofficial)
Request ArgumentsJSON Schema
{
  "target": "UniFi Site Manager and Network (unofficial)",
  "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 Site Manager and Network (unofficial) + 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

中文公文写作

v2.0.46

SkillClawHub7210.6k

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 Site Manager and Network (unofficial)
HTML
<a href="https://myagenthub.cn/p/io.github.mguttmann/the-real-unifi-mcp" title="Listed on AgentHub: UniFi Site Manager and Network (unofficial)" target="_blank" rel="noopener">
  <img src="https://myagenthub.cn/badge/io.github.mguttmann/the-real-unifi-mcp?lang=en" alt="Listed on AgentHub: UniFi Site Manager and Network (unofficial)" height="20" style="border:0"/>
</a>
Markdown (GitHub README)
[![Listed on AgentHub: UniFi Site Manager and Network (unofficial)](https://myagenthub.cn/badge/io.github.mguttmann/the-real-unifi-mcp?lang=en)](https://myagenthub.cn/p/io.github.mguttmann/the-real-unifi-mcp)

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.mguttmann/the-real-unifi-mcp",
  "type": "mcp-server",
  "version": "0.4.0",
  "displayName": "UniFi Site Manager and Network (unofficial)",
  "description": "Unofficial MCP server for the UniFi Site Manager and Network cloud APIs, with a write-confirm guard.",
  "repository": {
    "url": "https://github.com/mguttmann/the-real-unifi-mcp",
    "source": "github"
  },
  "homepage": "https://github.com/mguttmann/the-real-unifi-mcp#readme",
  "distribution": {
    "packages": [
      {
        "registryType": "npm",
        "identifier": "the-real-unifi-mcp",
        "version": "0.4.0",
        "runtimeHint": "npx",
        "transport": "stdio",
        "environmentVariables": [
          {
            "name": "UNIFI_API_KEY",
            "description": "UniFi Site Manager API key with Network scope (unifi.ui.com, Settings > API). It controls your whole network: treat it like an admin password.",
            "isRequired": true,
            "isSecret": true
          },
          {
            "name": "UNIFI_CONFIRM_WRITES",
            "description": "Write confirmation: destructive tools return a preview and run only when called again with confirm \"YES\". Only false, 0, no or off turn it off."
          },
          {
            "name": "UNIFI_API_BASE",
            "description": "API base URL; this host receives the API key. https origin only (http only for loopback test stubs). Keep the default."
          },
          {
            "name": "UNIFI_TIMEOUT_MS",
            "description": "Per-request timeout in milliseconds, covering response headers and body."
          },
          {
            "name": "UNIFI_LOG_LEVEL",
            "description": "Log level on stderr: debug, info, warn or error."
          },
          {
            "name": "UNIFI_CONSOLE_ID",
            "description": "Pins the UniFi console instead of discovering it (needed when the account has several consoles)."
          },
          {
            "name": "UNIFI_NETWORK_SITE_ID",
            "description": "Pins the Network site instead of discovering it."
          },
          {
            "name": "UNIFI_SITE_MANAGER_SITE_ID",
            "description": "Pins the Site Manager site instead of discovering it."
          },
          {
            "name": "UNIFI_READ_ONLY",
            "description": "Read-only mode: every write tool returns an error and sends no request; reads still work. Off by default."
          },
          {
            "name": "UNIFI_REDACT_SECRETS",
            "description": "Masks passwords, WiFi passphrases, pre-shared keys and other secret fields in every tool result with (redacted); write tools refuse a body that contains that placeholder. Off by default."
          },
          {
            "name": "UNIFI_MAX_RESULT_BYTES",
            "description": "Cuts tool results longer than this many bytes and marks them as truncated. Unset or empty: 100000. 0, off or none: no cap."
          }
        ]
      },
      {
        "registryType": "mcpb",
        "identifier": "https://github.com/mguttmann/the-real-unifi-mcp/releases/download/v0.4.0/the-real-unifi-mcp-0.4.0.mcpb",
        "version": "0.4.0",
        "transport": "stdio"
      }
    ],
    "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.mguttmann/the-real-unifi-mcp",
    "originalUrl": "https://registry.modelcontextprotocol.io/v0.1/servers/io.github.mguttmann%2Fthe-real-unifi-mcp/versions/latest",
    "isOfficial": true,
    "status": "active"
  }
}
UniFi Site Manager and Network (unof… MCP Setup - AgentHub