link_issues_to_test_cases

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

Adds far more than the single idempotentHint annotation: additive-only behavior (never removes links), a 2500-unique-key cap checked locally before any request, the empty-body/HTTP 500 failure mode, and the return shape fallback ({ linked: n }). This is exactly the kind of hard-won behavioral context an agent needs.

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?

Front-loaded with purpose and packed densely; the KNOWN ISSUE and alternative are clearly flagged. It is a long run-on paragraph, but nearly every clause carries operational information, so it is appropriately sized rather than padded.

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?

There is no output schema, and the description compensates by describing the return value and its empty-body fallback. Combined with the limit, additive semantics, and failure-mode guidance, an agent has everything needed to invoke it correctly or fail over to the alternative.

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 coverage is 100% and the per-entry {testCaseKey, issueKey} shape is documented in the schema, so the baseline is 3. The description still adds real value by explaining the repeat-a-testCaseKey idiom for multi-linking and the 2500 UNIQUE key constraint, which the schema does not express.

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?

Starts with a specific verb+resource+scope: 'Link Jira issues to test cases in bulk', and even cites the endpoint. It is immediately distinguishable from siblings like update_test_case, jira_link_issues, and get_test_cases_linked_to_issue.

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?

Explicitly states when NOT to use it (the known HTTP 500 failure on many Server/DC builds) and names the concrete alternative path (update_test_case / create_test_case with issueLinks). It also explains the key semantic difference that the alternative REPLACES the link set versus this tool being additive.

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