Unifi MCP Openapi

MCP运维云端

提供方 bakhshb · 包名 @bakhshb/unifi-mcp

运维云端 stdio · 本地进程 会话登录 社区 / 第三方 Claude
查看接入方式

通过AI控制UniFi网络的工具,支持查询设备、管理WiFi和VLAN、创建网络配置以及监控网络健康。

一句话选型结论

按资料字段整理

Unifi MCP Openapi 属于运维云端类 MCP 服务器,stdio · 本地进程,会话登录,可直接接入 Claude,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类运维云端 传输方式stdio · 本地进程 鉴权会话登录 部署方式本地部署
GitHub 星标 0 仓库热度,无公开仓库时显示未标注
工具数 3 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

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

能力标签

支持客户端

适用场景

网络管理TypeScript本地部署AI控制UniFiAPI工具

安装与配置

stdio · 本地进程 会话登录
客户端在本机拉起子进程,数据不出本机
npx @bakhshb/unifi-mcp

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Node.js,再按安装命令拉取依赖。

  2. 2
    安装服务

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

  3. 3
    写入客户端配置

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

  4. 4
    验证是否可用

    连接成功后客户端会列出约 3 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
云资源查询

查实例、存储、账单等云上资源状态。

部署与发布

把部署、重启、回滚这类操作接进对话。

监控与告警

拉取监控指标,异常时让模型帮你判断。

选择建议

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

值得选的地方

  • 资料标注 3 个工具,职责相对集中,接入后不容易误操作。
  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude,换客户端不用重新研究配置。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好会话登录对应的凭据,并按最小权限配置。
  • 版本更新与行为细节以官方仓库为准。

更适合

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

不太适合

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

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Unifi MCP Openapi当前 3 stdio · 本地进程 本地部署 有 2026-05-17
lobehub 未标注 stdio · 本地进程 本地部署 有 2026-04-11
TrendRadar 未标注 stdio · 本地进程 本地部署 有 2026-04-13
Ui Tars Desktop 8a825770 未标注 stdio · 本地进程 本地部署 有 2026-05-17
ruflo 未标注 stdio · 本地进程 本地部署 有 2026-04-13
FastGPT 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

运维云端
字段来自项目仓库与公开索引,中文说明由本站标注
提供方bakhshb上游标注的维护方 bakhshb
分类运维云端本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式会话登录远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时@bakhshb/unifi-mcp · Node.js本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

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

UniFi MCP服务器

通过AI控制你的UniFi网络。由OpenAPI规范支持的2-tool设计——与 UniFi云API 或 本地梦想机器.

它做什么

  • 查询设备、客户端、网络统计信息
  • 管理WiFi、VLAN、防火墙规则
  • 创建网络配置
  • 监控网络健康状况

快速设置(5分钟)

1.获取UniFi API密钥

  1. 首选 account.ui.com
  2. 登录→ 设置→ API密钥
  3. 创建新密钥→ 复制它

2.使用npx运行(无需安装)```bash

UNIFI_API_TYPE=cloud-ea UNIFI_API_KEY=your-key-here npx @bakhshb/unifi-mcp


或者创建一个 `.env` 文件:```bash
UNIFI_API_TYPE=cloud-ea
UNIFI_API_KEY=your-key-here

然后运行:```bash
npx @bakhshb/unifi-mcp


### 3.连接到Claude/OpenClaw

**开爪** (`~/.openclaw/openclaw.json`):```json
{
"mcp": {
"servers": {
"unifi": {
"command": "npx",
"args": ["@bakhshb/unifi-mcp"],
"env": {
"UNIFI_API_TYPE": "cloud-ea",
"UNIFI_API_KEY": "your-key-here"
}
}
}
}
}

克劳德桌面 (~/Library/Application Support/Claude/claude_desktop_config.json):```json
{
"mcpServers": {
"unifi": {
"command": "npx",
"args": ["@bakhshb/unifi-mcp"],
"env": {
"UNIFI_API_TYPE": "cloud-ea",
"UNIFI_API_KEY": "your-key-here"
}
}
}
}


## 本地Dream机器设置

你的 **本地UniFi控制器** (Dream Machine等)也支持API密钥,就像云API一样。在控制器设置中生成API密钥:

1. 转到您的UniFi控制器→ 设置→ API密钥
1. 为本地访问创建新密钥
1. 使用与cloud相同的env变量,但 `UNIFI_API_TYPE=local````bash
UNIFI_API_TYPE=local
UNIFI_API_KEY=your-local-api-key
UNIFI_LOCAL_HOST=192.168.1.1
UNIFI_LOCAL_VERIFY_SSL=false

