doc-control

Overview Schema Source Related Servers Discussions Admin

field_list

Read-onlyIdempotent

Lists every Word document field with address, story, type, result, and stale status, including nested, split, and text-box fields. Use before updating to find stale fields or citations.

Instructions

List every field (PAGE, TOC, REF, SEQ, XE, citations such as ADDIN ZOTERO_ITEM...) with its address, story, code, type, shown result and whether it is stale (needs updating). stories defaults to all: body, notes, headers and comments; type keeps one type ("TOC"). Covers nested, split and simple fields and fields in text boxes. Use it before field.update to see what is stale, or to find citations; it never changes anything. Read-only; one reply, not paged.

Input Schema

TableJSON Schema

Name	Required	Description
`doc`	Yes	Path to the .docx.
`type`	No	Only fields of this type, e.g. "TOC" or "ADDIN ZOTERO_ITEM".
`stories`	No	Stories to read (default all): "body", "notes", "headers" and "comments".

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": {
+        "count": {
+          "description": "Fields listed.",
+          "type": "integer"
+        },
+        "fields": {
+          "description": "Every field, story by story, in document order.",
+          "items": {
+            "description": "A field.",
+            "properties": {
+              "at": {
+                "description": "Address of its paragraph (comment:<id> in a comment).",
+                "type": "string"
+              },
+              "citation": {
+                "description": "A reference-manager citation (never changed by field.update).",
+                "type": "boolean"
+              },
+              "code": {
+                "description": "Instruction code.",
+                "type": "string"
+              },
+              "in": {
+                "description": "textbox when inside a text box.",
+                "type": "string"
+              },
+              "result": {
+                "description": "Result text shown.",
+                "type": "string"
+              },
+              "stale": {
+                "description": "Marked dirty, or a placeholder result: needs updating.",
+                "type": "boolean"
+              },
+              "story": {
+                "description": "body, comments, or the story key (fn3, hdr1.default...).",
+                "type": "string"
+              },
+              "type": {
+                "description": "Field type (PAGE, TOC, REF, ADDIN ZOTERO_ITEM, CITATION...).",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "fields",
+        "count"
+      ],
+      "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 safety is partly covered, but the description adds behavioral context beyond them: it never changes anything, covers nested/split/simple fields and text boxes, and crucially notes a single reply with no pagination. It stops short of describing auth or failure behavior.

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?

Front-loaded with the core action, then scope, then usage routing in a compact run of sentences. The enumeration of field codes and stories is dense but earns its place; slightly longer than strictly necessary but 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?

Though an output schema exists (so return values needn't be documented), the description still names the returned attributes (address, story, code, type, shown result, staleness) and the read-only/no-pagination contract. For a 3-param listing tool with rich annotations, nothing an agent needs 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, but the description adds meaning on top: stories defaults to all with the enum members spelled out, and type's single-value filtering is explained with a concrete example ('TOC'). This clarifies intent beyond the schema's own description text.

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?

Starts with a specific verb+resource ('List every field') and enumerates exactly which field kinds are covered (PAGE, TOC, REF, SEQ, XE, citations) plus the scope of stories and field shapes. An agent can distinguish this from field_update and other list tools without opening any 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?

Explicitly states when to use it ('before field.update to see what is stale, or to find citations'), names the sibling it precedes, and clarifies the negative ('it never changes anything'). The condition selecting this tool is unambiguous.

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

Deploy Server