doc-control

Overview Schema Source Related Servers Discussions Admin

comment_list

Read-onlyIdempotent

Instructions

List the comments in thread order (each root comment, then its replies) with id, author, date, text (clipped at 1,000 characters), quote (the text the comment covers, clipped at 200), resolved state and the address where each starts, including comments in notes and headers. Filter with resolved (true or false) and author (exact). Use the ids to reply or resolve with doc.batch (comment.reply, comment.resolve); use revision.list for tracked changes instead, review.list for comments and changes together by paragraph. Read-only; paged: a reply is capped at about 8,000 bytes (limit up to 1,000), continue with cursor set to the reply's next.

Input Schema

Name	Required	Description
`doc`	Yes	Path to the .docx.
`limit`	No	Most items to return; a response is also capped at about 8,000 bytes.
`author`	No	Only this author.
`cursor`	No	The `next` value of the previous response, to continue the list.
`resolved`	No	Only resolved (true) or open (false).

Output Schema

Name	Required	Description
`ok`	Yes	Always true on success.
`op`	Yes	The operation that ran.
`api`	Yes	API version (1.0).
`doc`	No	The document read or written: path, sha256 and paragraph count.
`next`	Yes	Cursor for the next page (pass as cursor), or null.
`result`	Yes	What the operation returns.
`warnings`	Yes	Things to know about the result.

Schema Changelog

Changes observed during successful MCP inspections.

Changed2 schema fields changedv0.10.1Oct 22, 2026

addedOutput schema / properties / result / properties / comments / items / properties / quote

Added value: +{
+  "description": "Text its range covers as the document reads now (insertions in, deletions out), clipped at 200 characters; \"\" for a comment on a point.",
+  "type": "string"
+}

addedOutput schema / properties / result / properties / comments / items / properties / quote_truncated
```
Added value: +{
+  "description": "True when quote was clipped.",
+  "type": "boolean"
+}
```

Changed1 schema field changedv0.7.2Oct 15, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "api": {
+      "description": "API version (1.0).",
+      "type": "string"
+    },
+    "doc": {
+      "description": "The document read or written: path, sha256 and paragraph count.",
+      "properties": {
+        "characters": {
+          "description": "text.normalize of a text string: its length.",
+          "type": "integer"
+        },
+        "paragraphs": {
+          "description": "Body paragraphs.",
+          "type": "integer"
+        },
+        "path": {
+          "description": "Path of the document.",
+          "type": "string"
+        },
+        "sha256": {
+          "description": "sha256 of the file (pass as expect.sha256 to a write).",
+          "type": "string"
+        },
+        "source": {
+          "description": "A .txt/.md/.odt source's format, encoding and split mode; \"text\" for a text string (text.normalize).",
+          "type": [
+            "object",
+            "string"
+          ]
+        }
+      },
+      "type": "object"
+    },
+    "next": {
+      "description": "Cursor for the next page (pass as cursor), or null.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "ok": {
+      "description": "Always true on success.",
+      "type": "boolean"
+    },
+    "op": {
+      "description": "The operation that ran.",
+      "type": "string"
+    },
+    "result": {
+      "description": "What the operation returns.",
+      "properties": {
+        "comments": {
+          "description": "This page of comments, each root then its replies.",
+          "items": {
+            "description": "A comment.",
+            "properties": {
+              "at": {
+                "description": "Address of the paragraph where its range starts.",
+                "type": "string"
+              },
+              "author": {
+                "description": "Author.",
+                "type": "string"
+              },
+              "date": {
+                "description": "Date (ISO 8601).",
+                "type": [
+                  "string",
+                  "null"
+                ]
+              },
+              "id": {
+                "description": "Comment id.",
+                "type": "string"
+              },
+              "reply_to": {
+                "description": "Id of the comment it answers.",
+                "type": "string"
+              },
+              "resolved": {
+                "description": "Marked done.",
+                "type": "boolean"
+              },
+              "story": {
+                "description": "footnote, endnote, header or footer when not in the body.",
+                "type": "string"
+              },
+              "text": {
+                "description": "Text, clipped at 1,000 characters.",
+                "type": "string"
+              },
+              "truncated": {
+                "description": "True when text was clipped.",
+                "type": "boolean"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "total": {
+          "description": "Items in the whole list, across pages.",
+          "type": "integer"
+        }
+      },
+      "required": [
+        "total",
+        "comments"
+      ],
+      "type": "object"
+    },
+    "warnings": {
+      "description": "Things to know about the result.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "api",
+    "ok",
+    "op",
+    "result",
+    "warnings",
+    "next"
+  ],
+  "type": "object"
+}

Addedv0.1.3Oct 15, 2026

TDQS

A4.8/5.0

Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare read-only and idempotent, and the description adds material context beyond them: thread ordering, note/header inclusion, text clipping limits (1,000 / 200 chars), and paging behavior with the ~8,000-byte cap and cursor continuation. That is the kind of behavior an agent cannot infer from structured fields.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Information is front-loaded: purpose and return fields first, then filters, then alternatives, then paging. It is a single dense block and the paging clause is folded into the same sentence as the read-only note, which slightly hurts scanability, but nearly every clause carries unique information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, yet the description still tells the agent what fields matter and their truncation limits, and it covers filters, paging, and tool routing. Nothing needed to invoke this correctly on a 5-parameter tool is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3, but the description adds matching semantics the schema does not: 'author (exact)' tells the agent this is not a partial/fuzzy match. It also restates cursor continuation and resolved filtering, which is mildly redundant with the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb and resource plus the ordering semantics ('List the comments in thread order (each root comment, then its replies)'), then enumerates the returned fields. It explicitly distinguishes itself from revision.list and review.list, so an agent can route correctly without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Names concrete alternatives and the conditions that select them: use ids to reply/resolve via doc.batch (comment.reply, comment.resolve), revision.list for tracked changes, review.list for comments and changes together by paragraph. Both 'when to use' and 'when to use something else' are stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server