Delete SDN vnet

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

Annotations already indicate destructiveHint: true. The description adds value by stating that it also deletes the subnets (cascading deletion) and reinforces the need for user confirmation. This provides useful behavioral context beyond the 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 extremely concise, using two short sentences to convey the action, resource, and critical warning. The key information is front-loaded, and every word is meaningful.

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 destructive delete tool with two parameters and no output schema, the description covers the basics: what it does and that it requires confirmation. However, it lacks context about prerequisites (e.g., vnet must not be in use), potential failure conditions, or post-deletion behavior. It is minimally adequate but not fully complete.

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?

The input schema has 50% description coverage (only 'confirm' is described). The tool description does not add any additional details about the 'name' parameter (e.g., its format or purpose) or further clarify 'confirm'. Since the schema coverage is low, the description should compensate, but it does not.

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 'Delete an SDN vnet and its subnets,' which specifies the exact resource and action. This distinguishes it from sibling tools like delete_sdn_subnet (which deletes only a subnet) and other delete tools for different 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?

The description explicitly instructs the agent to ask the user for confirmation before invoking due to its destructive nature. This provides clear guidance on when to use the tool (only with user approval). However, it does not explicitly mention when not to use it or compare with alternatives like delete_sdn_subnet, leaving some room for improvement.

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