MCP Unifi Applications

MCP文档知识

提供方 KallistoX

文档知识 stdio · 本地进程 无需鉴权 社区 / 第三方 Claude DesktopClaudeVS Code
查看接入方式

一个MCP服务器,将UniFi应用API文档(网络、保护、站点管理器)转换为可查询的工具,适用于Claude桌面、Claude代码或任何MCP兼容客户端。

一句话选型结论

按资料字段整理

MCP Unifi Applications 属于文档知识类 MCP 服务器,stdio · 本地进程,无需鉴权,可直接接入 Claude Desktop、Claude、VS Code,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

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

工具与能力

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

能力标签

支持客户端

适用场景

API查询Python本地部署文档转换UniFi工具MCP服务器开发辅助

安装与配置

stdio · 本地进程 无需鉴权
客户端在本机拉起子进程,数据不出本机
docker run --rm -v $(pwd)/docs:/output unifi-scraper node scrape.mjs

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

  1. 1
    准备运行环境

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

  2. 2
    安装服务

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

  3. 3
    写入客户端配置

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

  4. 4
    验证是否可用

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

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
文档检索问答

在你的文档库里按问题找答案。

知识库读写

把新资料写进知识库,随用随取。

内容整理

把零散资料归纳成结构化笔记。

选择建议

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

值得选的地方

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

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 版本更新与行为细节以官方仓库为准。

更适合

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

不太适合

  • 完全不想在本地装环境的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
MCP Unifi Applications当前 9 stdio · 本地进程 本地部署 有 2026-05-17
dify 未标注 stdio · 本地进程 本地部署 有 2026-04-11
open-webui 未标注 stdio · 本地进程 本地部署 有 2026-04-11
JeecgBoot 未标注 stdio · 本地进程 本地部署 有 2026-04-11
Cherry Studio 未标注 未标注 未标注 无 2026-05-17
mempalace 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

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

详细介绍

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

MCP UniFi应用程序

一个MCP服务器,它公开 UniFi应用程序API 文档(网络、保护、站点管理器)作为Claude Desktop、Claude Code(VS Code/JetBrains)或任何兼容MCP的客户端的可查询工具。

包括一个基于Playwright的scraper,它将JS渲染的文档SPA转换为结构化的JSON文件,以及一个为它们提供服务的Python MCP服务器。

示例

> “你能告诉我如何使用UniFi的Go with network API创建网络吗?关于托管IPv4 DHCP网关配置,我有哪些选项?”

Claude自动查询MCP服务器-搜索端点、获取模式和深入鉴别器变体-然后用完整的API详细信息和一个有效的Go示例进行响应:

快速开始

1.报废单据

scraper在Docker内部运行(需要Playwright/Chromium):```bash

Build the scraper image

docker build -t unifi-scraper .

Scrape Network API docs (default, latest version)

docker run --rm -v $(pwd)/docs:/output unifi-scraper node scrape.mjs

Scrape Protect API docs

docker run --rm -v $(pwd)/docs:/output unifi-scraper node scrape.mjs --app protect

Scrape Site Manager API docs

docker run --rm -v $(pwd)/docs:/output unifi-scraper node scrape.mjs --app site-manager

Scrape a specific API version

docker run --rm -v $(pwd)/docs:/output unifi-scraper node scrape.mjs --app network --version v9.5.21

List available API versions for an app

docker run --rm unifi-scraper node scrape.mjs --app protect --list-versions

Scrape specific pages only

docker run --rm -v $(pwd)/docs:/output unifi-scraper node scrape.mjs createnetwork filtering

Force re-scrape (overwrite existing files)

docker run --rm -v $(pwd)/docs:/output unifi-scraper node scrape.mjs --force


Network API v10.1.84的预处理文档包含在 `docs/network/`.

### 2.安装MCP服务器```bash
python -m venv .venv
source .venv/bin/activate  # or: source .venv/bin/activate.fish
pip install .

3.向您的客户注册

