Skip to main content
Glama
nuncaeslupus

doc-control

by nuncaeslupus
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

server_capabilities

Read-onlyIdempotent

Get the doc-control server's API version, engines, supported operations, and error codes at session start to plan document edits.

Instructions

Describe this doc-control server: API and package version, engines (file, live), which live apps are reachable, feature support per engine, every operation with its kind and summary, every error code, and whether it is a frozen build. Call it once at the start of a session; server.help gives one operation's full request and result schemas. Read-only; needs no document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

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": {
+        "api": {
+          "description": "API version of the envelope.",
+          "type": "string"
+        },
+        "build": {
+          "description": "How this copy was built.",
+          "properties": {
+            "freezer": {
+              "description": "Its freezer (pyinstaller).",
+              "type": "string"
+            },
+            "frozen": {
+              "description": "A frozen binary.",
+              "type": "boolean"
+            }
+          },
+          "type": "object"
+        },
+        "engines": {
+          "description": "Engines: file, live.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "errors": {
+          "description": "Every error code.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        },
+        "features": {
+          "description": "Feature support per engine.",
+          "properties": {
+            "plain_writes": {
+              "description": "tracked: false writes.",
+              "properties": {
+                "file": {
+                  "description": "File engine.",
+                  "type": "boolean"
+                },
+                "live": {
+                  "description": "Live.",
+                  "type": "boolean"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        },
+        "live": {
+          "description": "The live engine.",
+          "properties": {
+            "apps": {
+              "description": "Every live app.",
+              "items": {
+                "description": "A live app.",
+                "properties": {
+                  "app": {
+                    "description": "word, libreoffice (or a test adapter).",
+                    "type": "string"
+                  },
+                  "available": {
+                    "description": "Installed on this machine.",
+                    "type": "boolean"
+                  },
+                  "listening": {
+                    "description": "LibreOffice: its UNO listener is up.",
+                    "type": "boolean"
+                  },
+                  "reachable": {
+                    "description": "Can be driven now.",
+                    "type": "boolean"
+                  },
+                  "reason": {
+                    "description": "Why it is not available or reachable.",
+                    "type": "string"
+                  },
+                  "version": {
+                    "description": "App version, when known.",
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  }
+                },
+                "type": "object"
+              },
+              "type": "array"
+            }
+          },
+          "type": "object"
+        },
+        "operations": {
+          "description": "Every operation.",
+          "items": {
+            "description": "An operation.",
+            "properties": {
+              "kind": {
+                "description": "read or write.",
+                "type": "string"
+              },
+              "name": {
+                "description": "Its name (MCP tool: dots as underscores).",
+                "type": "string"
+              },
+              "summary": {
+                "description": "What it does.",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "update": {
+          "description": "Opt-in update notice (DOC_CONTROL_UPDATE_CHECK): the newest release.",
+          "properties": {
+            "checked_at": {
+              "description": "When it was checked (UTC).",
+              "type": "string"
+            },
+            "current": {
+              "description": "This version.",
+              "type": "string"
+            },
+            "error": {
+              "description": "Why the check failed.",
+              "type": "string"
+            },
+            "latest": {
+              "description": "Newest release.",
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "mcpb_url": {
+              "description": "Download of the newest .mcpb bundle.",
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          "type": "object"
+        },
+        "version": {
+          "description": "doc-control version.",
+          "type": "string"
+        }
+      },
+      "required": [
+        "api",
+        "version",
+        "engines",
+        "live",
+        "features",
+        "operations",
+        "errors",
+        "build"
+      ],
+      "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.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, openWorldHint, and idempotentHint, so the safety profile is covered; the description's 'Read-only' clause is largely redundant. It does add genuine context beyond annotations by disclosing the shape and breadth of the response (engine list, reachable live apps, per-engine feature support, error codes, frozen-build flag) and the no-document precondition.

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-loads the verb and the enumeration in the first sentence, then adds two short routing/precondition sentences with no filler. The return-field list is dense but each clause maps to a distinct capability, so it earns its length; only slight tightness is lost in the run-on enumeration.

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 zero-parameter, read-only discovery tool with an output schema, the description does more than required by naming the response categories and the session-start timing. Nothing an agent needs to invoke 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?

The tool takes zero parameters, so the baseline is 4 and there is no parameter meaning the description needs to compensate for. It correctly implies invocation is unconditional and requires no input document.

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 and resource ('Describe this doc-control server') and enumerates exactly what is described: version, engines, reachable apps, feature support, operations, error codes, frozen-build status. It also explicitly differentiates itself from the sibling server_help, so an agent can tell the two apart without opening schemas.

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?

Gives explicit timing ('Call it once at the start of a session') and names the alternative with its disambiguating condition ('server.help gives one operation's full request and result schemas'). When-to-use and when-to-use-something-else are both covered.

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