link_issues_to_test_cases

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

The annotation idempotentHint: true already signals idempotency. The description adds valuable behavioral context: the local validation of the limit before sending the request. This goes beyond the annotation, though it does not detail error handling or response format.

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 paragraph of three sentences. It is front-loaded with the purpose and endpoint, then explains entry semantics and the limit. Every sentence adds value with no redundancy or fluff.

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?

Given the lack of an output schema, the description does not explain the response format or behavior when links already exist. While the usage and limit are covered, the agent lacks information about the return value, which is a 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?

The input schema has 100% description coverage, so the baseline is 3. The description adds meaning by explaining the linking pattern (repeat testCaseKey for multiple issues) and providing concrete examples (PROJ-T123, PROJ-123), enhancing understanding beyond the schema.

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 tool links Jira issues to Zephyr Scale test cases in bulk, providing the HTTP method and endpoint. However, it does not explicitly differentiate itself from the sibling tool 'get_test_cases_linked_to_issue', which retrieves links rather than creating them.

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 explains when to use the tool (for bulk linking), provides the API limit of 2500 unique test case keys per call, and illustrates how to link multiple issues to one test case by repeating keys. It lacks explicit exclusion criteria or alternatives, but the context is clear.

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