Unifi Network MCP 96a06b7e

MCP开发工具

提供方 ryanbehan

开发工具 未标注 API Key 社区 / 第三方 ClaudeCursorWindsurf

UniFi Network MCP是一个为UniFi Network应用程序提供只读数据检索的工具,支持TypeScript库、CLI和MCP服务器,适用于LLM客户端。

一句话选型结论

按资料字段整理

Unifi Network MCP 96a06b7e 属于开发工具类 MCP 服务器,传输方式未标注,API Key,可直接接入 Claude、Cursor、Windsurf,没有现成安装命令,需按官方文档接入。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类开发工具 传输方式未标注 鉴权API Key 部署方式未标注
GitHub 星标 1 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

开发工具
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

网络管理TypeScript本地部署数据检索CLI工具MCP服务器

安装与配置

未标注 API Key
上游未给出传输方式
  1. 1
    准备运行环境

    按官方文档确认运行环境(常见为 Node.js 或 Python),装好后再执行安装命令。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
代码与仓库操作

在对话里直接查代码、提 issue、走 PR,省掉来回切工具。

本地命令与脚本

把构建、测试、格式化这类重复命令交给模型执行。

接口联调与测试

让模型调你的接口、跑一遍用例,快速定位问题。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 已适配 Claude、Cursor、Windsurf,换客户端不用重新研究配置。

先想清楚的地方

  • 没有现成安装命令,需要按官方文档自己填启动命令和参数。
  • 使用前要准备好API Key对应的凭据,并按最小权限配置。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在开发工具场景里让模型直接调用外部能力的人。
  • 已经在用 Claude、Cursor 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Unifi Network MCP 96a06b7e当前 未标注 未标注 未标注 无 2026-05-17
Git 838e2ec1 12 stdio · 本地进程 本地部署 有 2026-05-17
Markitdown MCP 2c653a5f 1 stdio · 本地进程 本地部署 有 2026-05-17
JavaGuide 未标注 stdio · 本地进程 本地部署 有 2026-04-11
awesome-claude-skills 未标注 stdio · 本地进程 本地部署 有 2026-04-26
Context7 831acf40 未标注 stdio · 本地进程 本地部署 有 2026-05-17

服务器档案

开发工具
字段来自项目仓库与公开索引,中文说明由本站标注
提供方ryanbehan上游标注的维护方 ryanbehan
分类开发工具本站按上游分类展示
连接方式未标注上游未给出传输方式
鉴权方式API Key远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · 未标注本地安装时用到的包标识与运行时
部署类型未标注上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

12.2 KB
来自项目仓库与上游目录的原文,未做删改

UniFi Network MCP

Read-only data retriever for the UniFi Network application (UniFi OS and classic). Provides TypeScript library functions, a CLI, and an MCP server for LLM clients. This repo contains the TypeScript source, specs, and per-agent configuration snippets required to self-host the MCP.

Features

  • Multiple controller targets with independent auth, TLS, timeouts, and rate limits.
  • Auth flows: UniFi OS via POST /api/auth/login and classic via POST /api/login.
  • Routing: UniFi OS under /proxy/network/api/..., classic under /api/....
  • Network Integration API (API key) support:
  • GET /integration/v1/info → get_sysinfo
  • GET /integration/v1/sites → list_sites
  • GET /integration/v1/sites/{siteId}/devices → get_devices
  • GET /integration/v1/sites/{siteId}/clients → get_clients

  • Read-only only. No mutations.

> Scope note: When connecting with an API key generated from the UniFi Network Integrations UI, only the Integration API endpoints listed above are guaranteed to work on UniFi Dream Machine / UniFi OS controllers. Endpoints such as stat/health, stat/event, and stat/report require username/password authentication and are not available to Integration API keys.

Prerequisites

  • Node.js 20+
  • npm 10+
  • A UniFi Network controller (UDM/UDR/UXG or UniFi OS gateway)
  • An Integration API key generated from UniFi Network → Settings → System → Integrations
  • git and a POSIX shell (macOS/Linux)

Configure & Build

  1. Clone and install:bash git clone https://github.com/ryanbehan/unifi-network-mcp.git cd unifi-network-mcp/servers/unifi-network-mcp npm install
  2. Export UNIFI_TARGETS (single or multiple controllers). Example:bash export UNIFI_TARGETS='[ { "id": "home", "base_url": "https://<unifi_host>", "controller_type": "unifi_os", "default_site": "default", "auth": { "apiKey": "UNIFI_API_KEY", "headerName": "X-API-KEY" }, "verify_ssl": false, "timeout_ms": 20000, "rate_limit_per_sec": 5 } ]'

