内容
# MCP Server UniFi
一个用于通过 MCP（Management Control Protocol）管理和控制 UniFi 网络设备的服务器实现。该服务器通过包装 UniFi Network API，可以使用像 Goose 和 Claude 这样的 AI 代理与您的 UniFi 网络进行自然语言交互。
## Features
- 使用 AI 代理通过自然语言查询 UniFi 站点和设备
- 连接到您的 UniFi Network 应用程序的本地服务器实现
- 兼容 Goose AI 和 Claude Desktop
- 安全的基于 API 密钥的身份验证
## Prerequisites
- Python 3.8 或更高版本
- `uv` 包管理器
- UniFi Network 应用程序
- UniFi API 密钥（从 UniFi 控制台获得）
## Setup
1. 创建一个 API 密钥：
- 转到您的 UniFi 控制台 https://unifi.ui.com
- 导航到 Settings » Control Plane » Integrations
- 点击 "Create API Key"
2. 克隆并设置存储库：
```bash
git clone https://github.com/zcking/mcp-server-unifi
cd mcp-server-unifi
uv venv
source .venv/bin/activate # On Unix/macOS
# or
.venv\Scripts\activate # On Windows
```
3. 安装依赖项：
```bash
uv sync
```
4. 配置环境变量：
```bash
export UNIFI_API_KEY="your_api_key_here"
```
## Running the Server
启动 MCP 开发服务器：
```bash
uv run mcp dev main.py
```
MCP Inspector 将在 http://localhost:5173 上提供，用于测试和调试。
## AI Agent Integration
### Goose AI Setup
1. 打开 Goose 并转到 Settings » Extensions » Add custom extension
2. 配置扩展：
- ID: unifi
- Name: unifi
- Description: 获取有关您的 UniFi 网络的信息
- Command: `/Users/username/.local/bin/uv --directory /path/to/mcp-server-unifi run main.py`
- Environment Variables: 将 UNIFI_API_KEY 设置为您的 API 密钥
### Claude Desktop Setup
1. 打开 Claude 并转到 Settings » Developer » Edit Config
2. 添加到您的 `claude_desktop_config.json`：
```json
{
"mcpServers": {
"unifi": {
"command": "/Users/username/.local/bin/uv",
"args": [
"--directory",
"/path/to/mcp-server-unifi",
"run",
"main.py"
]
}
}
}
```
