A Model Context Protocol (MCP) server that integrates the UI.com Site Manager API with Claude Desktop, providing comprehensive access to UniFi network management through natural language.

• Host Management: List and retrieve detailed information about UniFi hosts
• Site Management: Access all sites running UniFi Network applications
• Device Management: Monitor and manage UniFi devices across your network
• ISP Metrics: Retrieve performance metrics with customizable time ranges
• SD-WAN Management: Configure and monitor SD-WAN deployments

• 12 MCP Tools covering all API endpoints
• 4 MCP Resources for direct data access
• Natural Language Interface through Claude Desktop
• Pagination Support for large datasets
• Error Handling with comprehensive logging

• Python 3.8+
• UniFi Site Manager API key
• Claude Desktop (for MCP integration)

1. Clone the repository

   git clone https://github.com/your-username/Unimcp.git
   cd Unimcp

2. Set up virtual environment

   python3 -m venv .venv
   source .venv/bin/activate  # On Windows: .venv\Scripts\activate
   pip install -r requirements.txt

3. Configure environment variables

   cp .env.example .env
   # Edit .env and add your UniFi API key

4. Run the server

   ./start_server.sh  # On Windows: start_server.bat

Add this configuration to your Claude Desktop config file:

{
  "mcpServers": {
    "unifi": {
      "command": "python3",
      "args": ["/path/to/Unimcp/main.py"],
      "env": {
        "UNIFI_API_KEY": "your_api_key_here"
      }
    }
  }
}

• 📋 API Reference - Complete API documentation
• ⚙️ Configuration Guide - Setup and configuration
• 🐳 Docker Deployment - Container deployment
• 🔧 Troubleshooting - Common issues and solutions

• list_hosts - List all hosts associated with your UI account
• get_host_by_id - Get detailed information about a specific host

• list_sites - List all sites from hosts running UniFi Network applications

• list_devices - List UniFi devices with filtering and pagination support

• get_isp_metrics - Retrieve ISP performance metrics (5m/1h intervals)
• query_isp_metrics - Query metrics with custom parameters

• list_sdwan_configs - List all SD-WAN configurations
• get_sdwan_config_by_id - Get detailed SD-WAN configuration
• get_sdwan_config_status - Check SD-WAN configuration status

• get_sites - Legacy method for listing sites
• get_devices - Legacy method for listing devices
• get_clients - Legacy method (deprecated - not available in Site Manager API)

This implementation provides 100% coverage of the UI.com Site Manager API v1.0 endpoints:

Run with Docker Compose:

docker-compose up -d

Or build and run manually:

docker build -t unifi-mcp-server .
docker run -p 8000:8000 -e UNIFI_API_KEY=your_key unifi-mcp-server

1. Log in to your UniFi console
2. Navigate to Settings → Control Plane → Integrations
3. Click "Create API Key"
4. Save the generated key securely

"Show me all my UniFi hosts"
"Get ISP metrics for the last 24 hours"
"List all devices with their status"
"Show SD-WAN configuration details for config_123"

# List hosts
curl -X GET "http://localhost:8000/mcp/tools/list_hosts" \
  -H "Content-Type: application/json" \
  -d "{}"

# Get ISP metrics
curl -X GET "http://localhost:8000/mcp/tools/get_isp_metrics" \
  -H "Content-Type: application/json" \
  -d '{"metric_type": "5m", "duration": "24h"}'

Run the API coverage test:

source .venv/bin/activate
python3 test_unifi_client.py

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests for new functionality
5. Submit a pull request

This project is licensed under the MIT License - see the LICENSE file for details.

• UI.com Site Manager API Documentation
• Model Context Protocol
• Claude Desktop

• 📖 Documentation
• 🐛 Issue Tracker
• 💬 Discussions