或者在openclaw.json中:```json
{
"mcp": {
"servers": {
"unifi": {
"command": "npx",
"args": ["@bakhshb/unifi-mcp"],
"env": {
"UNIFI_API_TYPE": "local",
"UNIFI_API_KEY": "your-local-api-key",
"UNIFI_LOCAL_HOST": "192.168.1.1",
"UNIFI_LOCAL_VERIFY_SSL": "false"
}
}
}
}
}


### 环境变量

|变量|必填|默认|描述|
|----------|----------|---------|-------------|
| `UNIFI_URL` |是|-|您的UniFi控制器URL(例如。, `https://192.168.1.1` 或 `https://api.ui.com` 对于云)|
| `UNIFI_API_KEY` |是\*|-|您的API密钥(*如果不使用用户名/密码,则需要)|
| `UNIFI_USERNAME` |是的* |-|UniFi用户名(*如果不使用API密钥,则需要)|
| `UNIFI_PASSWORD` |是的* |-|UniFi密码(如果不使用API密钥,则需要\*)|
| `UNIFI_SITE_ID` |没有| `default` |您的UniFi站点标识符|
| `UNIFI_TIMEOUT` |没有| `30000` |请求超时(毫秒)|

**注:** 设置其中之一 `UNIFI_API_KEY` 或(`UNIFI_USERNAME` + `UNIFI_PASSWORD`).

**注:** 对于本地模式,您还可以使用会话Cookie(`UNIFI_SESSION_COOKIE` + `UNIFI_CSRF_TOKEN`)而不是API密钥,但API密钥更简单。

### 解释API模式

UniFi MCP支持三种连接模式,通过设置 `UNIFI_API_TYPE`:

|模式|何时使用|需要授权|速率限制|
|------|-------------|---------------|------------|
| `local` |局域网上的Dream Machine/UDM Pro SE | API密钥|无|
| `cloud-v1` |通过Ubiquiti云进行远程管理(稳定)| API密钥| 10000 req/min|
| `cloud-ea` |通过Ubiquiti云进行远程管理(早期访问)| API密钥| 100 req/min|

**`local`** --直接连接到本地网络上的UniFi控制器。完全访问,无外部流量,无速率限制。需要 `UNIFI_LOCAL_HOST`.

**`cloud-v1`** -托管于的稳定云API `api.ui.com`向后兼容,长期支持。更高的速率限制,但仅设置核心功能。

**`cloud-ea`** -早期访问云API `api.ui.com`较新的功能在登陆v1之前,但速率限制较低,可能仍在发展。站点管理器API和一些较新的端点首先住在这里。

**选择哪一个?**

- **家庭实验室/本地网络** → `local` (您的UDM Pro SE)
- **远程管理,生产稳定** → `cloud-v1`
- **远程管理,需要最新功能** → `cloud-ea`

## 命令

### `unifi-api`

执行任何UniFi Integration API调用。示例:

- `unifi-api` 和 `path="/v2/sites"` → 列出所有网站
- `unifi-api` 和 `path="/v1/sites/{siteId}/devices"` 和 `pathParams={siteId:"default"}` → 获取设备
- `unifi-api` 和 `path="/v1/sites/{siteId}/clients"` 和 `pathParams={siteId:"default"}` → 获得客户

### `unifi-api-schema`

发现可用的集成API操作:

- 无参数→ 列出所有标签/操作
- `tag="sites"` → 现场操作
- `path="/v1/sites/{siteId}/devices"` → 该路径的详细信息

### `unifi-legacy-client-stats`

从获取每个客户端的带宽统计数据 **传统控制器API** (`/api/s/{site}/stat/sta`).此端点与Integration API分离,并返回每个客户端的实时tx/rx字节和速率。

