mcp-server-unifi

🚀 UniFi 管理控制协议 (MCP) 服务器

UniFi 管理控制协议 (MCP) 服务器可用于管理和控制 UniFi 网络设备。它通过 MCP（管理控制协议）连接到 UniFi 网络，封装了 UniFi 网络 API，让您能借助 AI 代理（如 Goose 和 Claude）以自然语言与 UniFi 网络进行交互。

🚀 快速开始

本服务器能让您轻松使用自然语言与 UniFi 网络交互，以下是使用前的准备和操作步骤。

✨ 主要特性

• 自然语言交互：可通过 AI 代理使用自然语言查询 UniFi 站点和设备。
• 本地服务器：本地服务器实现，能连接到 UniFi 网络应用程序。
• 多代理兼容：兼容 Goose AI 和 Claude Desktop。
• 安全认证：基于 API 密钥的安全认证机制。

📦 安装指南

先决条件

• Python 3.8 或更高版本
• uv 包管理器
• UniFi 网络应用程序
• UniFi API 密钥（从 UniFi 控制台获得）

安装步骤

1. 创建 API 密钥：

   • 访问您的 UniFi 控制台：https://unifi.ui.com
   • 转到设置 » 控制平面 » 集成
   • 点击“创建 API 密钥”

2. 克隆并设置仓库：

git clone https://github.com/zcking/mcp-server-unifi
cd mcp-server-unifi
uv venv
source .venv/bin/activate  # Unix/macOS 系统
# 或者
.venv\Scripts\activate  # Windows 系统

3. 安装依赖项：

uv sync

4. 配置环境变量：

export UNIFI_API_KEY="your_api_key_here"

💻 使用示例

启动服务器

启动 MCP 开发服务器：

uv run mcp dev main.py

MCP 检查工具将在 http://localhost:5173 可用，用于测试和调试。

AI 代理集成

Goose AI 设置

1. 打开 Goose 并转到设置 » 扩展 » 添加自定义扩展。
2. 配置扩展：
   • ID: unifi
   • 名称: unifi
   • 描述: 获取有关您的 UniFi 网络的信息
   • 命令: /Users/username/.local/bin/uv --directory /path/to/mcp-server-unifi run main.py
   • 环境变量: 设置 UNIFI_API_KEY 为您的 API 密钥

Claude Desktop 设置

1. 打开 Claude 并转到设置 » 开发者 » 编辑配置。
2. 将以下内容添加到 claude_desktop_config.json：

{
    "mcpServers": {
        "unifi": {
            "command": "/Users/username/.local/bin/uv",
            "args": [
                "--directory",
                "/path/to/mcp-server-unifi",
                "run",
                "main.py"
            ]
        }
    }
}