unifi_consoles

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

Discloses read-only nature via operation 'list (Read)' and annotation readOnlyHint; adds cache behavior ('per-process cache' and refresh bypass) and API context ('Site Manager API'). No contradictions with annotations.

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

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

Three compact bullet-style sections with no filler; each sentence adds context (return fields, ID usage, cache bypass).

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

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

Despite lacking an output schema, the description lists return fields (id, name, type, ipAddress) and explains the tool's role in the broader unifi_* workflow, covering essentials for a read-only list tool.

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

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

Both parameters are fully described in the schema (operation enum, refresh boolean). The description does not add new parameter-level details—it repeats refresh semantics and operation purpose, with no additional meaning beyond the schema.

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

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

The description clearly states the tool lists consoles visible to the API key, using 'List every UniFi console' and 'discovery only', distinguishing it from sibling tools focused on specific resources.

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

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

Explicitly frames this as the discovery entry point: 'Pass a returned id as consoleId to the other unifi_* tools.' It also restricts scope with 'discovery only — ADR-002', implying when not to use it.

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