get_pull_request_review_thread

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

The description complements the readOnlyHint=true and destructiveHint=false annotations by adding meaningful behavioral context: it reveals the tool performs verification of the repository and PR against the node ID, pages through comments, and that all returned content is untrusted repository data. This security warning is valuable behavioral transparency beyond what annotations provide.

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 sentences, zero waste. The first sentence packs the core function, the second adds an essential security caveat. 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?

With readOnly annotations and no output schema, the description covers the key behavioral aspects (verification, pagination, data trust). It's reasonably complete for a read-operation tool. However, given low schema coverage and no output schema, it could have briefly explained what the comments page returns or how pagination works. Still, it's largely adequate for a read-only tool with good annotations.

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 14%, so the description carries a heavy burden to explain parameters. However, it only mentions reviewThreadId, repository, and pullRequestNumber obliquely ('verify its repository and pull request'), leaving account, hostname, commentsAfter, and commentsFirst largely unexplained. The pagination parameters (commentsAfter, commentsFirst) aren't explained at all despite being non-obvious.

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 clearly states the tool's function: 'Read one review thread by GraphQL node ID, verify its repository and pull request, and page through all comment bodies.' It uses a specific verb (read) with a resource (review thread), and the verification step distinguishes it from siblings like list_pull_request_review_threads and get_pull_request_review_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?

The description implies usage by describing the verification of repository and pull request and pagination behavior, but it doesn't explicitly state when to use this vs alternatives like get_pull_request_review_comment. The security caveat ('untrusted repository data') provides some context but there are no explicit when-to-use or when-not-to-use guidelines.

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