delete_vlan

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

With no annotations, the description carries full burden for behavioral disclosure, but it only states the basic action. It does not mention whether deletion is permanent, irreversible, cascades to associated resources, or requires special permissions. The destructive nature is implied but no additional context is provided.

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 sentence, concise, and front-loaded with the action. No extraneous words, perfectly sized for the tool's simplicity.

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 low complexity (one parameter, no output schema), the description is minimally adequate. It covers the purpose and parameter, but lacks information on return values, error conditions, or the permanent nature of the deletion. A more complete description would mention these aspects.

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 one integer 'id' with no description and 0% coverage, so the description must compensate. The phrase 'by ID' clarifies that the parameter is the VLAN identifier, adding minimal meaning beyond the raw schema. It is sufficient but not detailed.

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 the action ('Delete'), the resource ('VLAN'), and the identifier ('by ID'). It unambiguously distinguishes this from sibling tools like create_vlan, update_vlan, or get_vlan.

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 intended use is implied by the verb and resource: delete a VLAN. However, there is no explicit guidance on when not to use it, prerequisites (e.g., VLAN must exist), or alternatives. It meets the minimum but lacks explicit context.

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