ztw_list_ip_groups

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

The read-only behavior is already declared by the readOnlyHint annotation. The description adds that it 'Supports JMESPath client-side filtering via the query parameter', which is useful behavioral context beyond annotation. No contradictions.

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 extremely concise with two sentences. The first sentence states the core purpose, the second adds a key feature. Every word contributes meaning, and the structure is well front-loaded.

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 the existence of an output schema and high annotation coverage, the description could be more complete. It does not clarify the scope of 'IP groups' (source vs destination), nor does it mention pagination, default ordering, or provide usage context among similar list tools. It is adequate but has gaps.

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?

With 100% schema description coverage, the schema already documents all three parameters (search, query, service). The description does not add any additional meaning or constraints beyond what is in the schema, meeting the baseline expectation.

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 verb 'List' and resource 'ZTW IP groups', and indicates it is read-only. However, it does not differentiate between this tool and similar siblings like ztw_list_ip_destination_groups or ztw_list_ip_source_groups, leaving ambiguity about whether it lists all IP groups or a specific type.

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 is provided on when to use this tool versus alternatives such as ztw_list_ip_destination_groups or ztw_list_ip_source_groups. The description only mentions JMESPath filtering, not usage contexts or exclusions.

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