github_pulls_get_review_comment

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

With no annotations, the description must disclose behavioral traits. It only states 'Get a review comment' without mentioning whether it is read-only, what happens if the comment_id is invalid, or any permissions needed. The minimal description fails to provide adequate transparency.

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 a single sentence, which is concise but lacks necessary structure and detail. It could be expanded with information about parameters or response behavior without becoming verbose.

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 simple tool with no output schema, the description should explain the return value or error cases. It does not mention that it returns a single review comment object, nor does it reference related endpoints. The context signals (3 required params, no enums) are not addressed.

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?

The input schema descriptions ('owner', 'repo', 'comment_id') are merely the parameter names, offering no real meaning. The tool description does not elaborate on what comment_id represents or how to obtain it. Schema coverage is 100% but with empty descriptions, so the tool description does not compensate.

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 'Get a review comment for a pull request' is specific, uses a clear verb-resource pair, and distinguishes this tool from siblings like create_review_comment, list_review_comments, and delete_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?

No guidance is provided on when to use this tool versus alternatives such as list_review_comments or update_review_comment. The description does not include context or exclusions.

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