firewall_setup_web_server_rules

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

No annotations are provided, so the description carries the burden. It discloses that the tool creates multiple rules (a batch operation) and specifies the ports and sources. However, it doesn't mention whether existing rules are preserved, whether the operation is idempotent, or what happens if the firewall group doesn't exist. The return value is mentioned ('List of created firewall rules') but not detailed.

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 a clear summary, args, returns, and a bulleted list of created rules. It's slightly verbose with the 'ctx' parameter mentioned in Args but not in the schema, but overall it's efficient and front-loaded with the main 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?

The description covers the tool's purpose, parameters, return value, and the exact rules created. It lacks details about error conditions (e.g., non-existent firewall group) and whether the operation is additive or replaces existing rules, but for a setup tool with a clear scope, it's reasonably complete.

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 description coverage is 0%, so the description must compensate. It explains firewall_group_id (ID or description like 'web-servers' or UUID) and allow_ssh_from (IP subnet, default anywhere). This adds meaning beyond the bare schema, though it doesn't specify the format for allow_ssh_from (e.g., CIDR notation) beyond the default value.

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's purpose: 'Set up common firewall rules for a web server' and enumerates the exact rules it creates (HTTP, HTTPS, SSH, ICMP). This distinguishes it from sibling tools like firewall_create_rule (single rule) and firewall_list_rules (listing).

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 when to use this tool: when setting up a web server's firewall with common rules. It doesn't explicitly state when not to use it or name alternatives like firewall_create_rule for custom rules, but the context is clear enough for an agent to select it appropriately.

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