Github Add Pr Comments

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

Annotations already convey that this is a non-read-only, non-idempotent, non-destructive action. The description adds a workflow hint but no additional behavioral detail such as permissions, side effects, or rate limits, so it provides little value beyond the annotations.

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 short and front-loaded, with the main action in the first sentence and a useful workflow pointer in the second. It could be considered slightly too terse, but every sentence earns its place and there is no redundancy.

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 annotations and an output schema, this is minimally viable. However, it lacks parameter descriptions and does not clarify whether this adds a top-level comment versus an inline comment, which is relevant given the sibling tool github_add_inline_pr_comment.

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 0%, and the description does not explain any parameter semantics. It does not mention that 'comment' is the body text, how repo_owner/repo_name/pr_number are used, or any format expectations, leaving the parameters entirely self-explanatory by name.

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 states a clear action and resource: 'Adds a comment to a specific pull request.' It is specific enough to identify the operation, but it does not explicitly distinguish this from the sibling github_add_inline_pr_comment, which is a closely related 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 'Workflow and conventions: github_get_skill("pr-review")' line implies this tool should be used as part of the pr-review workflow, giving some contextual guidance. However, it does not explicitly state when to prefer this over alternatives like github_add_inline_pr_comment or github_reply_to_review_comment.

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