克劳德代码(VS代码/JetBrains) -添加 .mcp.json 到项目根目录(之后重新加载窗口):```json
{
"mcpServers": {
"unifi-docs": {
"type": "stdio",
"command": "/path/to/mcp-unifi-applications/.venv/bin/python",
"args": ["/path/to/mcp-unifi-applications/mcp_server.py"]
}
}
}


**克劳德桌面** -添加到 `~/.config/Claude/claude_desktop_config.json` (Linux)或 `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS):```json
{
"mcpServers": {
"unifi-docs": {
"command": "/path/to/mcp-unifi-applications/.venv/bin/python",
"args": ["/path/to/mcp-unifi-applications/mcp_server.py"]
}
}
}

支持的应用程序

应用程序 URL 本地/远程 注释
网络 developer.ui.com/network 两者都有 默认应用程序
保护 developer.ui.com/protect 两者
现场经理 developer.ui.com/site-manager 仅远程 无本地/远程开关

这三个应用程序共享相同的文档SPA结构,包括版本下拉菜单、端点页面和指南页面。

可用工具

工具 说明
list_endpoints 列出所有API端点,可选择通过HTTP方法或应用程序进行筛选
search_endpoints 按名称、路径、方法或描述进行模糊搜索(可按应用程序过滤)
get_endpoint 端点的完整模式(摘要或原始JSON)
get_endpoint_group 资源(例如“网络”)的所有CRUD操作
get_example curl、Go、Node.js、Python或Ansible(本地/远程)中的代码示例
get_response_sample 端点的JSON响应示例
find_field 在所有端点架构中搜索字段名
get_field_schema 深入特定字段的子树(例如。 management[GATEWAY].dhcpV4)
get_guide API指南页(筛选语法、错误处理、入门)

返回多个结果的工具接受可选 app 参数(network, protect, site-manager)按应用程序过滤。

环境变量

变量 默认值 描述
DOCS_DIR ./docs (相对于 mcp_server.py) 包含抓取的JSON文档的目录。需要应用程序子目录(network/, protect/, site-manager/).

刮刀CLI```

node scrape.mjs [options] [slug...]

Options:
--app Application: network (default), protect, site-manager.
--version API version to scrape (e.g. v10.1.84). Default: latest.
--list-versions Print available versions and exit.
--force Re-scrape even if output file exists.

Arguments:
[slug...] Scrape only these pages. Omit to scrape all pages.


slug是文档URL的最后一个路径段:
`https://developer.ui.com/network/v10.1.84/createnetwork` -> `createnetwork`

输出被写入 `//` (例如。 `docs/network/`, `docs/protect/`).

完整扫描是可恢复的——已经刮擦的页面将被跳过。使用 `--force` 重新刮。

## 项目结构```
mcp-unifi-applications/
├── scrape.mjs          # Playwright scraper (runs in Docker)
├── mcp_server.py       # MCP server (Python, stdio transport)
├── Dockerfile          # Scraper container image
├── pyproject.toml      # Python project config
├── docs/               # Scraped JSON output
│   ├── network/        # Network API docs
│   ├── protect/        # Protect API docs
│   └── site-manager/   # Site Manager API docs
└── tests/
└── test_mcp_server.py

输出格式

端点页面```json

{
"h1": "Create Network",
"method": "POST",
"path": "/v1/sites/{siteId}/networks",
"description": "Create a new network on a site.",
"pathParameters": [ "...fields" ],
"requestBody": [ "...fields" ],
"responses": [{ "statuses": ["201"], "fields": [ "...fields" ] }],
"examples": {
"local": { "curl": "...", "go": "...", "nodejs": "...", "python": "...", "ansible": "..." },
"remote": { "curl": "...", "go": "...", "nodejs": "...", "python": "...", "ansible": "..." }
},
"responseSample": "{ ... }",
"sourceUrl": "https://developer.ui.com/network/v10.1.84/createnetwork"
}


### 指南页面```json
{
"h1": "Filtering",
"type": "guide",
"content": "Markdown content...",
"sourceUrl": "https://developer.ui.com/network/v10.1.84/filtering"
}

字段对象(递归)```json

{
"name": "management",
"required": true,
"type": "string",
"description": null,
"discriminator": [
{ "value": "UNMANAGED", "selected": true, "schema": [ "...sibling fields" ] },
{ "value": "GATEWAY", "selected": false, "schema": [ "...sibling fields" ] }
],
"children": [ "...child fields for object types" ]
}
```

  • discriminator.schema 包含该选项处于活动状态时可见的兄弟字段(不是鉴别器字段本身)
  • 嵌套是递归的——变体中的鉴别器被完全扩展
  • children 捕获静态扩展的对象字段

免责声明

本项目不隶属于Ubiquiti股份有限公司、由其背书或赞助。本工具抓取和提供的API文档内容归 Ubiquiti股份有限公司。 并且来源于他们的公众 开发者门户.“UniFi”是Ubiquiti股份有限公司的商标。

许可证

麻省理工学院

常见问题

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

在客户端按下面的安装命令接入:docker run --rm -v $(pwd)/docs:/output unifi-scraper node scrape.mjs。装完在客户端配置里引用同一个包或端点。

MCP Unifi Applications 怎么在 Claude Desktop、Claude、VS Code 里配置?

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

MCP Unifi Applications 收费吗?

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

MCP Unifi Applications 需要 API Key 吗?

资料标注为无需认证,装好就能连;如果实际调用时报鉴权错误,按官方文档补上凭据。

MCP Unifi Applications 支持哪些客户端?

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

MCP Unifi Applications 能提供哪些能力?

资料显示约 9 个工具;能力标签包括 开发工具、Python、Claude、文档转换。具体工具清单以官方文档为准。

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

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

MCP Unifi Applications 是本地还是远程?

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

热门专题

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

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