Skip to main content
Glama
unifi-network-mcp

unifi-network-mcp

unifi-network-mcp

MCP server for the official UniFi Network Integration API.

Gives AI assistants (Claude, and any MCP-compatible client) typed, safety-gated access to your UniFi Network console: devices, clients, networks, WiFi, firewall policies and zones, ACL rules, DNS policies, traffic matching lists, hotspot vouchers, switching views, and supporting resources — the complete documented v10.4.57 surface, 73 operations behind 16 tools.

Community project. Not affiliated with, endorsed by, or supported by Ubiquiti Inc. "UniFi" is used only to describe what this software connects to.

Get started with AI

Paste this into Claude, ChatGPT, Grok, or any AI assistant for a guided, hands-on setup:

Read https://raw.githubusercontent.com/ZenixSolutions/unifi-network-mcp/main/docs/ai-setup.md and follow its instructions to help me set up the UniFi Network MCP server with my AI client.

Related MCP server: Unifi AP MCP

One API key, every console you manage — no VPN, no console IPs, no self-signed certificates.

  1. Create an API key: sign in at unifi.ui.com → Settings → API Keys → Create New API Key. Store it securely — it is shown once.

  2. Add the server to your MCP client. For Claude Desktop (claude_desktop_config.json):

{
  "mcpServers": {
    "unifi-network": {
      "command": "npx",
      "args": ["-y", "@zenixsolutions/unifi-network-mcp"],
      "env": {
        "UNIFI_API_KEY": "<your API key>"
      }
    }
  }
}
  1. Ask your assistant something like "list my UniFi consoles", then "list the clients at Acme HQ". With several consoles visible, the assistant is shown the list and picks a consoleId per action (ADR-002); with exactly one, it is used automatically. Calls route through Ubiquiti's documented Site Manager Connector on api.ui.com.

Quick start (direct to one console)

Point the server at a single console instead by adding:

"UNIFI_CONSOLE_URL": "https://192.168.1.1",
"UNIFI_INSECURE": "1"

