Github List Pr Comments

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

Annotations already indicate readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds useful behavioral nuance beyond annotations: inline comments carry file and line information, and the tool is positioned to support follow-up review continuity. This is meaningful contextual behavior not present in the schema or 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?

The description is compact and front-loaded with the core action. The second sentence provides targeted value about inline comments, and the workflow pointer is a single line. No filler or redundant restatement of the title or schema.

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?

With an output schema present and annotations covering the read-only safety profile, the description does not need to document return values or side effects. It adds a workflow reference and clarifies the meaning of inline vs conversation comments. A small gap is the lack of guidance on pagination or large PRs, but the schema's page/per_page parameters partially cover this, so the description is reasonably complete for an agent.

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 only 33%, so the description should compensate for undocumented parameters. It does not explain repo_owner, repo_name, pr_number, page, or per_page beyond the generic phrase 'on a pull request.' The only parameter insight added is about inline comments carrying file/line, which overlaps with the schema's kind description. Required parameters are self-explanatory by name, but the description still leaves much of the parameter semantics to inference.

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 identifies a specific verb and resource: 'Lists the comments on a pull request.' It also clarifies the difference between conversation and inline comments by noting that inline comments carry file and line context. However, it does not explicitly differentiate this tool from sibling tools like github_list_pr_reviews, so it stops short of full sibling distinction.

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 workflow line 'github_get_skill('pr-review')' implies this tool fits into a PR review workflow and suggests the agent fetch a skill for conventions. This gives context but does not explicitly state when to prefer this tool over alternatives, nor does it mention exclusions or competing tools such as github_list_pr_reviews.

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