Edit a document comment
edit_doc_commentRewrite the body of a comment this user wrote on a document.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Replacement Markdown body. | |
| commentId | Yes | The comment id. |
edit_doc_commentRewrite the body of a comment this user wrote on a document.
| 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 indicate destructiveHint=true and readOnlyHint=false, so the description need not restate that this is a mutation. The description adds the constraint 'this user wrote' (implying ownership), which is useful. However, it does not mention potential side effects, permissions required, or whether the comment must exist. With annotations covering the destructive nature, a 3 is appropriate.
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 a single, concise sentence without fluff, front-loading the action. It is efficient and easy to parse, though it could be slightly more informative about alternatives.
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?
Given the tool's low complexity (two parameters, no output schema, no nested objects), the description and annotations together are sufficient for an agent to call it correctly. It lacks explicit mention of preconditions (e.g., comment must exist, user must be author), but those are implied by 'this user wrote' and the schema's required body. The ownership scope is the main added context, and it is adequate.
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%, so the schema already documents both parameters ('Replacement Markdown body' and 'The comment id'). The description adds no extra semantic detail beyond what the schema provides, so the baseline of 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 states a specific verb ('Rewrite') and a clear resource ('the body of a comment this user wrote on a document'), which distinguishes it from comment creation and deletion. However, it does not explicitly differentiate from the sibling 'edit_comment', which likely performs a similar function on issues, so it is clear but not fully distinguishing.
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 implies usage for editing a comment's body, but it does not explicitly state when to use this tool versus alternatives like 'edit_comment' or 'delete_comment'. The restriction to 'this user wrote' provides some context but lacks explicit exclusions or alternative routing.
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.