sophos_list_firewall_rules

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

Annotations declare readOnlyHint=true, so description adds limited behavioral context beyond that. Mentions return type ('List or dict') which is useful but not critical. No disclosure of pagination, limits, or other side effects, but adequate for a read-only list operation.

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?

Very concise (4 lines), front-loaded with purpose, then usage, then args/returns. No extraneous words. Clear structure that is easy to parse.

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?

Tool has output schema (not shown), so description needn't detail return values. It mentions return type. For a simple list with two optional params, the description covers the essentials. Could add detail about no pagination or default behavior, but sufficient for safe use.

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 50% (only name described). Description adds meaning for 'client' ('Optional SophosFirewallClient instance') beyond the schema, which has no description. For 'name', it repeats schema info. Compensates for missing schema detail on client 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?

Description clearly states action ('List firewall security rules') and resource ('configured on the appliance'). Distinguishes from sibling tools (e.g., sophos_get_firewall_rule for single rule) by implying a batch operation. Includes usage context ('browsing security policies, searching by name').

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 ('browsing security policies or searching for rules matching a specific name'). Does not explicitly mention when not to use or list alternatives, but the context is clear given sibling tools.

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