Skip to main content
Glama

List sites

unifi_list_sites
Read-only

List UniFi controller sites with id, name, description, role and device count, and get the exact site name required by other tools.

Instructions

List the controller's sites with id, name, description, role and device_count. Pass a site's name (not its description) as the site argument of other tools.

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": "unifi_list_sites"
  }
}

Input Schema

NameRequiredDescriptionDefault
fieldsNoOnly return these fields per item (dot paths, e.g. uplink.name)
searchNoCase-insensitive substring match on names, MACs, IPs and similar

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.9.1
    • addedInput schema / properties / fields / description
      Added value: +"Only return these fields per item (dot paths, e.g. uplink.name)"
    • addedInput schema / properties / search / description
      Added value: +"Case-insensitive substring match on names, MACs, IPs and similar"
  2. First observedv0.8.1

TDQS

A4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description contributes the identifier convention and the field inventory, but says nothing about whether all sites are returned, ordering, or pagination behavior. Notably, idempotentHint=false on a read-only list is unexplained and unaddressed.

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 sentences, both front-loaded and purposeful: one establishes scope and payload, the second delivers the cross-tool usage rule. No filler, no restatement of the title.

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?

For a simple, zero-required-parameter list tool with full schema coverage and no output schema, the description supplies what an agent needs to call it and to use the result. Only result-set size and ordering are left unspecified, which is minor here.

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%, so `fields` and `search` are already fully documented in the schema. The field list in the description implicitly signals what dot paths the `fields` parameter accepts, which is modest added value but not an explanation of either parameter's behavior.

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?

Names a specific verb and resource ("List the controller's sites") and enumerates the returned fields (id, name, description, role, device_count). Among a large family of unifi_list_* siblings, it is immediately obvious this is the site-enumeration tool rather than networks, devices or clients.

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

Usage Guidelines4/5

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

Explicitly tells the agent how to use the result downstream: pass the site's `name` (not its description) as the `site` argument of other tools. That is real, non-obvious guidance that prevents a common misuse. It stops short of a 5 because it never states when-not or an alternative for retrieving site data.

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