zdx_get_software_details

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

The description states 'Read-only,' which is redundant given the readOnlyHint annotation. No additional behavioral details (e.g., pagination, rate limits, or response structure) are provided. The description adds minimal value beyond the annotation.

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 brief, with two short sentences and a separate line for the read-only note. It is front-loaded with the primary action. No wasted words, though it could benefit from more detail without sacrificing brevity.

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 tool's complexity (7 parameters, no output schema), the description is insufficient. It lacks explanation of return values, optional filters, and the query parameter. The core use case is covered, but the agent lacks the context to use all capabilities effectively.

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?

With only 14% schema description coverage and 7 parameters, the description only mentions software_key. It does not explain optional parameters (geo_id, user_ids, device_ids, location_id, department_id, query) or their intended use, leaving the agent without guidance for these fields.

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's function: expanding a ZDX software key into per-user/device install rows. It specifies that it returns users and devices for a given software_key and references the sibling tool zdx_list_software for obtaining the key, making the purpose distinct.

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 advises obtaining the key from zdx_list_software, indicating a prerequisite. However, it does not explicitly state when to use this tool over alternatives or provide exclusions. The guidance is implied but not comprehensive.

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