Skip to main content
Glama
owine

UniFi Network MCP Server

by owine

List sites

unifi_list_sites
Read-only

List all UniFi sites an API key can access to get the siteId required by other UniFi Network tools.

Instructions

List all sites the API key has access to. Returns: id (the siteId every other tool requires), internalReference, name. Use for: first call in any workflow — almost every other tool needs a siteId.

Input Schema

NameRequiredDescriptionDefault
limitNoNumber of records to return (API default: 25)
filterNoFilter expression. Filterable: id, internalReference, name — eq/ne/in/notIn only (like is rejected). Example: name.eq('Default')
offsetNoNumber of records to skip

Output Schema

NameRequiredDescriptionDefault
dataYes
countNo
limitNo
offsetNo
totalCountNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv2.15.0
    • changedInput schema / properties / filter / description
      Previous value: -"Filter expression (e.g., name.like('office*'))"New value: +"Filter expression. Filterable: id, internalReference, name — eq/ne/in/notIn only (like is rejected). Example: name.eq('Default')"
    • changedInput schema / properties / limit / description
      Previous value: -"Number of records to return (default: 25, max: 200)"New value: +"Number of records to return (API default: 25)"
    • changedInput schema / properties / offset / description
      Previous value: -"Number of records to skip (default: 0)"New value: +"Number of records to skip"
    • changedOutput schema / additionalProperties
      Previous value: -falseNew value: +{}
  2. Changed2 schema fields changedv2.13.0
    • changedInput schema / properties / filter / description
      Previous value: -"Filter expression (e.g., 'name.like(office*)')"New value: +"Filter expression (e.g., name.like('office*'))"
    • changedInput schema / properties / limit / minimum
      Previous value: -1New value: +0
  3. First observedv2.8.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=false, so the safety profile is covered. The description adds real value beyond that: it scopes results to what the API key can access and flags that the returned id is the siteId required by other tools, which is genuine cross-tool behavioral context. It does not discuss pagination defaults, but the schema does.

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

Conciseness5/5

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

Two short sentences, zero filler, with the purpose and the return contract front-loaded before the usage directive. Every clause earns its place.

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

Completeness5/5

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

For a zero-required-param list tool with an output schema, annotations, and a fully documented input schema, the description supplies the one thing structured fields cannot: that this is the entry point that yields the siteId for the rest of the toolset. Nothing needed to call it correctly is missing.

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 description coverage is 100% and all three params (limit, filter, offset) are fully documented in the schema, including filter operators and examples. The description adds nothing about parameters, so the baseline 3 applies.

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

Purpose5/5

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

States a specific verb+resource ('List all sites') plus the access scope ('the API key has access to') and enumerates the return fields. It is unambiguously distinguishable from the many sibling list_* tools, which target devices, clients, networks, and so on.

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

Usage Guidelines5/5

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

Explicitly says 'Use for: first call in any workflow' and gives the reason — 'almost every other tool needs a siteId'. That is a concrete when-to-use condition with the dependency explained, leaving little to inference.

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