(UNIFI_INSECURE=1 accepts the console's default self-signed certificate — warned on start; see SECURITY.md.)

Configuration

Variable

Required

Meaning

UNIFI_API_KEY

yes

API key from unifi.ui.com. Sent as the X-API-KEY header.

UNIFI_CONSOLE_URL

no

When set: direct mode against that console (integration path appended automatically; a full api.ui.com connector base also works). When unset: cloud multi-console mode via api.ui.com.

UNIFI_INSECURE

no

Direct mode only: set to 1 to accept a self-signed console certificate (warned on every start). Ignored in cloud mode.

Verify a configuration without connecting a client:

npx -y @zenixsolutions/unifi-network-mcp --check   # exit 0 ok, 78 misconfigured
npx -y @zenixsolutions/unifi-network-mcp --list-tools
npx -y @zenixsolutions/unifi-network-mcp --version

The tool surface

16 tools cover all 73 documented operations (measured tools/list cost: ≈7,500 tokens). Each resource area is one tool with an operation argument:

unifi_info, unifi_sites, unifi_devices, unifi_clients, unifi_networks, unifi_wifi_broadcasts, unifi_firewall_policies, unifi_firewall_zones, unifi_acl_rules, unifi_dns_policies, unifi_traffic_matching_lists, unifi_vouchers, unifi_switching, unifi_supporting — plus unifi_spec (the vendor's exact request/response schema for any operation) and unifi_consoles (cloud-mode console discovery; every tool takes an optional consoleId).

Full per-operation reference: docs/tools.md.

Safety model

  • Every operation is classified Read / Create / Update / Admin / Destructive in its tool description.

  • Destructive (all deletes, device removal) and Admin (device restart, PoE power-cycle, guest authorization) operations require confirm: true in the call — an assistant cannot trigger them by accident.

  • Request bodies are validated locally against Ubiquiti's own published OpenAPI schemas before anything is sent.

  • The real write control is your API key's permissions — scope the key in unifi.ui.com to what you actually want an assistant to do. The server adds friction, not authorization.

  • The API key is never logged and is redacted from every error message.

Documentation

Development

npm install
npm run generate      # regenerate op map from docs/reference/openapi.json
npm run typecheck && npm run lint && npm test
npm run build
npm run check:budget  # measured tools/list token budget (CI-enforced)
UNIFI_CONSOLE_URL=... UNIFI_API_KEY=... npm run test:contract  # live, read-only

See CONTRIBUTING.md. Governance follows the Engineering OS framework; the foundation decisions are recorded in docs/rfc/RFC-004-unifi-network-mcp-foundation.md.

License

MIT

Available Tools

16 tools
unifi_acl_rulesA
Destructive

ACL rules and their ordering. Operations:

  • list (Read): List ACL Rules

  • create (Create): Create ACL Rule

  • get_ordering (Read): Get User-Defined ACL Rule Ordering

  • update_ordering (Update): Reorder User-Defined ACL Rules

  • delete (Destructive): Delete ACL Rule — requires confirm: true

  • get (Read): Get ACL Rule

  • update (Update): Update ACL Rule List results are pages: { offset, limit (max 200), count, totalCount, data[] }. Filtering: pass filter as property.function(args); combine with and(...), or(...), not(...). Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull; SET: contains, containsAny, containsAll, containsExactly, isEmpty. Strings use single quotes ('guest'); like patterns: '.'=one char, '*'=any run, ''=escape. For request-body shapes call unifi_spec with { operation: "unifi_acl_rules." }.

Inputs: operation (required), body, limit, filter, +5 more.

unifi_clientsA
Destructive

Connected clients (list, details, guest authorization). Operations:

  • list (Read): List Connected Clients

  • get (Read): Get Connected Client Details

  • execute_action (Admin): Execute Client Action — requires confirm: true List results are pages: { offset, limit (max 200), count, totalCount, data[] }. Filtering: pass filter as property.function(args); combine with and(...), or(...), not(...). Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull; SET: contains, containsAny, containsAll, containsExactly, isEmpty. Strings use single quotes ('guest'); like patterns: '.'=one char, '*'=any run, ''=escape. For request-body shapes call unifi_spec with { operation: "unifi_clients." }.

Inputs: operation (required), body, limit, filter, +5 more.

unifi_consolesA
Read-only

List every UniFi console (company/site deployment) visible to the configured API key, via the Site Manager API (discovery only — ADR-002). Operations:

  • list (Read): List consoles; returns id, name, type, ipAddress. Pass a returned id as consoleId to the other unifi_* tools in cloud mode. Set refresh: true to bypass the per-process cache.

Inputs: operation (required), refresh.

unifi_devicesA
Destructive

UniFi devices (adoption, details, statistics, restart, PoE port power-cycle). Operations:

  • list_pending (Read): List Devices Pending Adoption

  • list (Read): List Adopted Devices

  • adopt (Create): Adopt Devices

  • remove (Destructive): Remove (Unadopt) Device — requires confirm: true

  • get (Read): Get Adopted Device Details

  • execute_action (Admin): Execute Adopted Device Action — requires confirm: true

  • execute_port_action (Admin): Execute Port Action — requires confirm: true

  • get_statistics (Read): Get Latest Adopted Device Statistics List results are pages: { offset, limit (max 200), count, totalCount, data[] }. Filtering: pass filter as property.function(args); combine with and(...), or(...), not(...). Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull; SET: contains, containsAny, containsAll, containsExactly, isEmpty. Strings use single quotes ('guest'); like patterns: '.'=one char, '*'=any run, ''=escape. For request-body shapes call unifi_spec with { operation: "unifi_devices." }.

Inputs: operation (required), body, limit, filter, +6 more.

unifi_dns_policiesA
Destructive

DNS policies. Operations:

  • list (Read): List DNS Policies

  • create (Create): Create DNS Policy

  • delete (Destructive): Delete DNS Policy — requires confirm: true

  • get (Read): Get DNS Policy

  • update (Update): Update DNS Policy List results are pages: { offset, limit (max 200), count, totalCount, data[] }. Filtering: pass filter as property.function(args); combine with and(...), or(...), not(...). Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull; SET: contains, containsAny, containsAll, containsExactly, isEmpty. Strings use single quotes ('guest'); like patterns: '.'=one char, '*'=any run, ''=escape. For request-body shapes call unifi_spec with { operation: "unifi_dns_policies." }.

Inputs: operation (required), body, limit, filter, +5 more.

unifi_firewall_policiesA
Destructive

Firewall policies and their ordering. Operations:

  • list (Read): List Firewall Policies

  • create (Create): Create Firewall Policy

  • get_ordering (Read): Get User-Defined Firewall Policy Ordering

  • update_ordering (Update): Reorder User-Defined Firewall Policies

  • delete (Destructive): Delete Firewall Policy — requires confirm: true

  • get (Read): Get Firewall Policy

  • patch (Update): Patch Firewall Policy

  • update (Update): Update Firewall Policy List results are pages: { offset, limit (max 200), count, totalCount, data[] }. Filtering: pass filter as property.function(args); combine with and(...), or(...), not(...). Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull; SET: contains, containsAny, containsAll, containsExactly, isEmpty. Strings use single quotes ('guest'); like patterns: '.'=one char, '*'=any run, ''=escape. For request-body shapes call unifi_spec with { operation: "unifi_firewall_policies." }.

Inputs: operation (required), body, limit, filter, +7 more.

unifi_firewall_zonesA
Destructive

Firewall zones. Operations:

  • list (Read): List Firewall Zones

  • create (Create): Create Custom Firewall Zone

  • delete (Destructive): Delete Custom Firewall Zone — requires confirm: true

  • get (Read): Get Firewall Zone

  • update (Update): Update Firewall Zone List results are pages: { offset, limit (max 200), count, totalCount, data[] }. Filtering: pass filter as property.function(args); combine with and(...), or(...), not(...). Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull; SET: contains, containsAny, containsAll, containsExactly, isEmpty. Strings use single quotes ('guest'); like patterns: '.'=one char, '*'=any run, ''=escape. For request-body shapes call unifi_spec with { operation: "unifi_firewall_zones." }.

Inputs: operation (required), body, limit, filter, +5 more.

unifi_infoB
Read-only

UniFi Network application info. Operations:

  • get (Read): Get Application Info

Inputs: operation (required), consoleId.

unifi_networksA
Destructive

Networks (VLANs/subnets) configuration. Operations:

  • list (Read): List Networks

  • create (Create): Create Network

  • delete (Destructive): Delete Network — requires confirm: true

  • get (Read): Get Network Details

  • update (Update): Update Network

  • get_references (Read): Get Network References List results are pages: { offset, limit (max 200), count, totalCount, data[] }. Filtering: pass filter as property.function(args); combine with and(...), or(...), not(...). Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull; SET: contains, containsAny, containsAll, containsExactly, isEmpty. Strings use single quotes ('guest'); like patterns: '.'=one char, '*'=any run, ''=escape. For request-body shapes call unifi_spec with { operation: "unifi_networks." }.

Inputs: operation (required), body, force, limit, +6 more.

unifi_sitesA
Read-only

Sites on this UniFi Network console. Operations:

  • list (Read): List Local Sites List results are pages: { offset, limit (max 200), count, totalCount, data[] }. Filtering: pass filter as property.function(args); combine with and(...), or(...), not(...). Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull; SET: contains, containsAny, containsAll, containsExactly, isEmpty. Strings use single quotes ('guest'); like patterns: '.'=one char, '*'=any run, ''=escape.

Inputs: operation (required), limit, filter, offset, +1 more.

unifi_specA
Read-only

Read the committed vendor API contract (OpenAPI, UniFi Network Integration API). Returns the exact request-body schema, path/query parameters, and response schema for any operation of the other unifi_* tools. Call this before create/update/action operations. Input: { operation: "." }, e.g. { operation: "unifi_networks.create" }.

Inputs: operation (required).

unifi_supportingA
Read-only

Supporting resources (countries, DPI, device tags, RADIUS, VPN, WANs). Operations:

  • list_countries (Read): List Countries

  • list_dpi_applications (Read): List DPI Applications

  • list_dpi_categories (Read): List DPI Application Categories

  • list_device_tags (Read): List Device Tags

  • list_radius_profiles (Read): List Radius Profiles

  • list_vpn_servers (Read): List VPN Servers

  • list_site_to_site_vpn_tunnels (Read): List Site-To-Site VPN Tunnels

  • list_wans (Read): List WAN Interfaces List results are pages: { offset, limit (max 200), count, totalCount, data[] }. Filtering: pass filter as property.function(args); combine with and(...), or(...), not(...). Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull; SET: contains, containsAny, containsAll, containsExactly, isEmpty. Strings use single quotes ('guest'); like patterns: '.'=one char, '*'=any run, ''=escape.

Inputs: operation (required), limit, filter, offset, +2 more.

unifi_switchingA
Read-only

Switching read-only views (LAGs, MC-LAG domains, switch stacks). Operations:

  • list_lags (Read): List LAGs

  • get_lag (Read): Get LAG Details

  • list_mc_lag_domains (Read): List MC-LAG Domains

  • get_mc_lag_domain (Read): Get MC-LAG Domain

  • list_switch_stacks (Read): List Switch Stacks

  • get_switch_stack (Read): Get Switch Stack List results are pages: { offset, limit (max 200), count, totalCount, data[] }. Filtering: pass filter as property.function(args); combine with and(...), or(...), not(...). Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull; SET: contains, containsAny, containsAll, containsExactly, isEmpty. Strings use single quotes ('guest'); like patterns: '.'=one char, '*'=any run, ''=escape.

Inputs: operation (required), lagId, limit, filter, +5 more.

unifi_traffic_matching_listsA
Destructive

Traffic matching lists. Operations:

  • list (Read): List Traffic Matching Lists

  • create (Create): Create Traffic Matching List

  • delete (Destructive): Delete Traffic Matching List — requires confirm: true

  • get (Read): Get Traffic Matching List

  • update (Update): Update Traffic Matching List List results are pages: { offset, limit (max 200), count, totalCount, data[] }. Filtering: pass filter as property.function(args); combine with and(...), or(...), not(...). Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull; SET: contains, containsAny, containsAll, containsExactly, isEmpty. Strings use single quotes ('guest'); like patterns: '.'=one char, '*'=any run, ''=escape. For request-body shapes call unifi_spec with { operation: "unifi_traffic_matching_lists." }.

Inputs: operation (required), body, limit, filter, +5 more.

unifi_vouchersA
Destructive

Hotspot vouchers. Operations:

  • delete_by_filter (Destructive): Delete Vouchers — requires confirm: true

  • list (Read): List Vouchers

  • generate (Create): Generate Vouchers

  • delete (Destructive): Delete Voucher — requires confirm: true

  • get (Read): Get Voucher Details List results are pages: { offset, limit (max 200), count, totalCount, data[] }. Filtering: pass filter as property.function(args); combine with and(...), or(...), not(...). Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull; SET: contains, containsAny, containsAll, containsExactly, isEmpty. Strings use single quotes ('guest'); like patterns: '.'=one char, '*'=any run, ''=escape. For request-body shapes call unifi_spec with { operation: "unifi_vouchers." }.

Inputs: operation (required), body, limit, filter, +5 more.

unifi_wifi_broadcastsA
Destructive

WiFi broadcasts (SSIDs) configuration. Operations:

  • list (Read): List Wifi Broadcasts

  • create (Create): Create Wifi Broadcast

  • delete (Destructive): Delete Wifi Broadcast — requires confirm: true

  • get (Read): Get Wifi Broadcast Details

  • update (Update): Update Wifi Broadcast List results are pages: { offset, limit (max 200), count, totalCount, data[] }. Filtering: pass filter as property.function(args); combine with and(...), or(...), not(...). Functions: eq, ne, gt, ge, lt, le, like, in, notIn, isNull, isNotNull; SET: contains, containsAny, containsAll, containsExactly, isEmpty. Strings use single quotes ('guest'); like patterns: '.'=one char, '*'=any run, ''=escape. For request-body shapes call unifi_spec with { operation: "unifi_wifi_broadcasts." }.

Inputs: operation (required), body, force, limit, +6 more.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A4.1/5.0

    Scored across 16 tools

    Disambiguation5/5

    Each of the 16 tools targets a distinct UniFi resource domain (devices, networks, firewall policies, WiFi broadcasts, etc.), and the descriptions clearly delineate their purposes. Even the more generic 'unifi_supporting' is explicitly a collection of read-only reference lists, so there is no overlap or ambiguity.

    Naming Consistency5/5

    All tools follow a consistent unifi_<resource> naming pattern, and operations consistently use verb_noun style (list, get, create, update, delete). Minor deviations such as 'patch' vs 'update' and 'generate' vs 'create' are isolated and do not undermine the overall predictable convention.

    Tool Count4/5

    At 16 tools, the server sits just above the typical 3-15 well-scoped range, but the breadth is justified by the complexity of UniFi network management. Each tool covers a meaningful subdomain, so the count feels comprehensive rather than bloated.

    Completeness4/5

    The server covers the major configuration and management domains (devices, networks, firewall policies/zones, WiFi broadcasts, vouchers, traffic lists, ACLs, clients) with rough CRUD or lifecycle coverage. Read-only reference data is well represented, and gaps like site creation are likely due to API limitations rather than an incomplete tool surface.

    Maintenance

    ActivityInactive
    ResponsivenessOutdated data

    Related MCP Connectors

    Related MCP Servers