github_create_pr_comment

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the action ('Add a comment') but does not disclose whether authentication is required (only implied by the session_name parameter), how the comment interacts with PR state, or any potential side effects. No mentions of rate limits, response format, or error conditions.

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: one sentence for purpose followed by a clean parameter list. Each line earns its place, and the structure is front-loaded with the primary action. No redundant or filler content.

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 tool is a simple single action, and the description covers the operation and all parameters. Since an output schema exists, return values need not be explained. However, it lacks any mention of when to use this vs issue comments and does not explicitly state authentication prerequisites, though session_name is a strong hint. Overall, moderately complete for its simplicity.

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 has 0% description coverage, so the description compensates by listing each parameter with a concise meaning. It adds useful details: 'body' notes markdown support, 'session_name' clarifies it selects a GitHub session, and the owner/repo/pr_number definitions are functional. This provides value beyond the bare schema.

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 'Add a comment on a pull request' with a specific verb and resource. This distinguishes it from sibling tools like github_create_issue_comment (comments on issues) and github_list_pr_reviews (review listings). The purpose is unambiguous.

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 github_create_issue_comment or other PR comment-related operations. There are no exclusions, prerequisites, or contextual hints about when this tool is appropriate.

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