Xray Update Test Definition

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

Annotations already declare readOnlyHint=false, idempotentHint=true, destructiveHint=false, so the safety profile is covered. The word 'Replace' usefully signals that the existing definition is overwritten, but the description adds nothing about permissions, what happens on partial input, or how versioning interacts with the update.

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?

Two short sentences with zero filler, and the core action is front-loaded ahead of the routing hint. Every clause 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?

The tool is a mutation with an output schema and full parameter coverage, so the description need not explain returns. However, it omits whether gherkin and unstructured are mutually exclusive, how they relate to the test type, and version_id behavior, leaving meaningful gaps for an update tool.

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 the schema already documents test, gherkin, version_id, and unstructured. The description's mention of 'Gherkin or unstructured' mirrors the schema rather than adding format details, mutual-exclusivity rules, or guidance on version_id. Baseline 3 applies.

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 ('Replace') and resource ('the Gherkin or unstructured definition of a Test'), so the agent knows exactly what is being modified. It does not name a sibling tool explicitly, but the phrase 'step tools' points away from the step-related siblings.

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?

Provides a clear when-not with an alternative category: 'Use the step tools for manual tests.' That routes the agent away from this tool for manual/step-based tests. It stops short of explicitly naming xray_update_test_step or telling the agent which of gherkin vs unstructured to pick.

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