Skip to main content
Glama
Sign In
UniFi MCP Server

UniFi MCP Server

by enuno
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

get_site_inventory

Retrieves site inventory for one or all sites, with breakdowns of devices, clients, networks, SSIDs, VPN tunnels, and firewall rules.

Instructions

Get comprehensive inventory for a site or all sites.

Provides detailed breakdown of resources including devices, clients, networks, SSIDs, VPN tunnels, and firewall rules.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_site_inventory"
  }
}

Input Schema

NameRequiredDescriptionDefault
site_idNoOptional site identifier. If None, returns inventory for all sites.
controllerNoController to run against (see list_controllers). Defaults to the controller chosen with select_controller, then the server default.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.6.4
    • addedInput schema / properties / site_id / description
      Added value: +"Optional site identifier. If None, returns inventory for all sites."
  2. Changed1 schema field changedv0.6.0
    • addedInput schema / properties / controller
      Added value: +{
+  "anyOf": [
+    {
+      "type": "string"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "default": null,
+  "description": "Controller to run against (see list_controllers). Defaults to the controller chosen with select_controller, then the server default."
+}
  3. First observedv0.2.0

TDQS

B3.2/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the burden: 'Get' implies a read-only operation and the resource enumeration tells the agent roughly what comes back. But it says nothing about permissions, whether an all-sites call is expensive/large, or how the controller fallback affects results.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, front-loaded with the action and scope; the second sentence adds the useful resource breakdown. Minor redundancy between 'comprehensive inventory' and 'detailed breakdown'.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return structure need not be explained, and the description's resource list gives the agent enough to decide relevance. It is only slightly short on behavioral framing given the absence of annotations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and both parameters (site_id, controller) are fully documented in the schema, so baseline is 3. The description only echoes the site_id semantics ('for a site or all sites') and never mentions the controller parameter or its default chain.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource (get inventory) plus a scope (one site or all sites), and enumerates the resource types returned. It is clear what the tool does, but it never contrasts itself with nearby siblings such as get_site_details, list_sites, or list_all_sites_aggregated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no when-to-use / when-not-to-use guidance and no named alternative. The only implicit signal is the scope phrase 'for a site or all sites', which a reader must infer from the description rather than being routed explicitly.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools