delete_vlan

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

The annotation already declares destructiveHint=true and readOnlyHint=false, and the description's 'WARNING: This is irreversible' aligns with that without strictly adding new behavioral context. It reinforces the destructive nature but does not disclose additional side effects, permissions, or outcomes beyond what annotations already indicate.

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 a single, front-loaded sentence that immediately states the action and includes a necessary warning. Every word is useful, with no wasted content.

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 delete tool, the description is sufficiently complete when combined with the rich schema, annotations (destructiveHint), and output schema. The irreversible warning adds critical context, though it could mention operational consequences or steps like apply_immediately, but those are already visible in the schema.

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 100%, so the description does not need to add parameter detail. The schema already explains vlan_id, confirm, dry_run, and apply_immediately. The description adds no extra parameter semantics, keeping the score at the baseline of 3.

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 'Delete a VLAN by ID' uses a specific verb and resource and clearly distinguishes the action from siblings like create_vlan, update_vlan, and search_vlans. The 'by ID' qualifier adds useful scoping that matches the vlan_id parameter.

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 implies when to use the tool (when a VLAN must be removed) but provides no explicit when-to-use/when-not-to-use guidance or alternatives. It does not mention prerequisites, such as looking up the VLAN with search_vlans or ensuring it is not in use.

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