get_issue

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. While 'Get' implies a read-only operation, the description does not explicitly state that it performs no mutations, nor does it mention authentication requirements, rate limits, or response structure. It adds minimal behavioral context beyond the operation name.

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?

One sentence plus a documentation link. Extremely concise and front-loaded, with every word earning its place. No redundancy or filler.

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 tool has only three required parameters and no output schema. While it is a simple operation, the description does not explain what the response contains or any edge cases (e.g., 404 for non-existent issue). Given no annotations, the description would benefit from mentioning the return value to be fully 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?

The input schema provides full descriptions for all three parameters (owner, repo, issue_number) at 100% coverage. The tool description adds no parameter-specific semantics beyond what the schema already documents, so the baseline score of 3 applies.

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 it retrieves a single issue from a GitHub repository using the verb 'Get' and a specific resource. It distinguishes from sibling tools like list_issues (which lists multiple) and update_issue (which modifies), making its scope unambiguous.

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 guidance is given on when to use this tool versus alternatives. The description implies it is for fetching a specific issue by number, but does not mention when to prefer list_issues or other tools, nor does it provide exclusions. The docs link is helpful but not in-description guidance.

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