Zephyr: Get Test Case Links

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

The annotations already indicate the tool is read-only, idempotent, and non-destructive. The description does not add any behavioral traits beyond these annotations; it only repeats the functional purpose. No additional details about side effects, authentication, or limitations are provided.

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 with a two-sentence purpose, clear parameter listing, and a well-formatted example. It is front-loaded with the core action. However, the 'Toolset: Test Cases' line is somewhat redundant given the tool name.

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?

The description adequately explains what the tool does and provides a complete example. An output schema exists (not shown), so return values are presumably documented. No prerequisites or error conditions are mentioned, but for a simple retrieval tool, the context is sufficient.

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 provides full coverage (100%) with a description and pattern for testCaseKey. The description reinforces this with a concrete example (using 'SA-T10'), which adds practical value beyond the schema's formal definition.

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 tool retrieves all links (issue links and web links) for a test case, using specific verb 'Get' and resource 'links associated with a test case'. It distinguishes itself from sibling tools like zephyr_get_test_case or zephyr_get_test_case_steps by focusing solely on 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 implies the tool should be used when needing to retrieve links for a test case, but it does not explicitly state when to use it versus alternatives (e.g., creating links) or provide exclusion criteria. The context is clear but lacks explicit guidance.

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