zia_get_cloud_firewall_ips_rule

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

Annotations already indicate readOnlyHint=true, so no contradiction. The description adds 'with member references' hinting at output structure, but does not elaborate on behavior beyond a basic read. No side effects or additional traits disclosed.

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?

Single sentence of 12 words, no wasted words. Front-loaded with verb and resource. Appropriate size for the simple tool.

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 no output schema, the description only hints at output ('with member references'). Does not explain return format, pagination, or error cases. Adequate for a simple read but lacks completeness.

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?

Parameter 'rule_id' has no description in schema (0% coverage). The tool description does not clarify its format, source, or meaning, leaving the agent to infer from context. Fails to add value beyond the bare schema.

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 gets a single ZIA Cloud Firewall IPS rule by ID, specifying the exact resource and operation. It distinguishes from sibling tools like 'zia_get_cloud_firewall_rule' (for non-IPS rules) and 'zia_list_cloud_firewall_ips_rules' (lists vs single).

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 on when to use this tool vs alternatives like searching or listing. Does not mention prerequisites or context for use. Lacks any 'when to use' or 'when not to use' information.

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