delete_hotspot_voucher

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. 'Delete' makes the destructive nature clear, but the description does not state whether deletion is permanent, require confirmation, or have side effects on dependent resources. Beyond naming the action, it offers no behavioral context.

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 compact and front-loaded with the action, followed by terse parameter definitions and a retrieval hint. Every sentence earns its place without redundancy.

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 simple 3-parameter delete operation, the description covers all required inputs and tells the agent exactly where to source voucher_id. It omits any warning about irreversibility or permission requirements, but the presence of an output schema reduces the need to explain return values.

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 compensate, and it does. It defines host as 'console name, ID, or composite ID (MAC:numericId format)', site as 'site name or ID', and explains that voucher_id is required and obtainable from list_hotspot_vouchers. This is meaningful semantic guidance beyond the raw string fields.

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 opens with a specific verb and resource pair: 'Delete a single hotspot voucher.' The word 'single' explicitly distinguishes this from the sibling bulk_delete_hotspot_vouchers, so an agent can immediately identify which tool matches the operation.

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?

It provides clear context for using the tool, including how to obtain the voucher_id from list_hotspot_vouchers. It does not explicitly mention when to prefer bulk_delete_hotspot_vouchers instead, but the 'single' framing gives enough implicit guidance for this simple deletion case.

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