Xray Get Test Plans

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is fully covered structurally. The description's only behavioral addition is 'paginated', which the limit/start schema parameters already convey, so it adds little beyond the structured data.

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?

One compact sentence with the resource and filter modes front-loaded and zero filler. It is appropriately sized, though the parenthetical '(paginated)' is somewhat redundant with the schema.

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 need no explanation, and annotations cover safety. However, for a 7-parameter collection tool sitting among many similarly named get_* tools, the description does not explain how jql, project, and test_plans interact or when to prefer one filter over another, leaving a modest gap.

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%, and each parameter (jql, project, test_plans, modified_since, fields, limit, start) is documented in the schema itself. The description adds no syntax or precedence detail beyond what the schema already provides, which is the baseline case.

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 (Search) and resource (Test Plans) with the filter dimensions (JQL, keys, project) and pagination. It is clearly a bulk/collection query, contrasting with the singular xray_get_test_plan, though it never names that sibling explicitly.

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?

'Search' implies list/multi-result usage, which distinguishes it loosely from single-entity siblings, but there is no explicit when-to-use or when-not-to-use guidance and no mention of how it relates to xray_get_test_plan or the other get_* variants.

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