comment
Comment on a listed repo (markdown, ≤ 4000 chars, ≤ 2 links). Needs a bearer token. Flagged comments are held for a moderator.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| repo | Yes | ||
| owner | Yes | ||
| parent_id | No |
Comment on a listed repo (markdown, ≤ 4000 chars, ≤ 2 links). Needs a bearer token. Flagged comments are held for a moderator.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | ||
| repo | Yes | ||
| owner | Yes | ||
| parent_id | No |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden and does well: it discloses the auth requirement (bearer token), content limits (markdown, 4000 chars, 2 links), and the moderation behavior ('flagged comments are held for a moderator'). It omits return/error behavior and whether the write is reversible, keeping it from a 5.
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?
A single dense sentence with the core action front-loaded, followed by content limits, auth, and moderation behavior. No filler clauses; every fragment conveys a distinct constraint.
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 mutation tool with no annotations, no output schema, and 0% schema coverage, the description covers auth, content constraints, and moderation queuing but omits the threading parameter, response shape, and failure modes. Adequate but with clear gaps.
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 coverage is 0%, so the description must compensate. It partially does: the format/length/link constraints clearly bound the `body` parameter and 'listed repo' bounds owner/repo. However, the `parent_id` parameter (reply threading) is never mentioned anywhere, leaving a required-knowledge gap.
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 uses a specific verb (Comment) and resource (a listed repo), and adds concrete scope constraints: markdown format, ≤4000 chars, ≤2 links. It does not explicitly name or distinguish itself from siblings like report or vote, so it stops short of a 5.
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 phrase 'on a listed repo' implies a precondition (the repo must already be listed) and 'Needs a bearer token' signals an auth prerequisite, but there is no explicit when-to-use vs. when-not-to-use guidance and no mention of alternatives such as report or vote.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.