ufw_rule

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

No annotations provided; description only says 'add or delete' but does not disclose that rules are modified immediately, potential impact on existing rules, or that sudo_password is required. Missing details on persistence and side effects.

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?

Description is a single sentence, concise. However, it lacks structure and could provide more information in a few more sentences without being verbose.

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?

With 4 parameters, no output schema, and no annotations, the description is insufficient. Does not explain what happens on success/failure, how to interpret results, or the role of 'alias' and 'sudo_password'.

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 only 25% (only 'rule' has a description). Description does not add meaning to 'alias' or 'sudo_password', which are left undocumented. Examples in 'rule' help but are minimal.

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?

Description clearly states the tool adds or deletes a UFW firewall rule, with specific verbs and resource. It is distinct from sibling tools like ufw_enable_disable and ufw_status.

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?

No guidance on when to use this tool versus alternatives, no prerequisites or context for when to choose add/delete actions. Does not explain relationship to other UFW tools.

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