unifi_update_firewall_rule

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

The description reveals that the tool fetches the current state and merges changes, which is important behavioral context beyond a simple update. However, no annotations exist, and it does not disclose other traits like error handling or permissions.

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 concise sentences with no wasted words. The first sentence front-loads the action and resource, and the second adds the key merge behavior.

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 5 parameters and no output schema, the description provides a crucial behavioral detail (merge) but lacks information on required inputs beyond rule_id, default values, or expected outcomes. It is adequate but not comprehensive.

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 0%, but the description adds minimal parameter context beyond the merge hint. It does not explain the purpose or constraints of individual parameters like rule_id, site_id, enabled, action, or name.

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 updates a firewall rule by its _id, which is specific and distinguishes it from siblings like create and delete. The verb 'update' and resource 'firewall rule' are explicit.

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 implies use when modifying an existing rule, but does not explicitly state when to use this tool versus alternatives like create or delete. No when-not-to-use or exclusions provided.

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