Xray Add Test Associations

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

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=true and an open-world network call, so the safety profile is covered structurally. The description adds no behavioral context of its own - it does not say whether existing associations are replaced or appended, whether some target fields require version_id, or what authorization is needed for an additive link.

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 front-loaded sentence with no filler; the action and its targets are stated immediately. Every word earns its place.

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 an output schema and annotations present, the description need not cover returns or safety. However, for a 6-parameter mutation that is only meaningful if at least one target array is supplied, it never states that constraint nor how this tool relates to the many sibling add/remove association tools, leaving a real 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%, so every parameter is already documented in the schema, making 3 the baseline. The description's enumeration of Preconditions/Test Sets/Test Plans/Test Executions roughly mirrors the schema's array properties but adds no format, cardinality, or mutual-dependency detail.

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 gives a specific verb ('Link') and resource ('Test') plus the four target association types, and the singular 'one Test' distinguishes it from the plural bulk siblings. It does not, however, explicitly contrast itself with xray_add_tests_to_test_set / xray_add_tests_to_test_plan, which perform the reverse-direction association, so a reader must infer the distinction.

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?

Usage is only implied by the purpose statement ('Link one Test to...'); there is no explicit 'use this when you have a single test and want to attach it to many containers' guidance and no mention of the sibling alternatives that do the same job from the other direction. No exclusions or prerequisites are stated.

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