list_issue_comments

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

The readOnlyHint annotation already covers safety, and the description adds the useful behavioral scope that this endpoint covers both issues and pull requests. Pagination behavior is not described, but the page/limit parameters and the available output schema reduce the impact of that gap.

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, front-loaded with the verb and resource, with no wasted words. The clarifying phrase 'issue or pull request' earns its place by conveying the non-obvious scope of the endpoint.

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 output schema covers return structure and the readOnlyHint covers safety, so those burdens are handled elsewhere. However, with 0% schema description coverage and five parameters, the description is too sparse to fully enable correct invocation, especially around the 'index' parameter and the exact distinction from pull request review comments.

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%, so the description needed to carry parameter meaning, but it does not explain any parameter. In particular, 'index' is ambiguous and could be mistaken for a comment index rather than an issue/PR number, and no mapping of owner/repo/index to the resource is provided.

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 ('List') and a clear resource ('comments on an issue or pull request'), correctly scoping the operation. It distinguishes this from comment creation/editing/deletion and, by using 'comments' rather than 'review comments', from the sibling list_pull_review_comments.

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 description implies the tool is for retrieving general comments on an issue or pull request, but it does not explicitly state when to prefer it over list_pull_review_comments or mention exclusions. An agent is left to infer the boundary between general issue comments and pull request review comments.

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