zia_list_cloud_firewall_rules

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

The description confirms the read-only nature (matching the readOnlyHint annotation) and adds value by specifying that JMESPath client-side filtering is supported via the query parameter, which is not captured by the annotation alone.

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, front-loading the core purpose and then adding an important filtering note. Every sentence is relevant and contributes immediately.

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 presence of an output schema, the description adequately covers listing and filtering. It could mention pagination or the default service behavior, but it is sufficiently complete for a read-only 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?

All parameters have schema descriptions (100% coverage), so the baseline is 3. The description reiterates the JMESPath capability but does not add new semantic meaning beyond what the schema already provides for the search and service parameters.

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') and the resource ('ZIA cloud firewall rules'), differentiating it from sibling tools like zia_list_cloud_firewall_dns_rules and zia_list_cloud_firewall_ips_rules by specifying 'cloud firewall rules'.

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 explains the optional filtering and JMESPath support, giving some usage context, but it does not explicitly guide when to use this tool over alternatives such as zia_list_cloud_firewall_dns_rules or when to use the get_ variant.

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