QMetry: Link Issues to Testcase Run

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

Annotations already mark this as a mutating, non-idempotent operation; the description adds an output description and warns about the exact 'tcrId' parameter name. It does not expand on side effects like whether existing links are preserved, but the annotated safety profile plus examples give enough behavioral context.

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 front-loaded with a one-line summary, then organized into short labeled sections; the examples and hints are useful. It repeats some schema content and the generic Output Description is low-value, so it is not maximally tight.

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?

For a mutation tool without an output schema, it includes output shape, multiple worked examples, and step-by-step hints for sourcing the two required IDs. Missing specifics on error behavior and exact JSON fields are minor given the clear examples.

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?

The schema already documents all parameters, so baseline is 3, but the description's Hints add real value: it explains how to resolve issue keys to IDs, which companion tool returns issueIds and which returns tcrId, and the example shows correct JSON. The only concern is that the parameter text says tcrId accepts a string or number while the schema types it as number, a minor source of ambiguity.

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 opening sentence states a specific action (Link) against a concrete resource (QMetry Testcase Run) and clarifies scope ('one or more issues'). The examples and 'Automate defect association during test execution' use case reinforce that this is the issue-to-test-execution linking tool, distinct from requirement/test-case linking siblings such as qtm4j_link_requirements_to_test_case.

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?

Use Cases and Hints provide clear context: linking single/multiple issues, defect association, and traceability. It gives retrieval instructions for required IDs from companion tools but does not explicitly say when not to use it or name a sibling alternative, so it falls short of a full exclusion statement.

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