Delete Platform

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

The description goes beyond the destructiveHint=true annotation by detailing the cascade delete behavior with concrete examples (e.g., deleting a device removes its interfaces, power ports). It also notes the HTTP 204 response, providing transparency about the operation's effects and final state.

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 well-structured, starting with the core action followed by critical warnings. While it contains necessary detail, it is slightly verbose but still efficient and easy to parse.

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's destructive nature and lack of output schema, the description covers all essential aspects: what it does, required parameter, cascade consequences, user confirmation need, and response format. No gaps are evident.

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 only parameter 'id' is fully documented in the input schema (100% coverage). The description restates 'numeric id' without adding extra semantic context, so it adds no value 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 the action ('Delete a platform from NetBox by numeric id') and the resource (platform), directly supporting selection among sibling delete tools. The verb 'Delete' and resource 'platform' are explicit and unambiguous.

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 explicit guidance on when to use this tool, warning of destructive nature and cascading deletes, and instructing to confirm with the user before calling. It explicitly says 'There is no undo' and advises verification, covering both usage and precautions.

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