Comments and tracked changes
document_commentsComments (author, text, anchor, resolved) and tracked changes — up to 50.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
document_commentsComments (author, text, anchor, resolved) and tracked changes — up to 50.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description must carry the burden of behavior disclosure. It adds useful constraints such as 'up to 50' and lists the fields returned, but it never explicitly states that this is a read-only operation or what happens when the cap is exceeded.
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 compact phrase with no filler. It front-loads the key content and the important limit, which is appropriate for a zero-parameter tool.
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?
Since there is no output schema and no annotations, the description should fully explain what is returned. It covers comment fields and the cap, but it does not specify the structure of tracked changes, the output format, or the read-only nature, leaving some 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?
This tool has zero parameters, so there are no parameter semantics to document; the baseline of 4 applies. The 'up to 50' limit refers to output size, not input, so no further parameter explanation is needed.
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 identifies the subject area: comments (with author, text, anchor, resolved) and tracked changes, capped at 50. It is not vague, but it lacks an explicit action verb such as 'returns' or 'lists,' and it does not differentiate from sibling tools, so it falls 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?
There is no guidance about when to use this tool instead of document_read, document_describe, or document_apply. Usage context is only implied by the noun phrase, with no exclusions, prerequisites, 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.