zia_list_shadow_it_apps

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

Annotations already declare readOnlyHint=true, so description adds value by specifying the data type (analytics catalog with IDs and friendly names) and client-side filtering. No information about rate limits or auth, but for a read-only list tool with annotations, this is sufficient.

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?

Three well-structured sentences: purpose, differentiation from siblings, and additional feature (JMESPath filtering). No redundant words, front-loaded with the main action and resource.

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 low complexity, annotations, and existence of output schema, description adequately covers the tool's purpose, differentiation, and key feature. Could mention pagination handling or data freshness, but not required for a simple 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 has 100% description coverage, so baseline is 3. Description mentions JMESPath filtering for the query parameter, which adds a bit of context, but doesn't cover page_number or service parameters. Description primarily reinforces schema information.

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?

Description clearly states the verb 'List' and resource 'Shadow IT cloud applications', with explicit examples (e.g., 'Sharepoint Online', id 655377). It distinguishes itself from siblings by stating it is 'NOT the policy-engine enum catalog' and directing users to alternative tools for policy strings.

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 when not to use this tool, directing users to zia_list_cloud_app_policy / zia_list_cloud_app_ssl_policy for canonical enum strings. Also mentions JMESPath client-side filtering capability, giving clear context for usage.

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