Skip to main content
Glama
nuncaeslupus

doc-control

by nuncaeslupus
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

section_list

Read-onlyIdempotent

List each section's page setup in a .docx to inspect break type, title page, even/odd headers, page-number start/format, and header/footer story keys.

Instructions

List each section's page setup: break type, title page, even/odd headers, page-number start and format, and which header and footer story (hdr1.default, ftr2.first...) it uses per kind; null means inherited. Use the story keys to read header text with para.list (stories headers) or para.get; layout.get gives the same setup with the header and footer text, in the form layout.apply takes. Read-only.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
docYesPath to the .docx.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
okYesAlways true on success.
opYesThe operation that ran.
apiYesAPI version (1.0).
docNoThe document read or written: path, sha256 and paragraph count.
nextYesCursor for the next page (pass as cursor), or null.
resultYesWhat the operation returns.
warningsYesThings to know about the result.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.7.2
    • 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": {
+        "sections": {
+          "description": "Each section, in order.",
+          "items": {
+            "description": "A section's page setup.",
+            "properties": {
+              "break": {
+                "description": "Section break: nextPage, oddPage, evenPage or continuous.",
+                "type": "string"
+              },
+              "even_and_odd": {
+                "description": "Different even and odd headers (document-wide).",
+                "type": "boolean"
+              },
+              "footers": {
+                "description": "Header or footer story per kind (null: inherited from the previous section).",
+                "properties": {
+                  "default": {
+                    "description": "Story key of the default one, e.g. hdr1.default.",
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  },
+                  "even": {
+                    "description": "Story key of the even-page one.",
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  },
+                  "first": {
+                    "description": "Story key of the first-page one.",
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  }
+                },
+                "type": "object"
+              },
+              "headers": {
+                "description": "Header or footer story per kind (null: inherited from the previous section).",
+                "properties": {
+                  "default": {
+                    "description": "Story key of the default one, e.g. hdr1.default.",
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  },
+                  "even": {
+                    "description": "Story key of the even-page one.",
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  },
+                  "first": {
+                    "description": "Story key of the first-page one.",
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  }
+                },
+                "type": "object"
+              },
+              "page_numbers": {
+                "description": "Page numbering.",
+                "properties": {
+                  "format": {
+                    "description": "Number format (decimal, lowerRoman...).",
+                    "type": "string"
+                  },
+                  "start": {
+                    "description": "Restart value, or null to continue.",
+                    "type": [
+                      "integer",
+                      "null"
+                    ]
+                  }
+                },
+                "type": "object"
+              },
+              "section": {
+                "description": "Section number (1-based).",
+                "type": "integer"
+              },
+              "title_page": {
+                "description": "Different first page.",
+                "type": "boolean"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        }
+      },
+      "required": [
+        "sections"
+      ],
+      "type": "object"
+    },
+    "warnings": {
+      "description": "Things to know about the result.",
+      "items": {
+        "type": "string"
+      },
+      "type": "array"
+    }
+  },
+  "required": [
+    "api",
+    "ok",
+    "op",
+    "result",
+    "warnings",
+    "next"
+  ],
+  "type": "object"
+}
  2. Addedv0.1.3

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and openWorldHint, so safety is covered and the trailing 'Read-only' adds nothing. The description does add real behavioral insight beyond structured data, notably that 'null means inherited' and how the story keys (hdr1.default, ftr2.first...) map to header/footer stories, which is not derivable from annotations.

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?

It is front-loaded with the returned fields and stays dense but earns its words, since every clause describes output content or routing. The final 'Read-only.' is redundant with the annotations, a minor bit of waste.

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, so return values need not be spelled out, yet the description still explains the inheritance semantics and key formats. For a single-param read-only tool with full schema coverage, nothing an agent needs 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.

Parameters3/5

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

There is a single parameter at 100% schema description coverage ('Path to the .docx.'), so the schema already carries the semantics and the baseline is 3. The description adds no further detail about the doc parameter itself.

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 description opens with a specific verb+resource ('List each section's page setup') and then enumerates exactly what is reported: break type, title page, even/odd headers, page-number start and format, and the header/footer story keys. It is unmistakably distinct from para_list, para_get, and layout_get, which it names explicitly.

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 routes the agent clearly: use the returned story keys with para.list or para.get to read header text, and use layout_get instead when you want the same setup plus the header/footer text. This gives an explicit alternative and the condition that selects it.

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

Deploy Server

Other Tools