Skip to main content
Glama

unifi_gen_getsiteoverviewpage

unifi_gen_getsiteoverviewpage
Read-onlyIdempotent

Lists local UniFi sites with limit, filter, and offset controls to retrieve site overview data for inventory or reporting.

Instructions

List Local Sites - generated from developer.ui.com/network/v11.0.97/getsiteoverviewpage

Input Schema

NameRequiredDescriptionDefault
limitNo
filterNo
offsetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.0

TDQS

C2.1/5.0
Behavior2/5

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

Annotations already declare readOnly, idempotent, non-destructive, open-world behavior, so the safety profile is covered. The description adds nothing beyond that: it doesn't mention pagination behavior (limit/offset are visible in the schema but unmentioned), result volume, or how the overview page is composed. The developer.ui.com URL is metadata, not behavioral disclosure.

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

Conciseness2/5

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

It is short, but short by omission rather than by discipline. The second clause is a raw documentation URL that consumes roughly half the text without helping an agent decide or invoke, while the mechanically important pagination/filter semantics are absent.

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

Completeness2/5

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

With no output schema and only annotation-level safety hints, the description should describe what a "site overview page" returns and how to page through it. It does not, nor does it disambiguate from the many other listing siblings. Only the read-only/idempotent annotations keep this from being a full failure.

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

Parameters1/5

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

Schema description coverage is 0% for all three parameters, so the description carries the full burden and provides nothing. It never explains what 'filter' accepts (syntax, fields, operators) or how limit/offset pagination behaves, which is the single most important thing an agent needs here.

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

Purpose3/5

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

It states a verb and resource ("List Local Sites"), which is better than a tautology, but the name says "getsiteoverviewpage" (a paginated overview endpoint) while the description says "List", and no sibling is distinguished. Dozens of siblings perform similar listing (unifi_gen_listsites, unifi_net_list_sites, unifi_sm_list_sites), so an agent cannot tell which one to pick from this text.

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 mention of prerequisites, and no routing to alternatives such as unifi_gen_listsites or unifi_net_list_sites. The only extra content is a provenance URL, which gives the agent nothing actionable about selection.

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