get_issue_test_coverage

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

Annotations already declare readOnlyHint=true; description adds significant behavioral detail: composite read-only nature, multiple HTTP calls per case, null lastResult for unexecuted cases, and performance guidance (capping volume). No contradiction.

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?

Concise and well-structured: begins with core purpose, then explains composite API calls, null result behavior, and performance caveat. Every sentence adds value without redundancy.

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?

Despite no output schema, description effectively communicates input behavior, performance implications, and output semantics (null lastResult). Sufficient for agent understanding, though output format lacks explicit specification.

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 covers all 3 parameters (100% coverage), but description adds value by explaining the rationale behind maxCases (to limit HTTP calls) and clarifying defaults (50 for maxCases, true for includeLastResults). Links parameter purpose to tool behavior.

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?

Clearly describes the tool as a traceability report for a Jira issue, listing linked test cases with latest execution results. Distinguishes from sibling get_test_cases_linked_to_issue by including results, and from get_latest_result_for_test_case by aggregating multiple 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 implies usage for obtaining test coverage with results, and mentions volume capping with maxCases, but does not explicitly state when to use this over alternatives like get_test_cases_linked_to_issue or get_latest_result_for_test_case. No exclusion criteria provided.

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