doc-control

Overview Schema Source Related Servers Discussions Admin

revision_list

Read-onlyIdempotent

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

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). A deletion and an insertion by one author right next to each other are one replacement: the insertion names the deletion in replaces, the deletion the insertion in replaced_by. Filter by author or type; stories notes or headers adds their changes. Use the ids with revision.accept or revision.reject (both halves to resolve a replacement); doc.stats counts changes by type, review.list groups changes and comments by paragraph. 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

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

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 / revisions / items / properties / replaced_by

Added value: +{
+  "description": "On a deletion: id of the insertion that replaces it (same author, right next to it).",
+  "type": "string"
+}

addedOutput schema / properties / result / properties / revisions / items / properties / replaces

Added value: +{
+  "description": "On an insertion: id of the deletion it replaces (same author, right next to it).",
+  "type": "string"
+}

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

Behavior4/5

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

Annotations already declare readOnly and idempotent, so safety is covered; the description adds the paging contract (~8,000 bytes per reply, limit up to 1,000, continue with `cursor` = `next`) and the replacement pairing rule, which are genuinely useful behaviors beyond the schema. It stops short of describing ordering beyond 'document order' and clipping rationale is only brief.

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

Conciseness5/5

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

One dense paragraph, front-loaded with what is listed and its fields, then pairing, then filtering, then routing to siblings, then paging. No filler sentences.

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 an output schema present, return values need little explanation, yet the description still names the fields and clipping. Combined with the paging and replacement semantics, an agent can call and consume this tool without further inference.

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 semantics the schema cannot: the `replaces`/`replaced_by` pairing, that combining stories appends after body with prefixed addresses, and that row/cell revisions are body-only — all material to interpreting parameters and results.

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?

Specific verb+resource — 'List the tracked changes' — with the enumerated change kinds and the per-item fields. It is clearly distinguishable from revision_accept/reject, doc_stats and review.list, which are named as different tools.

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?

Explicitly routes the agent: use these ids with revision.accept or revision.reject (both halves for a replacement), doc.stats counts by type, review.list groups with comments. Filtering via author/type is also stated.

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

Deploy Server