Zephyr: Get Test Case Links

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, covering the safety profile. The description adds that the result contains both issue links and web links and provides an expected-output note, but it does not go beyond that to disclose pagination, filtering, authentication, or other behavioral nuances. This matches the lower bar set by the strong 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 front-loaded with the main purpose, but it becomes repetitive: the Toolset label adds little, the parameter section duplicates the schema, and the Expected Output sentence restates the purpose. The structure is organized, but the length is not fully justified for such a simple one-parameter tool.

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 one clear required parameter, a full input schema, strong annotations, an output schema, and a concrete example, the description is complete enough for correct invocation. Nothing critical is missing for an agent to select and call this tool properly.

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 testCaseKey parameter already described in both schema and description. The description repeats the format and provides an example, but adds no meaningful semantic beyond what the schema already gives, so the baseline of 3 is appropriate.

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 action ('Get all links') and the resource ('associated with a test case in Zephyr'), and specifies that both issue links and web links are returned. This distinguishes it from sibling link-retrieval tools such as zephyr_get_test_cycle_links or zephyr_get_test_execution_links by anchoring it specifically to test cases.

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 gives clear context for when to use the tool: when you need link data for a test case key. It does not explicitly name alternative tools or exclusions, but the resource scope ('associated with a test case') is precise enough for an agent to infer appropriate selection among the similar sibling tools.

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