zdx_list_software

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

Annotations already declare read-only, which description confirms. Description adds that it supports JMESPath filtering, a behavioral trait not in annotations. However, it does not disclose other behaviors like pagination, rate limits, or authentication requirements.

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?

Description is a single short sentence that front-loads the purpose. It is concise and contains no redundant information, though splitting into two sentences could improve readability slightly.

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 output schema present and read-only annotation, description covers main purpose and filtering. But it omits usage prerequisites, result limits, or any pagination details. For a list tool with 7 parameters, it is adequate but not thorough.

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 each parameter is already documented. Description only adds meaning by mentioning JMESPath filtering for the 'query' parameter. No additional context for other parameters beyond 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?

Description clearly states 'List ZDX software inventory' with specific verb and resource. It distinguishes itself from siblings like 'zdx_get_software_details' by being a list operation. Mentions read-only and JMESPath filtering, adding precision.

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?

Description implies use for listing software inventory but provides no explicit guidance on when to use versus alternatives or when not to use. Lack of comparative context with sibling tools like zdx_get_software_details reduces clarity.

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