Get Issue Comments

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

Annotations already declare readOnlyHint=true and destructiveHint=false. Description adds value by disclosing pagination limits, warning thresholds, and error case for disabled issue tracker, providing behavioral context beyond annotations.

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?

Well structured with title, parameter list, return info, and note. Front-loaded with main purpose. Slightly verbose in parameter details but acceptable. Could be more concise.

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?

Given annotations and presence of output schema, description covers all necessary aspects: purpose, parameters, returns, error case, and pagination limits. No gaps identified.

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 has 0% description coverage, but description explains all 6 parameters with defaults and max recommendations. Adds meaning such as optional workspace and pagination constraints.

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 states 'List comments on an issue with pagination support' with specific verb and resource. Clearly distinguishes from siblings like get_issue_comment (single comment) and add_issue_comment.

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?

Clear context for using the tool: listing comments on an issue with pagination parameters. Includes warning about large fetches and error case. Does not explicitly mention when not to use or alternatives, but purpose is self-evident.

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