get_pr_comment

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

There are no annotations, so the description carries the full burden of disclosing behavior. It states only 'Get', which implies a read operation, but does not disclose return format, error behavior, authentication needs, or whether the comment is a general PR comment or an inline review comment. This is a clear gap for a tool with no structural 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?

A single sentence with no wasted words, completely front-loaded and easy to parse. It contains exactly one clause that names the operation and the resource.

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 description is minimally sufficient for a simple fetch-by-ID operation, and all three required parameters are documented in the schema. However, without annotations or an output schema, important context is missing: what the returned comment object looks like, whether the comment may be unresolved or deleted, and how it relates to list_pr_comments. An agent could invoke it correctly, but it would be guessing about the response.

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 100%, with repo_slug, pr_id, and comment_id each carrying a short description. The description adds no additional meaning to parameters, so it rightfully rests on the schema's definitions; the baseline of 3 applies because the schema does the heavy lifting.

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 the specific verb 'Get' with a clear resource ('a specific comment on a pull request'), and the word 'specific' distinguishes it from list_pr_comments among siblings. However, it does not explicitly name the alternative or state the unique identifier that selects the comment, so it stops short of the level of differentiation seen in the highest-caliber definitions.

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?

No guidance is given about when to use this tool versus alternatives such as list_pr_comments, add_pr_comment, or update_pr_comment. There is no mention of prerequisites, exclusions, or context that would tell an agent which sibling to choose; the usage context is only implicit from the brevity of 'Get a specific comment'.

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