Zephyr: Get test executions linked to a Jira issue

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the safety profile is covered. The description adds the linked-to-issue scoping and an expected output note about keys and versions, but does not disclose behavior such as handling of empty results or pagination; this is adequate given the output schema and 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 a clear opening sentence, followed by a useful Toolset label and a concrete JSON example. The Parameters section duplicates schema content, adding minor redundancy, but overall the structure remains compact and scannable.

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?

This is a single-required-parameter read-only lookup with an output schema and a read/idempotent annotation profile. The description, example, and expected-output note together give an agent everything needed to invoke it correctly; no additional operational context is required.

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 issueKey already documented by type, required status, pattern, and a description. The description repeats the same parameter and provides an example ('PROJ-123'), which is mildly helpful but does not substantially extend the meaning already present in the schema.

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 first sentence states a specific verb ('Get') and resource ('test executions linked to a Jira issue in Zephyr'). The qualifier 'linked to a Jira issue' differentiates it from the more generic zephyr_get_test_executions and related link-oriented siblings, so an agent can determine the tool's scope without opening the schema.

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 use case is implied through the issueKey parameter and the example ('Check which test executions are linked to Jira issue PROJ-123'). However, the description never explicitly tells the agent when to choose this tool over alternatives such as zephyr_get_test_executions or zephyr_get_test_execution_links, and no when-not-to-use guidance is given.

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