doc-control

Overview Schema Source Related Servers Discussions Admin

comment_list

Read-onlyIdempotent

List comments in thread order with id, author, date, text, resolved state, and location; filter by resolved or author. Use ids to reply or resolve; read-only and paged.

Instructions

List the comments in thread order (each root comment, then its replies) with id, author, date, text (clipped at 1,000 characters), 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. 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

TableJSON 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

TableJSON 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.

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.6/5.0

Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, so the safety profile is covered. The description adds real behavioral context beyond that: comments include those in notes and headers, text is clipped at 1,000 characters, and responses are paged with a ~8,000-byte cap and `cursor` continuation. The only repetition is the 'Read-only' statement, which annotations already supply.

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?

Purpose and return shape are front-loaded, and nearly every clause carries information (ordering, clipping, filters, paging, sibling routing). It reads as one long run-on sentence, so structure is dense rather than broken into scannable units.

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?

For a read-only list tool with an output schema present and 100% schema coverage, the description covers the remaining agent-critical facts: ordering semantics, content clipping, paging continuation, and where to go next for related operations. Nothing needed to call it correctly 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 the baseline is 3. The description adds matching semantics the schema leaves implicit: `author` is an exact match, and `cursor` must be set to the previous reply's `next` value. The `resolved` true/false explanation largely restates 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?

The opening clause gives a specific verb and resource ('List the comments') plus the ordering model ('thread order: each root comment, then its replies') and the exact fields returned. It explicitly separates itself from revision.list for tracked changes, so an agent can distinguish it from siblings without opening the 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?

It states the filters (`resolved` true/false, `author` exact) and routes the agent onward: use the returned ids to reply/resolve via doc.batch (comment.reply, comment.resolve), and use revision.list instead for tracked changes. The when-not condition (tracked changes) and the alternative are named explicitly.

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

Deploy Server