unifi_list_vouchers

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

Annotations already confirm read-only and non-destructive behavior. The description adds value by detailing specific return fields and their meanings (e.g., activatedAt explains when it's set), and shows how filters can be used, all without contradicting 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?

Two sentences, no wasted words. First sentence states purpose and lists fields, second gives usage advice. Information is front-loaded and every sentence serves a purpose.

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?

Output schema handles return value documentation, so description is adequate. Mentions key behaviors (filter usage, field meanings). Could note pagination behavior, but limit/offset in schema cover it. Complete for practical use.

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?

Schema already covers all parameters with descriptions (100% coverage). The description enhances understanding by providing a filter example and explaining that activatedAt indicates first usage, adding context 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 action ('List hotspot/guest-portal vouchers at a site') and specifies the resource. It differentiates from sibling tools like unifi_get_voucher by being the list variant, and lists return fields for clarity.

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?

Provides a concrete example of when to use the filter parameter ('Use filter like 'expired.eq(true)' to bulk-find stale vouchers'), suggesting appropriate context. Does not explicitly exclude alternatives, but sibling tool names imply when to use get_voucher instead.

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