zia_list_ip_source_groups

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

Annotations already declare readOnlyHint=true. The description reinforces 'read-only' and adds the behavioral trait of JMESPath client-side filtering, which is not fully disclosed by annotations alone. 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 a single sentence with no wasted words. It front-loads the primary action and key feature (read-only, JMESPath filtering). Extremely concise and well-structured.

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 an output schema and full parameter descriptions, the tool is fairly complete. The description covers the main purpose and JMESPath filtering, but could briefly mention the optional 'search' and 'service' parameters for extra clarity. Still, it adequately supports agent understanding.

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 100%, so each parameter has a description. The description highlights JMESPath filtering but does not add meaning to all parameters (e.g., 'search', 'service'). The baseline of 3 is appropriate since the schema does the heavy lifting.

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 ZIA IP source groups', specifying the verb and resource. It distinguishes from siblings like 'zia_get_ip_source_group' (singular) and other list tools for different resources. The 'read-only' and 'JMESPath filtering' notes further clarify scope.

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 usage for listing IP source groups with optional client-side filtering, but does not explicitly contrast with alternatives (e.g., when to use 'get' vs 'list', or other list tools). The mention of JMESPath provides a cue but lacks explicit directions.

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