Key fields:

  • id: Friendly name for this UniFi target (e.g. home, lab). Use this id as targetId in MCP tool calls when you have more than one controller.
  • base_url: The base URL of your UniFi controller (e.g. https://). This is the same URL you use to access the UniFi Network UI.
  • auth.apiKey: UNIFI_API_KEY obtained from UniFi Network → Settings → System → Integrations for the Network Application.
  • default_site: Default site to use when a tool call does not specify site. Often Default; if your controller uses a different site name, check the Integration API Sites endpoint in the Network App.

Multiple targets are supported:bash export UNIFI_TARGETS='[ { "id": "home", "base_url": "https://<unifi_host_home>", "controller_type": "unifi_os", "default_site": "Default", "auth": { "apiKey": "UNIFI_API_KEY_HOME", "headerName": "X-API-KEY" }, "verify_ssl": false, "timeout_ms": 20000, "rate_limit_per_sec": 5 }, { "id": "lab", "base_url": "https://<unifi_host_lab>", "controller_type": "unifi_os", "default_site": "Default", "auth": { "apiKey": "UNIFI_API_KEY_LAB", "headerName": "X-API-KEY" }, "verify_ssl": false, "timeout_ms": 20000, "rate_limit_per_sec": 5 } ]'

  • When one target is configured, MCP tools can omit targetId and will automatically use that single target.
  • When multiple targets are configured, pass targetId (e.g. home or lab) in the MCP tool arguments so the server knows which controller to use.

Example tool calls (multi-target):
- List sites on home (default site):
- Conceptual args: { "targetId": "home" }
- Get devices from lab / Default site:
- Conceptual args: { "targetId": "lab", "site": "Default" }
- With Codex CLI, for example:bash codex exec "call get_devices with targetId lab and site Default" --skip-git-repo-check

  1. Build once (emits dist/ artifacts shared by every tool below):bash npm run build

Quick Install from Release```bash

curl -L https://github.com/ryanbehan/unifi-network-mcp/releases/download/v0.1.0/unifi-network-mcp-v0.1.0.tar.gz | tar -xz -C ~/.local/share/
cd ~/.local/share/unifi-network-mcp
cp .env.example .env

Edit .env with your UNIFI_TARGETS


## Common runtime command

All quickstarts use the same launch script, which validates `UNIFI_TARGETS`, builds on demand, and starts the MCP on STDIO:```bash
cd /path/to/unifi-network-mcp
./run-mcp.sh

Leave this process running while your IDE/CLI talks to the MCP.

Tool-specific quickstarts

Windsurf / Cascade (npx)

  1. In Windsurf: Plugins → Model Context Protocol → Add MCP Server → Local Command.
  2. Command: npx
  3. Arguments: -y unifi-network-mcp
  4. Add env var UNIFI_TARGETS in the dialog (paste the JSON string) if not globally exported:[{"id":"home","base_url":"https://<unifi_host>","controller_type":"unifi_os","default_site":"Default","auth":{"apiKey":"UNIFI_API_KEY","headerName":"X-API-KEY"},"verify_ssl":false,"timeout_ms":20000,"rate_limit_per_sec":5}]
  5. Save; Windsurf will fetch the MCP from npm automatically and expose the tools under My MCP Servers.

Cursor (npx)

  1. Create/update .cursor/mcp.config.json in your repo:json { "servers": [ { "name": "unifi-network", "command": "npx", "args": ["-y", "unifi-network-mcp"], "env": { "UNIFI_TARGETS": "[{\"id\":\"home\",\"base_url\":\"https://<unifi_host>\",\"controller_type\":\"unifi_os\",\"default_site\":\"Default\",\"auth\":{\"apiKey\":\"UNIFI_API_KEY\",\"headerName\":\"X-API-KEY\"},\"verify_ssl\":false,\"timeout_ms\":20000,\"rate_limit_per_sec\":5}]" } } ] }
  2. Reload Cursor (Cmd+Shift+P → "Reload Window"). Cursor will npx the MCP whenever needed.

Codex (npx-based install)

  1. Add this block to ~/.codex/config.toml:toml [mcp_servers.unifi-network-mcp] command = "npx" args = ["-y", "unifi-network-mcp"] [mcp_servers.unifi-network-mcp.env] UNIFI_TARGETS = '[{"id":"home","base_url":"https://<unifi_host>","controller_type":"unifi_os","default_site":"Default","auth":{"apiKey":"UNIFI_API_KEY","headerName":"X-API-KEY"},"verify_ssl":false,"timeout_ms":20000,"rate_limit_per_sec":5}]'
    Tip: replace `` and any controller metadata with your own values. Codex will download + cache the MCP automatically on first launch.
  2. From any repo, run codex exec list_sites --skip-git-repo-check to confirm connectivity.

Gemini CLI (npx)

  1. Install the Google gemini CLI (Early Access) and enable MCP support.
  2. Create ~/.gemini/mcp.yaml:```yaml
    servers:
    • name: unifi-network
      command: npx
      args:
      • -y
      • unifi-network-mcp
        env:
        UNIFI_TARGETS: "[{\"id\":\"home\",\"base_url\":\"https://<unifi_host>\",\"controller_type\":\"unifi_os\",\"default_site\":\"Default\",\"auth\":{\"apiKey\":\"UNIFI_API_KEY\",\"headerName\":\"X-API-KEY\"},\"verify_ssl\":false,\"timeout_ms\":20000,\"rate_limit_per_sec\":5}]"
        ```
  3. Run gemini mcp servers list to confirm, then gemini chat --use-mcp unifi-network.

Amazon Q CLI (npx)

  1. Install the Amazon Q developer preview CLI.
  2. Edit ~/.aws/amazonq/mcp.json:json { &quot;servers&quot;: [ { &quot;name&quot;: &quot;unifi-network&quot;, &quot;command&quot;: &quot;npx&quot;, &quot;args&quot;: [&quot;-y&quot;, &quot;unifi-network-mcp&quot;], &quot;env&quot;: { &quot;UNIFI_TARGETS&quot;: &quot;[{\&quot;id\&quot;:\&quot;home\&quot;,\&quot;base_url\&quot;:\&quot;https://&lt;unifi_host&gt;\&quot;,\&quot;controller_type\&quot;:\&quot;unifi_os\&quot;,\&quot;default_site\&quot;:\&quot;Default\&quot;,\&quot;auth\&quot;:{\&quot;apiKey\&quot;:\&quot;UNIFI_API_KEY\&quot;,\&quot;headerName\&quot;:\&quot;X-API-KEY\&quot;},\&quot;verify_ssl\&quot;:false,\&quot;timeout_ms\&quot;:20000,\&quot;rate_limit_per_sec\&quot;:5}]&quot; } } ] }
  3. Launch Q CLI with amazon-q chat --mcp unifi-network.

Opencode

  1. Create or edit ~/.config/opencode/opencode.json:json { &quot;$schema&quot;: &quot;https://opencode.ai/config.json&quot;, &quot;mcp&quot;: { &quot;unifi-network-mcp&quot;: { &quot;type&quot;: &quot;local&quot;, &quot;command&quot;: [&quot;npx&quot;, &quot;-y&quot;, &quot;unifi-network-mcp&quot;], &quot;enabled&quot;: true, &quot;environment&quot;: { &quot;UNIFI_TARGETS&quot;: &quot;[{\&quot;id\&quot;:\&quot;home\&quot;,\&quot;base_url\&quot;:\&quot;https://&lt;unifi_host&gt;\&quot;,\&quot;controller_type\&quot;:\&quot;unifi_os\&quot;,\&quot;default_site\&quot;:\&quot;Default\&quot;,\&quot;auth\&quot;:{\&quot;apiKey\&quot;:\&quot;UNIFI_API_KEY\&quot;,\&quot;headerName\&quot;:\&quot;X-API-KEY\&quot;},\&quot;verify_ssl\&quot;:false,\&quot;timeout_ms\&quot;:20000,\&quot;rate_limit_per_sec\&quot;:5}]&quot; } } } }
  2. Restart Opencode or reload configuration; the unifi-network-mcp server will be available in chats.

Claude Code (Anthropic VS Code extension)

  1. Open VS Code Settings (JSON) (Command Palette → "Preferences: Open Settings (JSON)").
  2. Add or merge the following under the claude.mcpServers key:json &quot;claude.mcpServers&quot;: { &quot;unifi-network-mcp&quot;: { &quot;command&quot;: &quot;npx&quot;, &quot;args&quot;: [&quot;-y&quot;, &quot;unifi-network-mcp&quot;], &quot;env&quot;: { &quot;UNIFI_TARGETS&quot;: &quot;[{\&quot;id\&quot;:\&quot;home\&quot;,\&quot;base_url\&quot;:\&quot;https://&lt;unifi_host&gt;\&quot;,\&quot;controller_type\&quot;:\&quot;unifi_os\&quot;,\&quot;default_site\&quot;:\&quot;Default\&quot;,\&quot;auth\&quot;:{\&quot;apiKey\&quot;:\&quot;UNIFI_API_KEY\&quot;,\&quot;headerName\&quot;:\&quot;X-API-KEY\&quot;},\&quot;verify_ssl\&quot;:false,\&quot;timeout_ms\&quot;:20000,\&quot;rate_limit_per_sec\&quot;:5}]&quot; } } }
  3. Reload VS Code. Claude Code will launch the MCP via npm; verify with @mcp unifi-network-mcp list_sites in a Claude chat.

For Claude terminal / global config (outside VS Code), add the server to ~/.claude/settings.json:```json
{
"mcpServers": {
"unifi-network-mcp": {
"command": "npx",
"args": ["-y", "unifi-network-mcp"],
"env": {
"UNIFI_TARGETS": "[{\"id\":\"home\",\"base_url\":\"https://<unifi_host>\",\"controller_type\":\"unifi_os\",\"default_site\":\"Default\",\"auth\":{\"apiKey\":\"UNIFI_API_KEY\",\"headerName\":\"X-API-KEY\"},\"verify_ssl\":false,\"timeout_ms\":20000,\"rate_limit_per_sec\":5}]"
}
}
}
}


After saving, restart Claude terminal or Desktop; the `unifi-network-mcp` server will be available there as well.

### GitHub Copilot Chat (npx)
You can extend GitHub Copilot Chat with this MCP by adding a local server configuration in the same format documented by GitHub:

- **Per-repository (recommended)**: create a `.vscode/mcp.json` file in the root of your repo.
- **Global for VS Code**: add the same JSON to your user `settings.json` under Copilot&#x27;s MCP configuration (see GitHub docs for exact key names).

Example `mcp.json` contents for this server:```json
{
  &quot;servers&quot;: {
    &quot;unifi-network-mcp&quot;: {
      &quot;command&quot;: &quot;npx&quot;,
      &quot;args&quot;: [&quot;-y&quot;, &quot;unifi-network-mcp&quot;],
      &quot;env&quot;: {
        &quot;UNIFI_TARGETS&quot;: &quot;[{\&quot;id\&quot;:\&quot;home\&quot;,\&quot;base_url\&quot;:\&quot;https://&lt;unifi_host&gt;\&quot;,\&quot;controller_type\&quot;:\&quot;unifi_os\&quot;,\&quot;default_site\&quot;:\&quot;Default\&quot;,\&quot;auth\&quot;:{\&quot;apiKey\&quot;:\&quot;UNIFI_API_KEY\&quot;,\&quot;headerName\&quot;:\&quot;X-API-KEY\&quot;},\&quot;verify_ssl\&quot;:false,\&quot;timeout_ms\&quot;:20000,\&quot;rate_limit_per_sec\&quot;:5}]&quot;
      }
    }
  }
}

Verifying

  • npm run test:env calls list_sites against every configured target and fails fast on TLS/auth errors.
  • Individual tool smoke tests:bash codex exec get_sysinfo --skip-git-repo-check

Distribution options

To share a prebuilt MCP without requiring every consumer to run npm install:
1. GitHub release artifacts
- Run npm run build to populate dist/.
- Package dist/, node_modules/, run-mcp.sh, and package.json into unifi-network-mcp-.tar.gz.
- Publish on GitHub Releases so others can download, set UNIFI_TARGETS, and run ./run-mcp.sh without compiling TypeScript.
2. GitHub Pages / raw static hosting
- Commit the tarball to a releases/ branch and serve via GitHub Pages for simple curl | tar installs.
3. Homebrew-style tap (optional)
- Create a formula that downloads the release tarball, verifies checksum, and places a wrapper script in /usr/local/bin.
4. Container image (if runtime isolation is desired)
- Build a minimal Node 20 image with dist/ copied in, expose STDIO via docker run --entrypoint ./run-mcp.sh ....

Each approach keeps the project free to distribute (only prebuilt JS + shell script) while letting downstream users skip the TypeScript toolchain.

Repository

  • GitHub: https://github.com/ryanbehan/unifi-network-mcp
  • Latest Release: https://github.com/ryanbehan/unifi-network-mcp/releases/latest

常见问题

6 问
答案由本站依据条目字段整理,不引用上游原文
Unifi Network MCP 96a06b7e 怎么安装?

资料没有给出安装命令,请到官方仓库或文档按说明接入;这类条目多数是生态应用,或尚未发布可安装包。

Unifi Network MCP 96a06b7e 怎么在 Claude、Cursor、Windsurf 里配置?

它的传输方式未标注,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

Unifi Network MCP 96a06b7e 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Unifi Network MCP 96a06b7e 需要 API Key 吗?

资料标注需要API Key认证,使用前准备好对应凭据,并按最小权限配置。

Unifi Network MCP 96a06b7e 支持哪些客户端?

资料标注支持 Claude、Cursor、Windsurf;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

Unifi Network MCP 96a06b7e 能提供哪些能力?

资料显示能力标签包括 网络管理、命令行工具、TypeScript、Claude、数据检索。具体工具清单以官方文档为准。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。