unifi-mcp-server

unifi-mcp-server

An MCP server that enables Claude to manage Ubiquiti UniFi networks via the official API, including device/client oversight, network and WiFi configuration, firewall and ACL management, and guest access controls.

Category
访问服务器

README

unifi-mcp-server

An MCP (Model Context Protocol) server that lets Claude manage your Ubiquiti UniFi network through the official UniFi Network API — list devices and clients, check health stats, inspect and edit networks / WiFi / firewall / ACL / DNS config, adopt or restart devices, power-cycle PoE ports, and manage guest access and hotspot vouchers.

How it works

┌────────────┐   JSON-RPC over stdio   ┌──────────────────┐   HTTPS + X-API-KEY   ┌───────────────┐
│ Claude Code │ ◄────────────────────► │ unifi-mcp-server │ ◄──────────────────►  │ UniFi console │
│  (client)   │    tools/list,         │  (this project,  │  /proxy/network/      │ (UDM, UCG,    │
│             │    tools/call          │   Node process)  │  integration/v1/...   │  Cloud Key…)  │
└────────────┘                         └──────────────────┘                       └───────────────┘
  • Where it runs: on your machine. Claude Code launches node dist/index.js as a subprocess each session and talks JSON-RPC to it over stdin/stdout. Nothing is hosted anywhere; the only network traffic is HTTPS from this machine to your console.
  • What a "tool" is: a typed function this server registers (e.g. unifi_list_devices). Claude sees each tool's name, description, and input schema, decides when to call it, and gets text back.
  • Auth: a UniFi API key sent as the X-API-KEY header. The key lives in an environment variable — never in code.

Requirements

  • A UniFi OS console (UDM/UDR/UCG/Cloud Key Gen2+, port 443) or UniFi OS Server (port 11443) running Network 9.0+. Network 10.x unlocks the full tool set (networks, WiFi, firewall, ACL, DNS tools); on 9.x those return a clear "not supported" error while devices/clients/vouchers still work. ⚠ The legacy self-hosted Network Server (port 8443) does not support API-key auth and will not work with this server.
  • Node.js 18+ on this machine.

Setup

1. Create a UniFi API key

  1. Open your UniFi console in a browser and go to the Network application.
  2. Go to Settings → Control Plane → Integrations (on newer 10.x versions this may appear as Settings → Integrations).
  3. Click Create API Key, name it (e.g. claude-mcp), and copy it immediately — it is shown only once.

2. Build

npm install
npm run build

3. Register with Claude Code

claude mcp add --scope user unifi --env UNIFI_BASE_URL=https://YOUR_CONSOLE_IP --env UNIFI_API_KEY=YOUR_KEY --env UNIFI_TLS_VERIFY=false -- node "C:\path\to\MCP-UniFi\dist\index.js"
  • --scope user makes the server available in every project (omit for just the current one).
  • Drop --env UNIFI_TLS_VERIFY=false if your console has a real (trusted) TLS certificate — verification is on by default. The flag is needed for the self-signed certificate consoles ship with; the server logs a warning when verification is off.
  • The key is stored in your user-level Claude settings file in your profile directory. If you prefer it in a system environment variable instead, set UNIFI_API_KEY machine-wide and register without the --env UNIFI_API_KEY flag — the server reads the process environment.

Verify with claude mcp list, then just ask Claude things like:

  • "Which UniFi devices are offline right now?"
  • "Show me the health stats for my main switch."
  • "What clients are on the guest network?"
  • "Generate 5 guest WiFi vouchers for the weekend, 24h each."
  • "Power-cycle the PoE port my camera is on." (asks you to confirm first)

Configuration reference

Env var Required Default Meaning
UNIFI_BASE_URL yes — Console origin, e.g. https://192.168.1.1
UNIFI_API_KEY yes — API key from Settings → Control Plane → Integrations
UNIFI_TLS_VERIFY no true TLS cert validation (secure by default). Set false only for self-signed console certs on a trusted LAN — it allows on-path interception of the API key.
UNIFI_API_PATH no /proxy/network/integration Path prefix override (rarely needed)

Tools (70)

Read-only (37) — safe, no side effects:

  • Discovery: unifi_get_application_info, unifi_list_sites
  • Devices: unifi_list_devices, unifi_get_device, unifi_get_device_statistics, unifi_list_pending_devices
  • Clients: unifi_list_clients, unifi_get_client
  • Networks / topology: unifi_list_networks, unifi_get_network, unifi_get_network_references, unifi_list_wans, unifi_list_vpn
  • WiFi: unifi_list_wifi, unifi_get_wifi
  • Firewall / security: unifi_list_firewall_policies, unifi_get_firewall_policy, unifi_list_firewall_zones, unifi_list_acl_rules, unifi_get_acl_rule, unifi_list_dns_policies, unifi_get_dns_policy, unifi_list_traffic_matching_lists, unifi_get_traffic_matching_list
  • Switching: unifi_list_lags, unifi_get_lag, unifi_list_mclag_domains, unifi_get_mclag_domain, unifi_list_switch_stacks, unifi_get_switch_stack
  • Reference data: unifi_list_countries, unifi_list_dpi_applications, unifi_list_dpi_categories, unifi_list_device_tags, unifi_list_radius_profiles
  • Vouchers: unifi_list_vouchers, unifi_get_voucher

