Link requirements to a test case

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

No annotations are provided, so the description must fully disclose behavior. It only states the action and resource, without mentioning whether linking overwrites existing links, idempotency, confirmation side effects, or authorization requirements. The minimal disclosure limits the agent's ability to anticipate outcomes.

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 a single sentence that directly communicates the core purpose without any extraneous words. It is front-loaded with the key action and resource, making it easy to parse.

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 description is minimal given the complexity of a linking operation. It does not explain the return value or error conditions, and with no output schema, the agent lacks information on what to expect after invocation. Annotations are absent, leaving behavioral gaps unfilled.

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?

All three parameters have descriptions in the input schema (100% coverage), explaining their purpose clearly. The tool description does not add additional semantic context beyond the schema. With full schema coverage, the baseline score of 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?

The description clearly states the action ('Link') and the resources ('requirements (Jira issues)' to 'a specific test case in Qmetry'). It distinguishes from sibling tools like 'link-requirements-to-test-cycle' which targets test cycles instead. The verb and resource are specific and unambiguous.

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 description implies the tool is for linking requirements to a test case, but it does not provide explicit guidance on when to use this tool versus alternatives (e.g., linking to a test cycle or unlinking). No exclusion criteria or when-not-to-use are mentioned, leaving the agent to infer context from sibling names.

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