Zephyr: Get Issue Link Test Cases

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and idempotentHint=true, covering the behavioral safety profile. The description adds no extra information about response format, pagination, or limits, which is acceptable for a simple read-only tool but doesn't add value beyond 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 succinct with a title, toolset label, parameter list, and an example. It front-loads the purpose. The parameter list redundantly repeats the schema, but overall it is well-structured and efficient.

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 tool's simplicity (one parameter, no nested objects, no output schema), the description suffices by stating the expected output in the example. It provides enough context for an agent to understand what the tool returns.

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 covers the single parameter 'issueKey' with a description and pattern. Schema description coverage is 100%. The description and example add no new semantic meaning beyond the schema, so baseline 3 applies.

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 'Get test cases linked to a Jira issue in Zephyr', specifying the verb, resource, and relation. It distinguishes from sibling tools like zephyr_get_test_case_links (which gets links for a test case) by focusing on test cases linked to an 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?

The example shows a clear use case (checking linked test cases for issue PROJ-123). While it doesn't explicitly state when not to use or compare with alternatives, the context of sibling tools and the specific name make the usage clear. A minor improvement would be to mention that this retrieves only test cases, not test cycles or executions.

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