get_issue_relation

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

No annotations provided; description only states 'gets details' without revealing idempotency, side effects, or other behavioral traits. Minimal disclosure for a read operation.

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?

Single sentence, direct and front-loaded. No unnecessary words.

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?

Description covers the basic purpose but lacks output details. Given no output schema, knowledge of return fields would be helpful. Adequate for simple retrieval but could be more complete.

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 already fully describes parameter 'id' as 'Numeric relation ID'. Description adds no extra meaning beyond 'by its ID'. Baseline 3 due to high schema coverage.

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?

Description clearly states 'Gets details of a single issue relation by its ID' with specific verb and resource. Distinct from sibling tools like list_issue_relations (list all) and create/delete.

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?

No explicit when-to-use or when-not-to-use guidance. Implied that it's for retrieving a single relation by ID, but no contrast with list_issue_relations or prerequisites.

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