Skip to main content
Glama
enuno

UniFi MCP Server

by enuno
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Hybrid

get_site_inventory

Get comprehensive inventory for a site or all sites.

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.

Args: settings: Application settings site_id: Optional site identifier. If None, returns inventory for all sites.

Returns: Site inventory or list of site inventories

Input Schema

NameRequiredDescriptionDefault
site_idNo
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.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."
+}
  2. First observedv0.2.0

TDQS

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden. It implies a read ('Get') and describes the returned breakdown, but says nothing about permissions, rate limits, cost, or pagination for the all-sites case, which is a meaningful gap for a tool that can fan out across every site.

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

Conciseness3/5

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

The Args/Returns structure is easy to scan and the opening sentence is front-loaded, but the spurious 'settings' argument is dead weight and the 'Returns' block is redundant given the tool has an output schema.

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

Completeness3/5

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

With an output schema present, the return format needn't be explained, and the description does state resource scope. But for a zero-annotation tool it leaves behavioral and sibling-selection context thin, and it references a non-existent parameter.

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 50%: controller is documented in the schema, while site_id is not, and the description usefully explains site_id ('If None, returns inventory for all sites'). However, it also lists a 'settings: Application settings' argument that does not exist in the schema (additionalProperties: false, only site_id/controller), which adds noise and potential confusion.

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+resource ('Get comprehensive inventory for a site or all sites') and enumerates the contents (devices, clients, networks, SSIDs, VPN tunnels, firewall rules). It does not, however, distinguish itself from close siblings like get_site_details, list_all_sites_aggregated, or list_innerspace_inventory, so an agent cannot tell which to pick from the description alone.

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 guidance, no prerequisites, and no mention of alternatives. The only scoping hint is that passing no site_id returns all sites, which is parameter behavior rather than tool-selection guidance.

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