UniFi

io.github.mattoddiePublished by GitHub account mattoddiev0.6.1Updated Oct 29, 2026

Manage a Ubiquiti UniFi network: devices, clients, WiFi, firewall and VPN. Read-only by default.

Overview

AI-generated overview

Lets an assistant inspect and, if enabled, change a Ubiquiti UniFi network: sites, devices, clients, WiFi, firewall, VPN and more.

What you can do
  • Inspect sites, controller info and site health, and list devices, clients and switch ports
  • Manage WiFi networks, VLANs, WAN, DNS records and bandwidth profiles
  • Review firewall rules, port forwards, traffic routes, IDS/IPS and VPN/RADIUS settings
  • Handle hotspot guest vouchers and guest authorization
  • Read events, alarms, traffic reports, DPI and speed tests, and manage admins and backups
  • Preview changes with a dry run, and call any controller API path through a raw escape hatch
When to use it
Useful when you want to ask about a UniFi network in plain language: health checks, weak-signal clients, risky firewall or port-forward reviews, firmware status, or guest voucher creation. It fits home labs and managed sites where an assistant should read the network, and optionally make changes.
Requirements
Runs locally over stdio, as a Docker image or a Claude Desktop extension bundle. Needs the controller address in UNIFI_URL, plus either an API key in UNIFI_API_KEY or a local account via UNIFI_USERNAME and UNIFI_PASSWORD. For an https controller, set UNIFI_TLS_FINGERPRINT or UNIFI_VERIFY_SSL. Docker is needed for the container route.
Before you install
Read-only by default; writes require UNIFI_ALLOW_WRITES and deletes additionally UNIFI_ALLOW_DELETES, which can restart devices, block clients, or delete configuration. The raw toolset can call any controller API path. UNIFI_VERIFY_SSL=false skips certificate checks and is insecure; prefer pinning with UNIFI_TLS_FINGERPRINT. The API key and password are sensitive; use dry runs and UNIFI_AUDIT_LOG before enabling writes on a production network.

Installation

In SourceWeft

  1. Open UniFi in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

README

[unifi-mcp logo]

unifi-mcp

Talk to your UniFi network.

An open-source Model Context Protocol server for Ubiquiti UniFi Network. It lets Claude and other AI assistants monitor and manage your sites, devices, clients, WiFi, firewall and more, all from one Docker container.

[CI] [Release] [Container image] [License: MIT]

unifi-mcp.mattoddie.dev

Quick start · Documentation · Tool reference · Contributing


"Why is the lounge TV buffering?" The TV is on the Lounge AP at -78 dBm and 12 Mbps, and that AP's 5 GHz radio is at 81% channel utilisation on channel 36. Moving the AP to channel 149 or adding a wired backhaul should fix it. Want me to change the channel?

Ask about your network in plain English. The assistant picks from 145 tools to look things up and, if you allow it, make changes. Some examples:

  • 🩺 "Give me a health check of the network."
  • 🔎 "Which clients have a weak WiFi signal right now?"
  • 🔐 "Review my firewall and port forwards for anything risky."
  • 🔄 "Which devices have firmware updates, and when were they last rebooted?"
  • 🎟️ "Create 10 one-day guest vouchers limited to 5 Mbps."
  • 🧱 "Block the device called 'kids-tablet' until I unblock it."

Highlights

  • 🐳 Docker-first. There's one small distroless image (ghcr.io/mattoddie/unifi-mcp, about 22 MB) for linux/amd64 and linux/arm64. It serves Streamable HTTP for a long-running service, or stdio for docker run -i. For Claude Desktop there's also a one-click extension bundle (.mcpb) that needs no Docker.
  • 🛡️ Safe by default. The server is read-only unless you turn on writes, and deleting configuration needs a second switch. Destructive tools are labelled so your MCP client asks before running them, and passwords and keys are redacted from output.
  • 🔍 Preview and audit. Every write tool takes dry_run: true to show the request it would send, with a field-level diff of what would change, without changing anything. UNIFI_AUDIT_LOG records each change in a JSON Lines audit log.
  • 🧰 Broad coverage. It covers 14 toolsets: devices, clients, switch ports and PoE, WiFi, networks and VLANs, WAN, DNS, legacy and zone-based firewall, traffic rules and routes, IDS/IPS, VPN, RADIUS, hotspot vouchers, statistics, logs, admins and backups.
  • 🎛️ Tunable. Expose only the toolsets you need, which keeps the model's context small and focused. See Keeping the tool list small.
  • 🔌 Works with your controller. Supports UniFi OS consoles (UDM, UDM Pro/SE, UCG, UDR, UX, Cloud Key Gen2+, UniFi OS Server) and legacy self-hosted Network applications. Auth is an API key or a local account.
  • 🧪 Tested. The test suite runs against a mock controller on every build.

Quick start

You need Docker, a UniFi controller and an MCP client such as Claude Code.

1. Get credentials. On a UniFi OS console, create an API key: UniFi Network → Settings → Control Plane → Integrations → Create API Key. On older controllers, use a local account instead.

2. Start the server.

