Skip to main content

Ubiquiti UniFi MCP Server — device monitoring, client visibility, firewall state, network security, and network/VLAN management

Project description

ubiquiti-unifi-blade-mcp

An MCP server that gives AI agents structured access to Ubiquiti UniFi network controllers. Built for the Model Context Protocol with security visibility and token efficiency as first-class design goals.

Why this exists

UniFi controllers expose a rich but undocumented REST API behind cookie-based auth with CSRF tokens and optional 2FA. The aiounifi library (MIT, powers the Home Assistant integration) handles the protocol complexity — UniFi OS vs classic controller detection, TOTP 2FA, websocket events. This MCP wraps it with the guardrails that automated agents need:

  • Security-first tool set — 18 tools focused on what network security agents actually need: device health, client visibility, firewall state, traffic rules, DPI restrictions, port forwards. Not 161 tools for every possible configuration change.
  • Token-efficient output — compact pipe-delimited format. A 30-device network in ~50 tokens per device. Client listings with signal strength, experience score, and blocked status at a glance.
  • Write-gated mutations — client blocking, WLAN toggling, device restart, and traffic route changes require explicit opt-in via UNIFI_WRITE_ENABLED=true. Destructive operations (block, restart) additionally require per-call confirm=true.
  • Multi-controller — manage home and office networks from a single MCP instance. Each controller authenticates independently with separate sessions.

How this differs from other UniFi MCPs

ubiquiti-unifi-blade-mcp sirkirby/unifi-mcp enuno/unifi-mcp-server
Focus Monitoring + security + network/VLAN mgmt (23 tools) Full management (161 tools) Full management (74 tools)
Design for LLM agents (token-efficient) Claude Code (lazy loading) General MCP clients
Multi-controller Native (env var config) Single controller Multi-mode (local/cloud)
Write safety Dual-gated (env + confirm) Preview-then-confirm Permission model
2FA support TOTP via aiounifi TOTP support API key option
Output Pipe-delimited, compact Full JSON Full JSON
Marketplace Sidereal certified Claude Code plugin Standalone

Use this blade-MCP for agent-driven monitoring and security. Use sirkirby/unifi-mcp (available as a community listing in the Sidereal marketplace) when you need full network configuration management.

Quick start

# Install
uv pip install -e .

# Configure (monitoring tools — username/password)
export UNIFI_HOST="192.168.1.1"
export UNIFI_USERNAME="admin"
export UNIFI_PASSWORD="your-password"
export UNIFI_VERIFY_SSL="false"  # Common for self-signed certs

# Configure (network/VLAN tools — Integration API key)
# Generate in UniFi Network → Settings → Control Plane → Integrations
export UNIFI_API_KEY="your-x-api-key"

# Run
ubiquiti-unifi-blade-mcp

Authentication: two modes

Mode Env Drives Endpoint
Session UNIFI_USERNAME + UNIFI_PASSWORD (+ optional UNIFI_TOTP_SECRET) Monitoring/security tools (devices, clients, firewall, WLANs, DPI, …) Legacy controller API via aiounifi (cookie/CSRF)
API key UNIFI_API_KEY (X-API-KEY) Network/VLAN tools (unifi_networks, unifi_create_network, …) Official Integration API (/proxy/network/integration/v1) — stateless

Either or both may be set. The network/VLAN tools require the API key (the only path that supports VLAN writes); the monitoring tools require username/password. Generate the API key in UniFi Network → Settings → Control Plane → Integrations. Requires UniFi Network 9.0+ (network/VLAN CRUD confirmed on 10.x).

23 tools, 6 categories

Info & Sites (2 tools)

Tool Purpose Token cost
unifi_info Health check — controller version, hostname, device/client counts, write gate ~60
unifi_sites List sites on the controller ~20/site

Networks & VLANs (2 read tools — require UNIFI_API_KEY)

Tool Purpose Token cost
unifi_networks List networks/VLANs — name, VLAN id, enabled, purpose, subnet ~25/network
unifi_network Full detail — VLAN id, subnet, gateway, purpose ~60

Devices (2 tools)

Tool Purpose Token cost
unifi_devices List APs, switches, gateways — model, state, clients, uptime, firmware ~50/device
unifi_device Full detail — port table with PoE, firmware, upgrade status ~150

Clients (2 tools)

Tool Purpose Token cost
unifi_clients Connected clients — name, IP, SSID, signal, experience, blocked ~40/client
unifi_client Full detail — TX/RX, vendor (OUI), AP association ~120

Firewall & Security (5 tools)

Tool Purpose Token cost
unifi_firewall Firewall policies — name, action, enabled/disabled ~30/policy
unifi_traffic_routes Traffic routes — description, enabled/disabled, target ~25/route
unifi_traffic_rules Traffic rules — description, action, enabled/disabled ~25/rule
unifi_port_forwards Port forwards — name, protocol, external → internal ~30/fwd
unifi_dpi DPI restriction groups and apps ~20/item

Write Operations (10 tools, gated)

Tool Gate Purpose
unifi_block_client write + confirm Block a client from the network
unifi_unblock_client write Unblock a previously blocked client
unifi_reconnect_client write Force a wireless client to reconnect
unifi_toggle_wlan write Enable or disable an SSID
unifi_toggle_traffic_route write Enable or disable a traffic route
unifi_restart_device write + confirm Restart an AP, switch, or gateway
unifi_create_network write + confirm + API key Create a network/VLAN
unifi_update_network write + confirm + API key Update a network/VLAN (supplied fields)
unifi_delete_network write + confirm + API key Delete a network/VLAN

Output format

