Zephyr: Get Issue Link Test Cases

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

Annotations already declare readOnly, idempotent, and non-destructive behavior, so the description's burden is lighter. It adds useful return-shape context by stating the output is a list of linked test cases with their keys and versions. It does not cover auth or pagination, but that is acceptable for this simple read operation.

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 well-organized with a clear purpose sentence, a compact parameters list, and a worked example. The parameters block is somewhat redundant with the JSON schema, but the example and expected-output note keep the added length worthwhile.

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?

For a one-parameter read operation with full annotations and an output schema, the description provides everything needed: the input, a valid example, and a summary of the result. An explicit sibling comparison would be a refinement, not a real 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?

Schema coverage is 100%, with the issueKey description and pattern already defined. The description essentially repeats the schema and only adds a concrete PROJ-123 example, so it provides little semantic value beyond what the schema already conveys.

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 states a specific verb ('Get'), resource ('test cases linked to a Jira issue'), and platform ('in Zephyr'), which cleanly distinguishes it from siblings that return cycles or executions linked to an issue. The example with PROJ-123 reinforces the exact purpose.

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?

Clear context is given: use this when you need the test cases associated with a Jira issue key. The example shows the exact invocation pattern. It does not explicitly mention alternatives or exclusions, but the one-parameter read-only scope makes the intended use obvious.

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