opnsense_route_delete

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

No annotations are provided, so the description carries full responsibility. It only states 'Delete' which implies destruction, but lacks details on side effects, idempotency, permissions, or whether the operation is reversible. The follow-up apply instruction is the only behavioral hint.

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?

Two sentences: one for purpose, one for critical follow-up. No fluff or repetition. Every word contributes meaning.

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 mostly complete. It mentions the necessary post-action (apply). However, it does not explain how to obtain the UUID (e.g., from list tool) or handle errors. Sibling relationships are understood from context but not explicitly connected.

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 schema covers the single parameter 'uuid' with a description. The tool description adds no additional meaning beyond the schema. Baseline of 3 applies since schema coverage is high.

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') and resource ('static route'), distinguishing it from sibling tools like add, update, list, and apply. It also mentions the complementary action to activate, reinforcing its role.

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 a critical usage instruction: 'Run opnsense_route_apply afterwards to activate.' This guides the user on post-deletion steps. However, it does not explicitly state when not to use this tool (e.g., consider updating instead) or alternative approaches.

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