get_issue

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

No annotations are provided, so the description must carry the burden of behavioral disclosure. It does not mention that the operation is read-only, requires any specific permissions, or has no side effects. It only describes the return content (full detail, comment thread), which does not cover safety or authorization aspects.

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 a single, efficient sentence of 13 words. It avoids redundancy and directly conveys the tool's purpose without filler, scoring high on conciseness.

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?

For a simple read tool with three obvious parameters, the description provides the essential purpose and mentions the comment thread as a key return component. However, with no output schema and no annotations, it does not detail the full return structure or any error/rate-limit behavior, leaving some gaps in completeness.

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 schema describes owner and repo (67% coverage), but the description adds no additional meaning for any parameter. The missing issue_number description is somewhat inferable from the name, and the tool description's 'one issue' hints at its role, but there is no explicit compensation for the coverage gap.

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 verb 'Get' and resource 'one issue', specifying that it retrieves full detail including the comment thread. This distinguishes it from sibling tools like list_issues (which lists issues) and get_pull_request (which gets a pull request).

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 phrase 'for one issue' implies this is for retrieving a single issue rather than listing multiple, but it does not explicitly mention alternatives like list_issues or exclusions for when not to use it. Usage context is present but only implied.

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