ai.summarize_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. It only states a high-level action ('summarize') but does not mention that the operation is read-only, any permission requirements, output format, or edge cases (e.g., no comments). This is a significant gap for a tool with no annotation safety hints.

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, front-loaded sentence with no filler. Every word contributes to understanding the tool's purpose and audience, making it highly concise and well-structured.

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 3-parameter tool with an output schema, the description is minimally adequate. However, the lack of annotations and absence of any behavioral nuance (e.g., read-only nature, response type) leaves the agent without a complete picture. The output schema covers return values, but behavior and safety are under-specified.

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 description coverage is 0%, and the description does not compensate by explaining the parameters. The parameter names (owner, repo, issue_number) are self-explanatory, but the description adds no meaning beyond the schema, leaving the agent to infer how they relate to the summarization task.

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 uses a specific verb ('summarize') and a clear resource ('issue and its comment thread'), and the purpose ('so a newcomer can jump in') adds context. It is clearly distinct from siblings like github.get_issue (fetches raw issue) and ai.summarize_pr (summarizes pull requests, not issues).

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 'so a newcomer can jump in' indicates when the summary is useful, giving a clear usage context. However, it does not explicitly name alternatives or state when not to use this tool (e.g., when raw issue data is needed), though the purpose makes it fairly obvious.

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