zia_list_cloud_firewall_ips_rules

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

The description adds 'read-only' and 'Supports JMESPath client-side filtering', which are behavioral traits beyond the readOnlyHint annotation. It does not contradict annotations.

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?

Two sentences with clear front-loading: first sentence states purpose, second provides key filtering capability. 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 tool with 3 optional parameters and no output schema, the description adequately covers purpose, read-only nature, and filtering support. It does not detail return structure, but that is not critical for a list tool.

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 baseline is 3. The description mentions JMESPath filtering, which is already in the query parameter description, adding minimal new meaning.

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 tool lists ZIA cloud firewall IPS rules (read-only). It specifies the verb 'List' and the resource 'ZIA cloud firewall IPS rules', distinguishing it from sibling tools like zia_get_cloud_firewall_ips_rule (single rule) and other list tools for different rule types.

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 cloud firewall IPS rules through the resource name, but does not explicitly provide when-to-use or when-not-to-use guidance compared to sibling tools. The JMESPath filtering hint is useful but not a usage guideline per se.

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