opn_toggle_firewall_rule

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

Discloses key behaviors: toggle flips state, changes auto-revert in 60 seconds, requires confirmation, and returns revision and uuid. With no annotations, the description fully covers the safety and mutability profile.

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 with three short paragraphs, each adding value. However, it could be slightly more concise by combining sentences, but overall it is efficient.

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 simple single-parameter tool, the description covers prerequisites, return values, and the auto-revert mechanism. The output schema existence further supports completeness.

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 'uuid' is explained in context: it is the UUID of the firewall rule, obtained via opn_list_firewall_rules. This adds significant meaning beyond the schema's type-only definition.

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 tool toggles a firewall rule's enabled/disabled state. It specifies the resource (firewall filter rule) and action (toggle), distinguishing it from sibling tools like opn_toggle_alias which toggles aliases.

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?

Explicitly states when to use (temporarily disable for testing or re-enable), advises to use opn_list_firewall_rules first to get UUID, and mentions auto-revert and need to confirm with opn_confirm_changes. Provides clear workflow guidance.

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