Edit an issue comment
edit_commentRewrite the body of a comment this user wrote on an issue.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Replacement Markdown body. | |
| commentId | Yes | The comment id. |
edit_commentRewrite the body of a comment this user wrote on an issue.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Replacement Markdown body. | |
| commentId | Yes | The comment id. |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already signal mutating/destructive behavior (readOnlyHint=false, destructiveHint=true), so the description does not need to restate that. It adds an ownership constraint ('this user wrote') that is not captured in the schema or annotations, adding some behavioral context. No additional side effects, rate limits, or irreversibility details are given.
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?
One short sentence that front-loads the action and scope with no filler. It earns its place and remains readable.
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 two-parameter mutation with destructive annotations, the description plus schema covers the essential calling context. It does not describe the return value or side effects beyond body replacement, but that is a minor gap for this simple operation.
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 100%, with both commentId and body already described meaningfully. The description adds no parameter-level nuance beyond saying the body is rewritten, which matches the schema. Baseline 3 is appropriate.
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 names the exact action ('Rewrite'), the resource ('body of a comment'), and the scope ('this user wrote on an issue'). This distinguishes it from delete_comment and edit_doc_comment without needing schema inspection.
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?
It clearly conveys this is for replacing the body of an existing issue comment, and the 'this user wrote' qualifier tells the agent it applies to the user's own comments. It does not explicitly name alternatives or when-not-to-use, but the issue-comment scope makes the context clear among siblings.
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.