list_hotspot_vouchers

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

With no annotations provided, the description carries the full burden and it delivers: it discloses offset-paginated behavior, default page size 100, automatic draining of all pages, return shape {data, totalCount}, and the incomplete-drain flag. This is rich behavioral detail well beyond the bare schema.

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 front-loaded with the core purpose and then organized into useful behavioral details. Minor redundancy exists in repeating that there is no shorter alias, but each paragraph earns its place and the length is justified by the pagination nuances.

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?

For a tool with no annotations, the description is complete: it covers purpose, family context, parameter formats, pagination defaults, response shape, and the incomplete-capped behavior. The output schema covers return structure, so no further format detail is needed.

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 description coverage is 0%, so the description must fully explain parameters, and it does. It defines acceptable `host` forms (console name, ID, or MAC:numericId composite), `site` as name or ID, and explains the meaning and effect of `offset` and `limit` for pagination.

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?

States a specific verb and resource: 'List all hotspot/guest vouchers for a site', and clarifies there is no shorter alias, which distinguishes it from any imagined sibling. It clearly names the voucher family and orients the agent to this specific listing role.

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 identifies the tool as the voucher-listing tool, names related tools in the family, and points out that no shorter `list_vouchers`/`get_voucher` alias exists. It also gives practical selection context by explaining pagination behavior and how to request a single manual page.

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