opnsense_fw_delete_rule

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

The description discloses the need to apply changes, which is a behavioral trait. However, without annotations, it could be more explicit about irreversibility or that it removes the rule permanently. The word 'delete' implies destruction, but additional context would improve transparency.

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 short sentences, front-loaded with the main action. No filler words; every sentence serves a purpose.

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 tool with one parameter and no output schema, the description covers the action and the necessary post-step. It could mention that the UUID must refer to an existing rule, but that is implied.

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 coverage is 100%, so baseline is 3. The description does not add meaning beyond the schema's 'UUID of the rule to delete'. No extra context is provided for the parameter.

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 (firewall filter rule), and the identifier (by UUID). It is specific and distinguishes from sibling tools like opnsense_fw_add_rule or opnsense_fw_toggle_rule.

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?

Provides explicit guidance that after deletion, opnsense_fw_apply must be run to activate the change. This helps the agent understand the workflow, though it does not explicitly state when not to use this tool (e.g., if undo is needed).

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