doc-control

Overview Schema Source Related Servers Discussions Admin

revision_list

Read-onlyIdempotent

List tracked changes in a .docx by type or author, returning IDs, details, and text so you can accept or reject specific edits.

Instructions

List the tracked changes (insertions, deletions, moves, formatting, table rows and cells) in document order, each with id, type, author, date, paragraph address and text (clipped at 200 characters). Filter by author or type; stories notes or headers adds their changes. Use the ids with revision.accept or revision.reject; doc.stats counts changes by type. Read-only; paged: about 8,000 bytes per reply (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.
`type`	No	Only this type.
`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.
`stories`	No	Stories to list (default ["body"]): "notes" adds footnotes and endnotes, "headers" headers and footers, after the body's revisions; their addresses carry a prefix (fn3/p1#…, hdr1.default/p1#…). Row and cell revisions are listed for the body's tables only.

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": {
+        "revisions": {
+          "description": "This page of tracked changes, in document order.",
+          "items": {
+            "description": "A tracked change.",
+            "properties": {
+              "at": {
+                "description": "Address of its paragraph.",
+                "type": "string"
+              },
+              "author": {
+                "description": "Author.",
+                "type": "string"
+              },
+              "date": {
+                "description": "Date (ISO 8601).",
+                "type": [
+                  "string",
+                  "null"
+                ]
+              },
+              "id": {
+                "description": "Revision id (for revision.accept / revision.reject).",
+                "type": "string"
+              },
+              "story": {
+                "description": "footnote, endnote, header or footer when not in the body.",
+                "type": "string"
+              },
+              "text": {
+                "description": "Text it inserts or deletes, clipped at 200 characters.",
+                "type": "string"
+              },
+              "truncated": {
+                "description": "True when text was clipped.",
+                "type": "boolean"
+              },
+              "type": {
+                "description": "insert, delete, move_from, move_to, format, row_insert...",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "total": {
+          "description": "Items in the whole list, across pages.",
+          "type": "integer"
+        }
+      },
+      "required": [
+        "total",
+        "revisions"
+      ],
+      "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

Behavior5/5

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

Beyond the readOnly/idempotent annotations, it discloses non-obvious behavior: output is document-ordered, text is clipped at 200 characters, replies are paged at about 8,000 bytes with a 1,000 limit, and continuation uses the reply's `next` as `cursor`. It also notes that row/cell revisions are only listed for the body's tables and that note/header addresses carry prefixes.

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?

Dense but front-loaded: purpose first, then return fields, then filtering, then cross-tool routing, then pagination. Every clause carries information (clipping length, byte cap, cursor source), though the single unbroken paragraph is heavy to parse.

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?

With annotations and a rich output schema already present, the description need not restate return values, yet it still covers filtering, story scoping, paging, clipping and hand-off to accept/reject. Nothing an agent needs to invoke it correctly appears to be 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 description coverage is 100%, so the baseline is 3. The description still adds value beyond the schema: it explains that `author`/`type` act as filters, that `stories` defaults to body and appends notes/headers after body revisions, and it clarifies the cursor/limit pagination contract in prose.

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?

States a specific verb ('List') and resource ('tracked changes') and enumerates the revision kinds covered (insertions, deletions, moves, formatting, table rows/cells), plus the exact returned fields. An agent can distinguish this from revision_accept, revision_reject and doc_stats immediately.

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

Usage Guidelines4/5

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

It explicitly routes the agent: 'Use the ids with revision.accept or revision.reject; doc.stats counts changes by type', which explains the downstream workflow. It also explains story scoping ('notes' adds footnotes/endnotes, 'headers' adds headers/footers). It stops short of stating when-not to use it (e.g., versus doc_diff or comment_list), so it is clear context rather than a full decision rule.

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

Deploy Server