zia_list_workload_groups

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

Adds significant value beyond the readOnlyHint annotation by explaining why the tool is read-only (authoring left to UI) and highlighting the missing server-side name filter, which affects usage.

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 that efficiently convey purpose, usage, and constraints without extraneous information. Front-loaded with the key action.

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?

Adequately covers what the tool does and how to use it, given the straightforward nature and 100% schema coverage. Could optionally mention expected return structure or pagination tips, but not required.

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 baseline is 3. The description reinforces the query parameter with a concrete example, adding practical meaning beyond the schema description.

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?

Clearly states it lists ZIA workload groups and explains their use in firewall, URL filtering, SSL inspection, and Web DLP rules. This distinguishes it from other list tools by specifying the resource and its application context.

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?

Provides explicit guidance on using JMESPath queries to overcome the lack of a server-side name filter, and notes that authoring is done in the UI. While it doesn't directly compare to sibling tools, the usage context is clear and actionable.

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