zia_list_device_groups

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

The description adds the JMESPath filtering capability beyond the readOnlyHint annotation, but does not elaborate on behavioral traits like auth requirements, rate limits, or the nature of 'pseudo groups'. With annotations already declaring read-only, the description provides marginal additional transparency.

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 two sentences long, front-loaded with the core functionality, and every word adds value. No redundancy or fluff.

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 tool has an output schema and the input schema covers all parameters, the description is largely complete for a simple list operation. However, it could benefit from briefly explaining what 'device groups' are in ZIA context or noting pagination behavior.

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 100%, so the schema adequately documents all 4 parameters. The description mentions 'include_device_info' and 'include_pseudo_groups' but adds minimal meaning beyond the schema descriptions. Baseline score of 3 is appropriate.

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 action ('List ZIA device groups'), the optional inclusions ('device info', 'pseudo group filtering'), and client-side filtering via JMESPath. It is distinct from sibling tools which list other ZIA resources.

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 device groups and mentions read-only and JMESPath filtering, but lacks explicit guidance on when to use this tool over alternatives (e.g., `zia_list_devices`) or any exclusions or prerequisites.

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