unifi_vouchers

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

The description goes well beyond the annotations by labeling each operation as Destructive/Read/Create, explicitly stating that destructive ops require confirm:true and "change or remove live configuration," and detailing the list response pagination structure. This directly complements the readOnlyHint=false and destructiveHint=true 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?

The description is well-structured with bullets and sections, making the dense information about operations, pagination, filtering, and spec reference scannable. It is appropriately sized for the complexity, though slightly dense in the filter-details portion.

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?

Given the tool's complexity (5 operations, 9 parameters, no output schema), the description covers operations, pagination, filtering, and points to unifi_spec for request-body shapes. However, it does not document response shapes for get/generate/delete operations, which would be valuable since no output schema is provided.

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?

All 9 parameters are already described in the input schema with usage hints, so the baseline is 3. The description adds extra value by defining the full filter grammar (property.function, operators, string quoting, like patterns) and directing users to unifi_spec for body shapes, enhancing parameter understanding 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 identifies the tool's purpose as managing hotspot vouchers and enumerates its five operations (list, get, generate, delete, delete_by_filter). It does not explicitly distinguish from sibling tools, but the resource scope is unambiguous within the UniFi context.

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 operational usage guidelines: destructive operations require confirm:true, list pagination parameters (offset/limit), filter expression syntax, and direction to call unifi_spec for request-body shapes. It does not mention when to use this tool over alternatives, but the domain is clear and the guidance for using the tool is substantial.

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