Zephyr: Get Test Case Links

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

The description adds value beyond annotations by specifying that the tool returns both issue links and web links. Annotations already declare readOnlyHint=true, destructiveHint=false, and idempotentHint=true, so the tool's safety profile is clear. The description does not contradict annotations and provides additional detail about what is retrieved.

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 concise and well-structured with a clear one-liner, toolset header, parameter list, and example. Every sentence serves a purpose and there is no redundant information. The format is front-loaded and easy to scan.

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 has a single parameter, read-only annotations, and an output schema, the description is complete. It explains what links are returned, provides an example, and mentions the expected output. No additional details are necessary for an agent to correctly use the tool.

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%, so the baseline is 3. The description repeats the parameter format and provides an example ('SA-T10'), which is helpful but does not add substantial meaning beyond the schema's pattern constraint. The example aids understanding but does not justify a higher score.

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 resource ('test case in Zephyr'), specifying exactly what types of links are returned ('issue links and web links'). This distinguishes it from sibling tools like zephyr_get_test_case, zephyr_get_test_case_steps, and zephyr_get_test_cycle_links.

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 does not explicitly state when to use this tool versus alternatives. While the purpose is clear, there is no guidance on scenarios where this tool should be preferred over zephyr_get_test_cycle_links or zephyr_get_test_execution_links. The usage context is implied but not explicitly addressed.

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