github.comment.add

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

No annotations are provided, so the description bears full responsibility. It clearly discloses that the tool creates a pending action requiring admin approval, which is a critical behavioral trait. However, it does not mention any return values or side effects beyond approval.

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 extremely concise, consisting of two short sentences that convey the purpose and a key behavioral note. No unnecessary words or repetition.

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?

While there is no output schema, the description adequately explains the tool's purpose and the pending-approval behavior. The sibling tools provide context for the approval workflow, but the description could be improved by mentioning what the tool returns or how to reference the created action.

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 100% coverage with descriptions for all four parameters. The description adds no additional meaning beyond what the schema already provides, earning a baseline score of 3.

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 it adds a comment to a GitHub issue or pull request, with a specific verb and resource. The mention of 'v1.0.0' and 'pending action that requires admin approval' distinguishes it from sibling tools like github.issues.create or github.pr.open, which create issues or PRs rather than comments.

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 indicates that the action is created as a pending action requiring admin approval, implying that the comment will not be immediately visible. This provides context for when to use the tool, but it does not explicitly state when to use this tool versus alternatives like editing a comment or replying directly.

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