Write (33) — change things; Claude Code prompts for permission, and the ones that can disrupt the network are annotated destructiveHint (⚠) so clients warn first:

  • Devices: unifi_adopt_device, unifi_unadopt_device ⚠, unifi_restart_device ⚠, unifi_power_cycle_port ⚠
  • Guest access: unifi_authorize_guest_access, unifi_unauthorize_guest_access ⚠
  • Networks: unifi_create_network, unifi_update_network ⚠, unifi_delete_network ⚠
  • WiFi: unifi_create_wifi, unifi_update_wifi ⚠, unifi_delete_wifi ⚠
  • Firewall policies: unifi_set_firewall_policy_enabled ⚠, unifi_create_firewall_policy ⚠, unifi_update_firewall_policy ⚠, unifi_delete_firewall_policy ⚠, unifi_reorder_firewall_policies ⚠
  • Firewall zones: unifi_create_firewall_zone, unifi_update_firewall_zone ⚠, unifi_delete_firewall_zone ⚠
  • ACL rules: unifi_create_acl_rule ⚠, unifi_update_acl_rule ⚠, unifi_delete_acl_rule ⚠, unifi_reorder_acl_rules ⚠
  • DNS records: unifi_create_dns_policy, unifi_update_dns_policy ⚠, unifi_delete_dns_policy ⚠
  • Traffic-matching lists: unifi_create_traffic_matching_list, unifi_update_traffic_matching_list ⚠, unifi_delete_traffic_matching_list ⚠
  • Vouchers: unifi_generate_vouchers, unifi_delete_voucher ⚠, unifi_delete_vouchers ⚠ (bulk, filter required)

Editing config: create_* tools take a config object (the full resource); update_* tools do a full replacement — fetch the current object with the matching get_* tool using responseFormat: 'json', change what you need, and pass it back. List tools support limit/offset pagination and UniFi filter expressions, e.g. state.eq('OFFLINE'), access.type.eq('GUEST'), name.like('Office*'). Every tool also accepts responseFormat: 'json' for the raw API object.

Security notes

  • The API key is only read from the environment and never appears in tool output or logs.
  • WiFi passphrases and any credential-looking fields are redacted from responses.
  • TLS verification is ON by default. UNIFI_TLS_VERIFY=false is an explicit opt-out for self-signed console certs (the server logs a warning); install a proper certificate on the console to remove the need for it.
  • All resource IDs are validated as UUIDs before being placed in URLs, so a malformed ID can never redirect a request to a different endpoint.
  • Write tools describe their blast radius in their descriptions so Claude confirms with you before rebooting infrastructure.

Known limitations (of the official UniFi API, not this server)

Not available in the official Integration API as of v10.4.57 — these would require the unofficial legacy API (a possible phase 2):

  • Block / unblock / kick a client
  • Firmware upgrades, locate-LED
  • Port forwarding, static routes, traffic rules/QoS, per-port switch config
  • Historical statistics, events, alarms (only latest per-device stats exist)

Development

npm run dev        # run from source (tsx)
npm run build      # compile to dist/
npm run inspect    # open MCP Inspector against the built server

Ground truth for the API: https://developer.ui.com/network/v10.4.57/openapi.json (also llms.txt and a Postman collection at the same base URL).

License

MIT © PainInTheNic

推荐服务器

Baidu Map

Baidu Map

百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。

官方
精选
JavaScript
Playwright MCP Server

Playwright MCP Server

一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。

官方
精选
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。

官方
精选
本地
TypeScript
Audiense Insights MCP Server

Audiense Insights MCP Server

通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。

官方
精选
本地
TypeScript
VeyraX

VeyraX

一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。

官方
精选
本地
graphlit-mcp-server

graphlit-mcp-server

模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。

官方
精选
TypeScript
Kagi MCP Server

Kagi MCP Server

一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。

官方
精选
Python
e2b-mcp-server

e2b-mcp-server

使用 MCP 通过 e2b 运行代码。

官方
精选
Neon MCP Server

Neon MCP Server

用于与 Neon 管理 API 和数据库交互的 MCP 服务器

官方
精选
Exa MCP Server

Exa MCP Server

模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。

官方
精选