sophos_list_ip_host_groups

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

Annotations declare readOnlyHint=true, so the read-only nature is already known. The description adds that it returns a list or dict, which is basic. It does not disclose pagination, rate limits, or whether the call retrieves all groups without a filter. Given the annotation, a score of 3 is appropriate.

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 concise with two sentences upfront plus structured Args/Returns. Every sentence serves a purpose, and it is front-loaded with the main action. No redundant information.

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?

For a simple list operation with optional filter, the description covers purpose, usage context, and return type. It omits details like default behavior (lists all groups) or pagination, but an output schema exists to provide structure. Slightly more completeness would be ideal, but it is adequate.

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 50% (only name has schema description). The description matches the schema for name and adds a description for client ('Optional SophosFirewallClient instance'), which was missing in the schema. However, it does not explain how client affects behavior or provide examples. At 50% coverage, the description compensates minimally.

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 'List IP host groups configured on Sophos Firewall', which is a specific verb (List) and resource (IP host groups). This distinguishes it from sibling tools like sophos_list_ip_hosts (individual hosts) and sophos_create_ip_host_group (creation).

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 provides context: 'Use when viewing grouped IP host definitions used in rule sets.' However, it does not explicitly state when not to use it or mention alternatives like sophos_list_ip_hosts for individual hosts. The usage is implied but not comprehensive.

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