Delete Interface

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

It explicitly states 'DESTRUCTIVE and IRREVERSIBLE' and explains cascading deletes with examples (device interfaces, power ports, etc.), adding significant context beyond the destructiveHint annotation. Also mentions HTTP 204 response.

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: 5 sentences that front-load the purpose and then provide essential warnings. Every sentence adds value with no wasted words.

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 tool has one parameter, annotations, and no output schema, the description fully covers purpose, parameter, behavior (destructive, cascading), and return value (HTTP 204). No gaps remain.

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 already fully describes the single 'id' parameter (100% coverage). The description repeats 'by numeric id' but adds no new meaning beyond the schema.

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 a interface from NetBox by numeric id,' specifying the verb (delete), resource (interface), and required input (numeric id). It distinguishes from sibling delete tools by naming the specific resource type.

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 provides usage guidance by warning of destructiveness and advising confirmation with the user before calling. However, it does not explicitly compare with alternative tools or state when not to use this tool.

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