Office AP | uap | model=U6-Pro | ip=192.168.1.10 | connected | clients=12 | up=10d0h | mac=aa:bb:cc:dd:ee:01
Core Switch | usw | model=USW-Pro-48-PoE | ip=192.168.1.2 | connected | up=30d0h | UPGRADE_AVAILABLE | mac=aa:bb:cc:dd:ee:02
Gateway | ugw | model=UDM-Pro | ip=192.168.1.1 | connected | up=60d0h | mac=aa:bb:cc:dd:ee:03
MacBook Pro | ip=192.168.1.100 | ssid=HomeNet | rssi=-55 | exp=98% | up=12h0m | mac=11:22:33:44:55:01
NAS | ip=192.168.1.50 | wired | exp=100% | up=30d0h | mac=11:22:33:44:55:02
Unknown Device | ip=192.168.1.200 | ssid=IoT-Net | rssi=-72 | exp=65% | BLOCKED | mac=11:22:33:44:55:03

Multi-controller support

export UNIFI_CONTROLLERS="home,office"
export UNIFI_HOME_HOST="192.168.1.1"
export UNIFI_HOME_USERNAME="admin"
export UNIFI_HOME_PASSWORD="home-password"
export UNIFI_OFFICE_HOST="10.0.0.1"
export UNIFI_OFFICE_USERNAME="admin"
export UNIFI_OFFICE_PASSWORD="office-password"

Pass controller="office" to any tool. Omit for the first configured controller.

Security model

Layer Mechanism
Write gate UNIFI_WRITE_ENABLED=true required for any mutation
Destructive confirm unifi_block_client, unifi_restart_device, and all unifi_*_network write tools require confirm=true
Credential scrubbing Passwords, cookies, CSRF tokens, X-API-KEY, session IDs stripped from errors
Controller API key UNIFI_API_KEY (X-API-KEY) — scoped Integration API key for network/VLAN tools
HTTP transport auth UNIFI_MCP_API_TOKEN bearer token; HTTP transport refuses to start without it (loopback-only, stdio is the default)
Session isolation Each controller authenticates independently
SSL configurable UNIFI_VERIFY_SSL=true for environments with proper certs
2FA support TOTP via UNIFI_TOTP_SECRET (base32 encoded)

Sidereal integration

{
  "mcpServers": {
    "unifi": {
      "type": "stdio",
      "command": "uv",
      "args": ["--directory", "~/src/ubiquiti-unifi-blade-mcp", "run", "ubiquiti-unifi-blade-mcp"],
      "env": {
        "UNIFI_HOST": "192.168.1.1",
        "UNIFI_USERNAME": "admin",
        "UNIFI_PASSWORD": "...",
        "UNIFI_VERIFY_SSL": "false",
        "UNIFI_WRITE_ENABLED": "false"
      }
    }
  }
}

Webhook trigger patterns

  • Device state changesunifi_devices returns state (connected/disconnected/upgrading), enabling alerts on AP/switch failures
  • New/unknown clientsunifi_clients with blocked status for intrusion detection workflows
  • Firmware availabilityunifi_devices flags UPGRADE_AVAILABLE for maintenance scheduling
  • Firewall auditunifi_firewall + unifi_port_forwards for periodic security posture checks

Development

make install-dev    # Install with dev + test dependencies
make test           # Unit tests (mocked, no controller needed)
make check          # Lint + format + type-check
make run            # Start MCP server (stdio)

Architecture

src/ubiquiti_unifi_blade_mcp/
├── server.py       — FastMCP server, 23 @mcp.tool decorators
├── client.py       — UniFiClient: aiounifi session auth + Integration API (X-API-KEY) layer, multi-controller, credential scrubbing
├── formatters.py   — Token-efficient output (pipe-delimited, null omission, human units)
├── models.py       — Controller config, auth modes, write gate, network payload builder
└── auth.py         — Bearer token middleware for HTTP transport

Built with FastMCP 2.0 and aiounifi.

Acknowledgements

  • Kane610/aiounifi — the async UniFi library that powers this and the Home Assistant integration
  • sirkirby/unifi-mcp — comprehensive UniFi MCP for full network management (available as community listing)

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ubiquiti_unifi_blade_mcp-0.3.0.tar.gz (130.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ubiquiti_unifi_blade_mcp-0.3.0-py3-none-any.whl (23.5 kB view details)

Uploaded Python 3

File details

Details for the file ubiquiti_unifi_blade_mcp-0.3.0.tar.gz.

File metadata

  • Download URL: ubiquiti_unifi_blade_mcp-0.3.0.tar.gz
  • Upload date:
  • Size: 130.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for ubiquiti_unifi_blade_mcp-0.3.0.tar.gz
Algorithm Hash digest
SHA256 3c608897f151393b6f4f6f20826abcc292bc7e6d98d5f3133aebe0b2edf6f955
MD5 e99573c9d59745a42964cd151abd38da
BLAKE2b-256 68adb7294922fcf681d09987d14fb1a4564d58d9a6a248c0e793580f5eb8fce7

See more details on using hashes here.

Provenance

The following attestation bundles were made for ubiquiti_unifi_blade_mcp-0.3.0.tar.gz:

Publisher: publish.yml on Groupthink-dev/ubiquiti-unifi-blade-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ubiquiti_unifi_blade_mcp-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ubiquiti_unifi_blade_mcp-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ce7516455df309cb4dc8a4e7b8a92e0f50a5c2ebb4511426a191cd2d9e5a98bc
MD5 8ce04bcceb43253960fdf5ce31f92198
BLAKE2b-256 db1f4d1462eed9f61d29bdb15a4e9f00d5fb43131fa6d7b6f666b17758d82528

See more details on using hashes here.

Provenance

The following attestation bundles were made for ubiquiti_unifi_blade_mcp-0.3.0-py3-none-any.whl:

Publisher: publish.yml on Groupthink-dev/ubiquiti-unifi-blade-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page