**为什么要使用单独的工具?** UniFi OpenAPI规范(beezly/UniFi-apis)未涵盖传统控制器API。它存在于同一控制器上,但使用不同的路径(`/proxy/network/api/s/`)并返回集成API中不可用的带宽数据(tx_bytes,rx_bytes、tx_rate、rx_rate)。

|参数|类型|默认值|说明|
|-----------|------|---------|-------------|
| `site` |字符串| `"default"` |站点名称或ID|

**示例响应:**```json
{
"success": true,
"message": "Legacy client stats: 2 active clients on site 'default'",
"data": {
"count": 2,
"site": "default",
"clients": [
{
"hostname": "iPhone",
"ip": "192.168.1.100",
"mac": "aa:bb:cc:dd:ee:ff",
"network": "Home",
"vlan": 1,
"is_wired": false,
"tx_bytes": 1234567890,
"tx_bytes_formatted": "1.15 GB",
"rx_bytes": 987654321,
"rx_bytes_formatted": "941.8 MB",
"tx_rate_bps": 1500,
"tx_rate_formatted": "1.5 Kbps",
"rx_rate_bps": 800,
"rx_rate_formatted": "800 bps",
"uptime": 3600,
"uptime_formatted": "1h 0m",
"signal": -50,
"essid": "MyWiFi",
"ap_name": "UDM-Pro"
},
{
"hostname": "laptop",
"ip": "192.168.1.50",
"mac": "11:22:33:44:55:66",
"network": "Home",
"vlan": 1,
"is_wired": true,
"tx_bytes": 50000000,
"tx_bytes_formatted": "47.7 MB",
"rx_bytes": 100000000,
"rx_bytes_formatted": "95.4 MB",
"tx_rate_bps": 0,
"tx_rate_formatted": "0 B/s",
"rx_rate_bps": 0,
"rx_rate_formatted": "0 B/s",
"uptime": 7200,
"uptime_formatted": "2h 0m",
"ap_name": "Switch"
}
]
}
}

故障排除

“需要API密钥” → Set UNIFI_API_KEY 在您的环境中

“连接被拒绝” → Check UNIFI_LOCAL_HOST 对于本地模式

SSL错误 → Set UNIFI_LOCAL_VERIFY_SSL=false 本地

建筑

代币节省: 传统的UniFi MCP服务器每次会话的成本约为45000-60000个令牌。对于集成API,2工具+1遗留方法的成本约为500–1500个令牌,对于遗留统计工具-a,成本约为200个令牌 减少约97%.

方法 工具 代币成本 覆盖范围
enuno/unifi mcp服务器 (显式) 148 ~45000–60000 已修复
西尔柯比/unifi mcp (多产品) ~82 ~25000–35000 网络+保护+访问+驱动
此服务器(2-工具+1旧版) 3工具 ~700–1,700 44+集成API操作+遗留统计数据
  • 3工具 而不是148个显式工具→ ~97% 更少的上下文开销
  • 用于集成API的2个通用工具(OpenAPI规范驱动,与API表面动态缩放)
  • 1个用于带宽统计的传统工具(不在OpenAPI规范中,特定于控制器)
  • 灵感源自 @dokploy/mcp (战术发射/dokploy mcp)--第一个演示2工具OpenAPI模式的MCP服务器,在大约500个令牌中涵盖463个Dokloy操作
  • OpenAPI规范来自 beezly/unifi原料药 (其API研究渊源可追溯至 西尔柯比/unifi mcp)

许可证

MIT许可证

常见问题

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

在客户端按下面的安装命令接入:npx @bakhshb/unifi-mcp。对应的包名是 @bakhshb/unifi-mcp。装完在客户端配置里引用同一个包或端点。

Unifi MCP Openapi 怎么在 Claude 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

Unifi MCP Openapi 收费吗?

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

Unifi MCP Openapi 需要 API Key 吗?

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

Unifi MCP Openapi 支持哪些客户端?

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

Unifi MCP Openapi 能提供哪些能力?

资料显示约 3 个工具;能力标签包括 网络管理、AI控制、TypeScript、Claude、API集成。具体工具清单以官方文档为准。

Unifi MCP Openapi 需要什么运行环境?

运行时为 Node.js;属于本地进程,需要在本机装好运行环境。

Unifi MCP Openapi 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

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

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