使用说明
UniFi MCP服务器
UniFi网络控制器的MCP服务器-使用自然语言通过AI助手管理您的网络。
特性
25个只读工具 分为4类:
| 类别 | 工具 | 示例 |
|---|---|---|
| 发现 | 8 | 列出设备、客户端、网络、WLAN |
| 安全 | 7 | 防火墙规则、IPS状态、端口转发 |
| 统计信息 | 7 | 网络统计信息、顶级客户端、DPI、警报 |
| 迁移 | 3 | DHCP状态、VLAN连接、配置导出 |
快速开始
1.安装
# Using uvx (recommended)
uvx --from git+https://github.com/MidwestMountaineer/Unifi-MCP-Server.git unifi-mcp-server
# Or pip
pip install git+https://github.com/MidwestMountaineer/Unifi-MCP-Server.git
2.获取API密钥
- 登录你的梦想机器
- 设置 → 系统 → 高级 → API
- 使用创建新的API密钥 只读 权限
- 复制密钥(仅显示一次)
3.配置
添加到您的MCP客户端配置中(例如。, .kiro/settings/mcp.json):
{
"mcpServers": {
"unifi": {
"command": "uvx",
"args": ["--from", "git+https://github.com/MidwestMountaineer/Unifi-MCP-Server.git", "unifi-mcp-server"],
"env": {
"UNIFI_HOST": "192.168.1.1",
"UNIFI_API_KEY": "your-api-key-here",
"UNIFI_VERIFY_SSL": "false"
}
}
}
}
4.测试
问你的AI助手: “列出我的所有UniFi设备”
基洛电力
此回购也是 基洛电力 有指导的工作流程。通过Kiro的“从GitHub添加电源”进行安装:
https://github.com/MidwestMountaineer/Unifi-MCP-Server
看 功率.md 用于工作流文档。
配置
| 变量 | 描述 | 默认值 |
|---|---|---|
UNIFI_HOST |
控制器IP | (必需) |
UNIFI_API_KEY |
API密钥 | (UniFi操作系统必需) |
UNIFI_USERNAME |
用户名 | (适用于传统控制器) |
UNIFI_PASSWORD |
密码 | (适用于传统控制器) |
UNIFI_PORT |
控制器端口 | 443 |
UNIFI_SITE |
站点名称 | default |
UNIFI_VERIFY_SSL |
验证SSL | false |
LOG_LEVEL |
日志冗长 | INFO |
可用工具
发现
unifi_list_devices/unifi_get_device_detailsunifi_list_clients/unifi_get_client_detailsunifi_list_networks/unifi_get_network_detailsunifi_list_wlans/unifi_get_wlan_details
安全
unifi_list_firewall_rules/unifi_get_firewall_rule_detailsunifi_list_traffic_routes/unifi_get_route_detailsunifi_list_port_forwards/unifi_get_port_forward_detailsunifi_get_ips_status
统计
unifi_get_network_stats/unifi_get_system_healthunifi_get_client_stats/unifi_get_device_statsunifi_get_top_clients/unifi_get_dpi_statsunifi_get_alerts
迁移
unifi_get_dhcp_statusunifi_verify_vlan_connectivityunifi_export_configuration
码头工人
docker-compose up -d
看 docs/DOCKER.md 了解详情。
发展
# Clone and install
git clone https://github.com/MidwestMountaineer/Unifi-MCP-Server.git
cd Unifi-MCP-Server
pip install -e ".[dev]"
# Run tests
pytest
# Dev console
python devtools/dev_console.py
故障排除
| 问题 | 解决方案 |
|---|---|
| 连接被拒绝 | 检查 UNIFI_HOST 控制器可达 |
| 401未授权 | 使用正确权限重新生成API密钥 |
| SSL错误 | 设置 UNIFI_VERIFY_SSL=false |
| 空结果 | 检查 UNIFI_SITE 名称,将API密钥升级为完全管理 |
许可证
麻省理工学院-参见 许可证