sh
mkdir unifi-mcp && cd unifi-mcpcurl -fsSLO https://raw.githubusercontent.com/mattoddie/unifi-mcp/main/compose.yamlcurl -fsSL https://raw.githubusercontent.com/mattoddie/unifi-mcp/main/example.env -o .env# Edit .env: set UNIFI_URL, UNIFI_API_KEY and a random MCP_AUTH_TOKEN (required; e.g. `openssl rand -hex 32`).# For an https controller, also say how to check its certificate, or the server won't start.# Recommended: pin it with UNIFI_TLS_FINGERPRINT (see docs/security.md). example.env sets# UNIFI_VERIFY_SSL=false, which skips the check: remove it once the fingerprint is set.docker compose up -d

3. Connect your assistant.

sh
claude mcp add --transport http unifi http://<docker-host>:8080/mcp \  --header "Authorization: Bearer <MCP_AUTH_TOKEN>"

Now ask "How's my network doing?" in Claude Code.

Using Claude Desktop, VS Code, Cursor or Codex? See Connecting MCP clients. Prefer not to run a service? Use stdio mode with docker run -i.

Claude Desktop in one click

On a Mac or Windows PC with Claude Desktop, you don't need Docker at all. Download the .mcpb bundle for your computer from the latest release, open it, and enter your controller URL, API key and certificate fingerprint in the settings. See Claude Desktop.

unifi-mcp is also listed in the MCP Registry as io.github.mattoddie/unifi-mcp, with the image (over stdio) and the bundles, so clients and directories that read the registry can install it.

Turning on changes

Out of the box the assistant can look but not touch. To let it make changes, add these to .env and run docker compose up -d:

sh
UNIFI_ALLOW_WRITES=true      # restart devices, block clients, edit WiFi/firewall/networks…UNIFI_ALLOW_DELETES=true     # also allow deleting configuration, forgetting clients… (needs writes too)UNIFI_TOOLSETS=overview,devices,clients,wifi,monitoring   # optional: expose fewer toolsUNIFI_AUDIT_LOG=stderr       # optional: log every change (or a file path; see docs/configuration.md)

Ask for a dry run to preview a change first: "Dry run: disable the guest WiFi. What would change?" Read Security before turning on writes for a production network.

What it can do

ToolsetWhat's covered
overviewSites, controller info, site health
devicesDevice status and details, restart/locate/provision, firmware upgrades (also rolling), radios, PoE outlets, adoption, RF scans, AP groups
clientsOnline and known clients, block/unblock, reconnect, names, fixed IPs, lock to an AP, forget
switchingSwitch ports, port profiles, PoE power-cycling, port mirroring, link aggregation, LLDP neighbours
wifiWLANs (SSIDs, security, VLANs, bands), WiFi QR codes
networksNetworks/VLANs and DHCP, WAN, local DNS records, bandwidth profiles, dynamic DNS
firewallPort forwards, firewall rules and groups, zone-based policies and zones, traffic rules, QoS rules, NAT rules, switch ACL rules, object-oriented network policies
routingStatic routes, policy-based traffic routes
securityIDS/IPS threat management, threat log, country blocking, content filtering
vpnVPN servers and site-to-site VPNs, RADIUS profiles and accounts
hotspotVouchers, hotspot operators, guest authorization, guest portal
monitoringEvents, alarms, traffic reports, traffic flows, DPI, speed tests, rogue APs, system log, sessions, anomalies, dashboards
adminSite settings (including SNMP, mDNS and auto-backup), admins, backups, controller updates, sites
rawAn escape hatch that calls any controller API path

See the tool reference for every tool and argument. Ready-made prompts like network_health_check, troubleshoot_client and security_review chain the tools together for common jobs.

Documentation

The docs are also published at unifi-mcp.mattoddie.dev/docs, with search.

🚀 Getting startedStep-by-step setup, from credentials to first question
🔌 Connecting MCP clientsClaude Code, Claude Desktop, VS Code, Cursor, Codex, stdio mode
⚙️ ConfigurationEvery environment variable, Docker secrets, toolsets
🐳 DeploymentCompose, image tags, upgrades, TLS reverse proxy, hardening
💬 Using unifi-mcpExample conversations, prompts, how saves and secrets work
🧰 Tool referenceAll 145 tools and 5 prompts, generated from the code
🛡️ SecurityThreat model, least privilege, safe write setups
📡 CompatibilitySupported controllers and versions, API caveats
🩹 TroubleshootingCommon errors and how to fix them
🛠️ DevelopmentArchitecture, adding a tool, testing

Contributing

Contributions are very welcome, whether that's bug reports, compatibility reports from your hardware, docs or new tools. Read the contributing guide to get started, and please follow the code of conduct. To report a vulnerability, see the security policy. Please don't open a public issue for one.

License

MIT © Matt Oddie

unifi-mcp is an independent community project. It is not affiliated with, endorsed by or sponsored by Ubiquiti Inc. UniFi and Ubiquiti are trademarks of Ubiquiti Inc.

Source: README.md at commit 076263d

Tools

0
SourceWeft started this package once in an isolated sandbox, without credentials, to list its tools. That failed: the package type cannot run in the sandbox.

Version history

1
  1. v0.6.1LatestOct 22, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts