Adds a comment to a chosen paragraph in a live Word document, anchoring the note to that paragraph's text.
Add a comment to a paragraph (anchored on its text).
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | Comment text. | |
| index | Yes | Zero-based paragraph index to comment on. | |
| documentId | No | Target document ID from list_documents. Optional when only one document is connected. |
Changes observed during successful MCP inspections.
v0.6.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the full burden of behavioral disclosure. It mentions the anchoring behavior, which is useful, but does not describe permissions, mutation effects, error behavior for invalid indices, or what happens when documentId is omitted.
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 front-loaded sentence with no wasted words. It is appropriately sized for a simple targeted action.
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 and no output schema, this description is too sparse. It omits authorization needs, return behavior, and specifics about how the comment anchors to paragraph text, leaving important context 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 description coverage is 100%, so all three parameters are documented in the schema. The description adds the anchoring detail but no additional parameter meaning beyond what the schema already provides; 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 states a specific verb and resource: 'Add a comment to a paragraph,' and adds the anchoring detail. It is clear what the tool does, but it does not explicitly distinguish this from sibling tools like add_comment or read_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?
There is no guidance on when to use this tool versus alternatives such as add_comment or read_comments. Usage is only implied by the name and description; no exclusions or prerequisites are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.