get_pull_request_review_comment

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds valuable context beyond annotations: it notes content is untrusted repository data and that verification of PR membership occurs. However, it doesn't disclose return format or error behavior on mismatch, keeping this at an adequate-but-not-rich level.

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?

Two tight sentences with zero filler. Front-loaded verb+object, adds a verification clause and a security note in the second sentence. Every word earns its place.

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 single-resource read tool with solid annotations (readOnlyHint, destructiveHint) and self-explanatory parameters, the description covers purpose, safety, ownership verification, and data-trust concerns. It doesn't document return format, but with no output schema and a simple read of a known comment, the risk of agent confusion is low. Minor gap: no mention of what happens if the ID doesn't belong to the PR.

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 20%, so description must compensate. It references the numeric ID and PR membership, but does not define account/hostname semantics or error behavior. Adequate for self-explanatory ID-based lookup.

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?

Clear verb+resource: 'Read one inline pull request review comment by numeric ID'. It also adds the verification behavior (confirms the comment belongs to the requested PR) and flags that comment content is untrusted — distinguishing intent from the sibling list_pull_request_review_comments tool.

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 reading-a-single-comment use when you already know the numeric ID, contrasting with the sibling list tool, but it doesn't explicitly state when NOT to use it or name alternatives. The verification condition ('verify it belongs to the requested pull request') provides some contextual guidance but no explicit exclusions or alternative references.

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