get_issue

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

No annotations provided, but the description is accurate and clarifies the parameter semantics (index vs id). It does not disclose side effects, but for a read-only operation this is sufficient.

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 with a brief clarification, no wasted words. Front-loaded with the core action.

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?

Adequately covers the purpose and parameter meaning for a simple get tool. Mentions what can be read. Could mention response format but not required since no output schema.

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?

Adds significant meaning beyond schema by explaining that index is the number in the URL (e.g., #42) and not the internal id, and by listing what can be read (body, labels, assignee, milestone).

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 tool fetches one issue by its index, distinguishing it from siblings like list_issues and search_issues. It specifies the resource and key parameter.

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?

Explicitly states when to use ('use to read the full body, labels, assignee, or milestone of a single issue') and clarifies the index parameter's meaning, helping the agent choose correctly.

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