Link Defect To Test Case

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

Annotations already indicate idempotentHint=true and destructiveHint=false. The description adds value by explaining the concept of 'shared issue mapping' and the operational context (linking issue to defect and test case). However, it does not disclose potential side effects or error cases beyond the annotations.

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 two sentences long, front-loaded with the core action, and contains no fluff. Every sentence serves a clear purpose in explaining the tool's function and context.

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 6 parameters (2 required) and no output schema, the description explains the core operation but lacks details on return values, error handling, or behavior with optional parameters like issue_key or integration settings. It is minimally complete but leaves gaps for a user expecting comprehensive guidance.

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 the description does not add meaning beyond the schema's parameter descriptions. It mentions 'shared issue mapping' but does not elaborate on parameter usage, mutual exclusivity, or default behaviors beyond what the schema already provides.

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 verb 'link' and resources 'defect to test case', distinguishing it from sibling tools like link_shared_step. It specifices the mechanism ('through a shared issue mapping') and the purpose (ensuring defect governance and test coverage).

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 mentions 'ensures defect governance and test coverage are connected' but does not explicitly state when to use this tool versus alternatives (e.g., linking via other methods). No guidance on when not to use it or prerequisites.

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