Skip to main content
MCP tools are functions your AI assistant can call to interact with your UniFi network. When you ask Claude or Cursor to “list all access points” or “show me which clients are connected,” it translates your request into one or more tool calls behind the scenes. Each tool maps directly to a UniFi API operation and returns structured data the AI can reason over and present back to you.

Tool categories

The UniFi MCP Server includes 77 tools across seven functional areas.
Write operations (those that modify your network) require confirm=True. Read operations documented on this page never modify any configuration.

Common parameter patterns

site_id

Almost every tool accepts a site_id parameter that scopes the operation to a single UniFi site. Use "default" for single-site installations, or pass the site’s internal identifier for multi-site deployments. You can discover site identifiers by calling list_sites or reading the sites:// resource.

limit and offset

List tools support pagination through limit (maximum number of results) and offset (number of results to skip). Both parameters are optional — omitting them returns a reasonable default set of results.

confirm=True for write operations

Every tool that modifies your network requires you to pass confirm=True. This prevents accidental changes when your AI assistant is exploring or planning. If you omit confirm, the tool raises a ConfirmationRequiredError and explains what it would have done.

dry_run=True for safe previews

Before applying any write operation, you can pass dry_run=True to see exactly what the tool would send to the UniFi API — without making any changes. The response includes the full payload that would have been submitted.
Always use dry_run=True first when making configuration changes. Review the payload, then re-run with confirm=True to apply.

MCP resources vs. MCP tools

In addition to tools, the server exposes MCP resources — read-only data endpoints identified by URI. Resources are optimized for bulk data retrieval and are accessed differently from tools, but they serve complementary purposes. Use resources when you want to pull a complete snapshot of data (for example, to feed into a report or analysis). Use tools when you need to filter, paginate, search, or take action.

Read vs. write operations

The pages in this section cover read operations only — tools that query your network without making any changes. These are safe to call at any time and do not require confirm=True.

Device query tools

List, search, and inspect UniFi devices.

Client query tools

Query connected and historical clients.

Network query tools

Inspect network and VLAN configuration.

Site query tools

List sites and retrieve site statistics.

Topology tools

Map device connections and export topology graphs.