# UniFi MCP Server

> UniFi MCP Server documentation: connect AI agents to Ubiquiti UniFi through the Model Context Protocol to monitor, configure, and automate networks and Protect.

- [UniFi MCP Server: AI-powered network management tool](https://docs.hashgrid.net/introduction.md): UniFi MCP Server lets AI assistants manage your UniFi network. Control devices, configure firewalls, and automate tasks through natural language.
- [Quickstart: install and connect UniFi MCP Server today](https://docs.hashgrid.net/quickstart.md): Install UniFi MCP Server with pip or uvx, set your UniFi API key, and connect it to Claude Desktop or another AI assistant in minutes.
- [UniFi API modes explained: local, cloud-v1, and cloud-ea](https://docs.hashgrid.net/api-modes.md): Compare the three UniFi API connection modes and learn which environment variables to set for Local Gateway, Cloud v1, and Cloud EA access.
- [Install UniFi MCP Server with pip or uv](https://docs.hashgrid.net/installation/pip.md): Install the UniFi MCP Server from PyPI using pip or uv. Requires Python 3.10 or higher. The unifi-mcp-server command becomes available globally after install.
- [Run UniFi MCP Server with Docker](https://docs.hashgrid.net/installation/docker.md): Pull and run the UniFi MCP Server as a Docker container. Supports amd64, arm64, and arm/v7. Includes a Docker Compose setup with Redis caching.
- [Configure UniFi MCP Server environment variables](https://docs.hashgrid.net/installation/configuration.md): Full reference for every environment variable the UniFi MCP Server accepts: required API keys, mode settings, Redis caching, webhooks, and performance tracking.
- [Connect UniFi MCP Server to Claude Desktop](https://docs.hashgrid.net/clients/claude-desktop.md): Add the UniFi MCP Server to Claude Desktop on macOS or Windows. Configure pip, uvx, or Docker and start issuing network commands through Claude.
- [Connect UniFi MCP Server to Cursor](https://docs.hashgrid.net/clients/cursor.md): Configure the UniFi MCP Server in Cursor's MCP settings file to query and manage your UniFi network directly from the Cursor Chat sidebar.
- [Connect to any MCP-compatible client](https://docs.hashgrid.net/clients/other-clients.md): Use the UniFi MCP Server with Windsurf, Continue.dev, or any MCP-compatible client. Includes generic stdio config patterns and environment variable reference.
- [Monitor and control UniFi devices with AI](https://docs.hashgrid.net/features/device-management.md): List, inspect, restart, locate, and upgrade UniFi access points, switches, and gateways through natural language prompts using the UniFi MCP Server.
- [Create and manage networks and VLANs](https://docs.hashgrid.net/features/network-config.md): Create, update, and delete UniFi networks and VLANs with DHCP configuration, port forwarding rules, and full dry-run safety for every change.
- [Manage firewall rules and security policies](https://docs.hashgrid.net/features/firewall-security.md): Create traditional firewall rules, manage Zone-Based Firewall zones, define Layer 3/4 ACLs, and build traffic matching lists through your AI assistant.
- [Create and configure WiFi networks (SSIDs)](https://docs.hashgrid.net/features/wifi-management.md): Create WPA2/WPA3 WiFi networks, set up guest SSIDs with VLAN isolation, and monitor connected client counts and bandwidth usage through your AI assistant.
- [Traffic prioritization and QoS management](https://docs.hashgrid.net/features/qos-traffic.md): Create traffic routing policies with bandwidth shaping and DSCP marking, and use DPI analytics to identify top bandwidth applications on your network.
- [Automated backups and restore for UniFi](https://docs.hashgrid.net/features/backup-restore.md): Trigger manual backups, configure automated schedules, download and verify backup files with SHA-256 checksums, and restore your UniFi controller safely.
- [Manage multiple UniFi sites from one AI assistant](https://docs.hashgrid.net/features/multi-site.md): Monitor all your UniFi sites in one place—compare health scores, aggregate device and client stats, and search across locations from a single AI session.
- [Real-time events with UniFi webhooks](https://docs.hashgrid.net/advanced/webhooks.md): Receive instant UniFi network event notifications—device status changes, client connections, and alerts—using HMAC-verified webhooks.
- [Speed up responses with Redis caching](https://docs.hashgrid.net/advanced/caching.md): Connect an optional Redis instance to reduce UniFi API calls, stay within rate limits, and improve AI tool response times on large networks.
- [Safety controls and audit logging](https://docs.hashgrid.net/advanced/safety-audit.md): Learn how confirm=True, dry_run=True, and the audit log work together to protect your UniFi network from unintended AI-driven changes.
- [Troubleshoot common UniFi MCP Server issues](https://docs.hashgrid.net/advanced/troubleshooting.md): Fix the most common problems with the UniFi MCP Server: startup errors, authentication failures, missing tools, rate limits, and more.
- [UniFi MCP Server tools overview](https://docs.hashgrid.net/tools/overview.md): Browse all 77 UniFi MCP tools by category. Learn how site_id, confirm, and dry_run work, and when to use MCP resources instead of tools.
- [Device query tools reference](https://docs.hashgrid.net/tools/devices.md): Reference for get_device_details, get_device_statistics, list_devices_by_type, search_devices, and list_pending_devices for querying UniFi devices.
- [Client query tools reference](https://docs.hashgrid.net/tools/clients.md): Reference for list_active_clients, get_client_details, get_client_statistics, and search_clients for querying connected and historical UniFi clients.
- [Network query tools reference](https://docs.hashgrid.net/tools/networks.md): Reference for list_vlans, get_network_details, get_subnet_info, and get_network_statistics for querying UniFi network and VLAN configuration.
- [Site query tools reference](https://docs.hashgrid.net/tools/sites.md): Reference for list_sites, get_site_details, and get_site_statistics for querying UniFi site inventory and site-wide health metrics.
- [Network topology tools reference](https://docs.hashgrid.net/tools/topology.md): Reference for get_network_topology, export_topology, get_device_connections, get_port_mappings, and get_topology_statistics for mapping UniFi network graphs.
- [Device and client control tools reference](https://docs.hashgrid.net/tools/device-control.md): Reference for UniFi MCP tools that restart devices, toggle LED locate mode, upgrade firmware, and block or reconnect network clients.
- [Network configuration tools reference](https://docs.hashgrid.net/tools/network-config.md): Reference for UniFi MCP tools that create, update, and delete networks and VLANs, including DHCP configuration and subnet management.
- [Firewall rule tools reference](https://docs.hashgrid.net/tools/firewall.md): Reference for UniFi MCP tools that list, create, update, and delete traditional firewall rules, including protocol, port, and address matching.
- [WiFi and SSID management tools reference](https://docs.hashgrid.net/tools/wifi.md): Reference for UniFi MCP tools that list, create, update, and delete wireless SSIDs, and retrieve per-WLAN client and bandwidth statistics.
- [Port forwarding tools reference](https://docs.hashgrid.net/tools/port-forwarding.md): Reference for UniFi MCP tools that list, create, update, and delete port forwarding rules to expose internal services through your WAN interface.
- [Switch port profile tools reference](https://docs.hashgrid.net/tools/port-profiles.md): Reference for UniFi MCP tools that list, create, update, delete, and apply switch port profiles, covering PoE, VLANs, 802.1X, and LLDP-MED.
- [Zone-Based Firewall tools reference](https://docs.hashgrid.net/tools/firewall-zones.md): Manage firewall zones and assign networks to them on your UniFi local gateway using the Zone-Based Firewall tools in the MCP server.
- [ACL and traffic matching tools reference](https://docs.hashgrid.net/tools/acls.md): Create and manage ACL rules and reusable traffic matching lists to precisely control network traffic flow across your UniFi sites.
- [RADIUS and guest portal tools reference](https://docs.hashgrid.net/tools/radius.md): Configure RADIUS authentication profiles, manage local RADIUS accounts, and set up guest portal settings and hotspot packages for your UniFi sites.
- [Guest voucher management tools reference](https://docs.hashgrid.net/tools/vouchers.md): Create, list, and delete time-limited hotspot vouchers for guest Wi-Fi access, with optional bandwidth and data quota limits, on your UniFi sites.
- [QoS and traffic shaping tools reference](https://docs.hashgrid.net/tools/qos.md): Manage traffic routing policies on your UniFi gateway to control how traffic is prioritized, marked, or shaped across your network.
- [Backup and restore tools reference](https://docs.hashgrid.net/tools/backups.md): Trigger on-demand backups, list available backup files, download them locally, configure a schedule, and safely restore your UniFi controller configuration.
- [Multi-site management tools reference](https://docs.hashgrid.net/tools/site-manager.md): List, compare, and monitor all your UniFi sites from a single view — including health scores, ISP metrics, SD-WAN status, and cross-site search.
- [DPI statistics and traffic flow tools reference](https://docs.hashgrid.net/tools/dpi.md): Inspect application bandwidth usage, per-client traffic breakdowns, and the full list of DPI application categories available across your UniFi sites.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.