Xray Get Test Versions

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveness=false, so the safety profile is covered. The description adds that results are paginated and that they feed version_id parameters, which is useful but brief. It doesn't explain pagination semantics or mention include_archived/include_definition behavior beyond what the schema says.

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?

A single tight sentence in parentheses, front-loaded with the action and resource. No wasted words, though it is very terse and could carry slightly more structure without bloat.

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?

An output schema exists, so return values needn't be explained, and annotations cover safety. The one notable gap is that pagination behavior isn't detailed, but for a read-only list tool with full schema coverage, the description is nearly complete.

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 all five parameters are fully documented in the schema. The description adds only the conceptual link that returned ids map to version_id parameters elsewhere, which is context rather than parameter syntax. Baseline 3 is appropriate.

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?

States a specific verb (List) and resource (versions of a Test), clearly distinguishable from sibling xray_get_test which returns the test itself. The parenthetical explaining the version_id purpose adds useful routing context, though it doesn't explicitly differentiate from other get tools.

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 parenthetical hints at when to use it (to obtain version_id values for other tools), which is implicit guidance. But there's no explicit when-not-to-use or named alternative within the large sibling set.

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