document-mcp 3.0.3 → 4.0.0

package/README.md

@@ -213,7 +213,7 @@ Every tool that takes or produces document bytes goes through the same two hybri
 | `docx_extras` | Reads a docx's own comments, footnotes, header/footer parts, and numbering definitions — data the `ContentDocument` pivot cannot carry, so no other tool sees it. |
 | `pdf_inspect` | Parses a PDF and reports a summary (page count, per-page size and item-kind histogram, metadata, embedded image formats), or with `full: true` the entire parsed `LayoutDocument` as plain JSON — no `$schema` stamp, since that family moved to `pdf-codec` at `document-schema.js` 4.0.0 and lost its schema-stamped envelope. |
 | `odm_to_pdf` | Converts a `.odm` (ODF master document) to PDF. A `.odm` never carries its chapters' content inline, so each chapter resolves via a caller-supplied `chapters` href-to-document map and/or a `chaptersDir` searched by basename. |
-| `from_package` | Rebuilds real document bytes in a target format from a `DocumentPackage` previously serialised to JSON (e.g. by a conversion tool's own `onDocument`/package-dump step). Only a package genuinely written by a current dump round-trips: the `$schema` URI it carries pins the `document-schema.js` release that wrote it, and a pre-4.0.0 dump (the flat `{ formatVersion, content, pages }` envelope) is rejected with an error naming the pinned release, the flat-to-tree change, and the remedy — a layout-document dump gets its own pointer, naming the move to `pdf-codec`. |
+| `from_package` | Rebuilds real document bytes in a target format from a `DocumentTree` previously serialised to JSON (e.g. by a conversion tool's own `onDocument`/package-dump step). Only a package genuinely written by a current dump round-trips: the `$schema` URI it carries pins the `document-schema.js` release that wrote it, and a pre-4.0.0 dump (the flat `{ formatVersion, content, pages }` envelope) is rejected with an error naming the pinned release, the flat-to-tree change, and the remedy — a layout-document dump gets its own pointer, naming the move to `pdf-codec`. |
 | `outline_document` | Projects a document's own table of contents as structured JSON: groups (`{ text, level, children }`) for headings, list items, slides, sheets, and draw pages, leaves (`{ kind, text }`) for the content between them. The outline is over the source's own content — read through `documents.js`'s `DocumentConverter` port and built by `document-outline.js`'s `buildOutline`. |
 | `odb_tables` | Lists every table an embedded `.odb` database declares — column names, types, and row data — across every storage tier `documents.js` supports (HSQLDB TEXT/CACHED/BINARY, Firebird gbak backups). |
 | `odb_forms` | Lists every form an `.odb` database declares, with each form's own data source and field-bound controls. |
@@ -226,7 +226,7 @@ Every tool that takes or produces document bytes goes through the same two hybri
 ## References
 
 - [documents.js](https://github.com/ExaDev/documents.js) — the library this server exposes.
-- [document-outline.js](../document-outline.js/README.md) — the artefact-utilities package over document-schema.js's tree-form `DocumentPackage` whose `buildOutline` powers `outline_document`.
+- [document-outline.js](../document-outline.js/README.md) — the artefact-utilities package over document-schema.js's tree-form `DocumentTree` whose `buildOutline` powers `outline_document`.
 - [document-cli](../document-cli/README.md) — the sibling CLI/TUI over the same library, whose toolchain this repository's scaffold mirrors.
 - [Model Context Protocol](https://modelcontextprotocol.io) — the protocol this server implements, via [`@modelcontextprotocol/server`](https://www.npmjs.com/package/@modelcontextprotocol/server).
 

package/dist/bin.js

@@ -8,7 +8,7 @@ import { existsSync, readFileSync } from "node:fs";
 import { basename, join } from "node:path";
 import { buildOutline, isOutlineNode, outlineLeafText } from "document-outline.js";
 //#region package.json
-var version = "3.0.3";
+var version = "4.0.0";
 //#endregion
 //#region src/io/document-input.ts
 const EXTENSION_TO_FORMAT = {
@@ -326,10 +326,10 @@ function isNamedError(error, name) {
 function registerFromPackageTools(server) {
 	server.registerTool("from_package", {
 		title: "Build document from package",
-		description: "Rebuilds real document bytes in a target format from a DocumentPackage previously serialised to JSON (e.g. by a caller's own --dump-package-equivalent step) -- the read side of the DocumentPackage round trip a conversion's onDocument callback produces.",
+		description: "Rebuilds real document bytes in a target format from a DocumentTree previously serialised to JSON (e.g. by a caller's own --dump-package-equivalent step) -- the read side of the DocumentTree round trip a conversion's onDocument callback produces.",
 		inputSchema: z.object({
-			source: DocumentInputSchema.describe("The DocumentPackage JSON to read. 'path' points at a JSON file on disk -- its extension is never used to infer a document format, since the file holds a DocumentPackage, not a document. 'bytesBase64' carries the JSON inline; its 'format' field is required by the shared hybrid input shape but unused by this tool."),
-			targetFormat: DocumentFormatSchema.describe("The document format to build from the DocumentPackage."),
+			source: DocumentInputSchema.describe("The DocumentTree JSON to read. 'path' points at a JSON file on disk -- its extension is never used to infer a document format, since the file holds a DocumentTree, not a document. 'bytesBase64' carries the JSON inline; its 'format' field is required by the shared hybrid input shape but unused by this tool."),
+			targetFormat: DocumentFormatSchema.describe("The document format to build from the DocumentTree."),
 			output: DocumentOutputSchema.optional().describe("Where to write the resulting document. Omit entirely (or omit outputPath within it) to receive the bytes inline instead.")
 		})
 	}, async ({ source, targetFormat, output }) => {
@@ -343,7 +343,7 @@ function registerFromPackageTools(server) {
 				return errorResult(`'source' is not valid JSON: ${error instanceof Error ? error.message : String(error)}`);
 			}
 			const result = documentFromJson(parsed);
-			if (result.kind !== "DocumentPackage") return errorResult(`'source' is a ${result.kind}, not a DocumentPackage -- only a file carrying a real DocumentPackage (e.g. written by a caller's own --dump-package-equivalent step) can be read back by this tool`);
+			if (result.kind !== "DocumentTree") return errorResult(`'source' is a ${result.kind}, not a DocumentTree -- only a file carrying a real DocumentTree (e.g. written by a caller's own --dump-package-equivalent step) can be read back by this tool`);
 			const resolvedOutput = await resolveDocumentOutput(buildDocumentBytes(result.value, targetFormat), output ?? {});
 			return {
 				content: [{
@@ -353,9 +353,10 @@ function registerFromPackageTools(server) {
 				structuredContent: resolvedOutput
 			};
 		} catch (error) {
-			if (error instanceof UnrecognizedDocumentSchemaError) return errorResult("'source' has no recognised $schema -- only a file carrying a real DocumentPackage (e.g. written by a caller's own --dump-package-equivalent step) can be read back by this tool");
+			if (error instanceof UnrecognizedDocumentSchemaError) return errorResult("'source' has no recognised $schema -- only a file carrying a real DocumentTree (e.g. written by a caller's own --dump-package-equivalent step) can be read back by this tool");
 			if (isNamedError(error, "SchemaVersionMismatchError")) return errorResult(error.message);
 			if (isNamedError(error, "LayoutSchemaDemotedError")) return errorResult(error.message);
+			if (isNamedError(error, "DocumentPackageRenamedError")) return errorResult(error.message);
 			if (error instanceof z.ZodError) return errorResult(`'source' failed ${documentSchemaKindOf(parsed) ?? "document schema"} validation: ${error.message}`);
 			return errorResult(error instanceof Error ? error.message : String(error));
 		}
@@ -808,7 +809,7 @@ function registerOutlineTools(server) {
 	const converter = createLocalDocumentConverter();
 	server.registerTool("outline_document", {
 		title: "Outline document",
-		description: "Projects a document's table of contents as a structured outline: reads the source through documents.js's DocumentConverter port, takes the tree-form DocumentPackage the conversion reports, and runs document-outline.js's buildOutline over it. Groups carry { text, level, children } (a heading's, list item's, slide's, sheet's, or page's own label plus nested children); leaves carry { kind, text }. The outline is over the source's own content -- the internal conversion target preserves it and is pdf only for odf (the one format that only converts to pdf) and odg (whose alternative, svg, cannot represent more than one page).",
+		description: "Projects a document's table of contents as a structured outline: reads the source through documents.js's DocumentConverter port, takes the tree-form DocumentTree the conversion reports, and runs document-outline.js's buildOutline over it. Groups carry { text, level, children } (a heading's, list item's, slide's, sheet's, or page's own label plus nested children); leaves carry { kind, text }. The outline is over the source's own content -- the internal conversion target preserves it and is pdf only for odf (the one format that only converts to pdf) and odg (whose alternative, svg, cannot represent more than one page).",
 		inputSchema: z.object({ source: DocumentInputSchema.describe("The document to outline.") })
 	}, async ({ source }, ctx) => {
 		const { signal } = ctx.mcpReq;
@@ -821,7 +822,7 @@ function registerOutlineTools(server) {
 			},
 			targetFormat
 		}, { signal })).package;
-		if (pkg === void 0) throw new Error(`the ${format}-to-${targetFormat} conversion reported no DocumentPackage, so there is no tree to outline`);
+		if (pkg === void 0) throw new Error(`the ${format}-to-${targetFormat} conversion reported no DocumentTree, so there is no tree to outline`);
 		const structuredContent = {
 			sourceFormat: format,
 			kind: pkg.kind,

package/dist/index.cjs

@@ -7,7 +7,7 @@ let node_fs = require("node:fs");
 let node_path = require("node:path");
 let document_outline_js = require("document-outline.js");
 //#region package.json
-var version = "3.0.3";
+var version = "4.0.0";
 //#endregion
 //#region src/io/document-input.ts
 const EXTENSION_TO_FORMAT = {
@@ -325,10 +325,10 @@ function isNamedError(error, name) {
 function registerFromPackageTools(server) {
 	server.registerTool("from_package", {
 		title: "Build document from package",
-		description: "Rebuilds real document bytes in a target format from a DocumentPackage previously serialised to JSON (e.g. by a caller's own --dump-package-equivalent step) -- the read side of the DocumentPackage round trip a conversion's onDocument callback produces.",
+		description: "Rebuilds real document bytes in a target format from a DocumentTree previously serialised to JSON (e.g. by a caller's own --dump-package-equivalent step) -- the read side of the DocumentTree round trip a conversion's onDocument callback produces.",
 		inputSchema: zod.z.object({
-			source: DocumentInputSchema.describe("The DocumentPackage JSON to read. 'path' points at a JSON file on disk -- its extension is never used to infer a document format, since the file holds a DocumentPackage, not a document. 'bytesBase64' carries the JSON inline; its 'format' field is required by the shared hybrid input shape but unused by this tool."),
-			targetFormat: documents_js.DocumentFormatSchema.describe("The document format to build from the DocumentPackage."),
+			source: DocumentInputSchema.describe("The DocumentTree JSON to read. 'path' points at a JSON file on disk -- its extension is never used to infer a document format, since the file holds a DocumentTree, not a document. 'bytesBase64' carries the JSON inline; its 'format' field is required by the shared hybrid input shape but unused by this tool."),
+			targetFormat: documents_js.DocumentFormatSchema.describe("The document format to build from the DocumentTree."),
 			output: DocumentOutputSchema.optional().describe("Where to write the resulting document. Omit entirely (or omit outputPath within it) to receive the bytes inline instead.")
 		})
 	}, async ({ source, targetFormat, output }) => {
@@ -342,7 +342,7 @@ function registerFromPackageTools(server) {
 				return errorResult(`'source' is not valid JSON: ${error instanceof Error ? error.message : String(error)}`);
 			}
 			const result = (0, documents_js.documentFromJson)(parsed);
-			if (result.kind !== "DocumentPackage") return errorResult(`'source' is a ${result.kind}, not a DocumentPackage -- only a file carrying a real DocumentPackage (e.g. written by a caller's own --dump-package-equivalent step) can be read back by this tool`);
+			if (result.kind !== "DocumentTree") return errorResult(`'source' is a ${result.kind}, not a DocumentTree -- only a file carrying a real DocumentTree (e.g. written by a caller's own --dump-package-equivalent step) can be read back by this tool`);
 			const resolvedOutput = await resolveDocumentOutput((0, documents_js.buildDocumentBytes)(result.value, targetFormat), output ?? {});
 			return {
 				content: [{
@@ -352,9 +352,10 @@ function registerFromPackageTools(server) {
 				structuredContent: resolvedOutput
 			};
 		} catch (error) {
-			if (error instanceof documents_js.UnrecognizedDocumentSchemaError) return errorResult("'source' has no recognised $schema -- only a file carrying a real DocumentPackage (e.g. written by a caller's own --dump-package-equivalent step) can be read back by this tool");
+			if (error instanceof documents_js.UnrecognizedDocumentSchemaError) return errorResult("'source' has no recognised $schema -- only a file carrying a real DocumentTree (e.g. written by a caller's own --dump-package-equivalent step) can be read back by this tool");
 			if (isNamedError(error, "SchemaVersionMismatchError")) return errorResult(error.message);
 			if (isNamedError(error, "LayoutSchemaDemotedError")) return errorResult(error.message);
+			if (isNamedError(error, "DocumentPackageRenamedError")) return errorResult(error.message);
 			if (error instanceof zod.z.ZodError) return errorResult(`'source' failed ${(0, documents_js.documentSchemaKindOf)(parsed) ?? "document schema"} validation: ${error.message}`);
 			return errorResult(error instanceof Error ? error.message : String(error));
 		}
@@ -807,7 +808,7 @@ function registerOutlineTools(server) {
 	const converter = (0, documents_js.createLocalDocumentConverter)();
 	server.registerTool("outline_document", {
 		title: "Outline document",
-		description: "Projects a document's table of contents as a structured outline: reads the source through documents.js's DocumentConverter port, takes the tree-form DocumentPackage the conversion reports, and runs document-outline.js's buildOutline over it. Groups carry { text, level, children } (a heading's, list item's, slide's, sheet's, or page's own label plus nested children); leaves carry { kind, text }. The outline is over the source's own content -- the internal conversion target preserves it and is pdf only for odf (the one format that only converts to pdf) and odg (whose alternative, svg, cannot represent more than one page).",
+		description: "Projects a document's table of contents as a structured outline: reads the source through documents.js's DocumentConverter port, takes the tree-form DocumentTree the conversion reports, and runs document-outline.js's buildOutline over it. Groups carry { text, level, children } (a heading's, list item's, slide's, sheet's, or page's own label plus nested children); leaves carry { kind, text }. The outline is over the source's own content -- the internal conversion target preserves it and is pdf only for odf (the one format that only converts to pdf) and odg (whose alternative, svg, cannot represent more than one page).",
 		inputSchema: zod.z.object({ source: DocumentInputSchema.describe("The document to outline.") })
 	}, async ({ source }, ctx) => {
 		const { signal } = ctx.mcpReq;
@@ -820,7 +821,7 @@ function registerOutlineTools(server) {
 			},
 			targetFormat
 		}, { signal })).package;
-		if (pkg === void 0) throw new Error(`the ${format}-to-${targetFormat} conversion reported no DocumentPackage, so there is no tree to outline`);
+		if (pkg === void 0) throw new Error(`the ${format}-to-${targetFormat} conversion reported no DocumentTree, so there is no tree to outline`);
 		const structuredContent = {
 			sourceFormat: format,
 			kind: pkg.kind,

package/dist/index.js

@@ -6,7 +6,7 @@ import { existsSync, readFileSync } from "node:fs";
 import { basename, join } from "node:path";
 import { buildOutline, isOutlineNode, outlineLeafText } from "document-outline.js";
 //#region package.json
-var version = "3.0.3";
+var version = "4.0.0";
 //#endregion
 //#region src/io/document-input.ts
 const EXTENSION_TO_FORMAT = {
@@ -324,10 +324,10 @@ function isNamedError(error, name) {
 function registerFromPackageTools(server) {
 	server.registerTool("from_package", {
 		title: "Build document from package",
-		description: "Rebuilds real document bytes in a target format from a DocumentPackage previously serialised to JSON (e.g. by a caller's own --dump-package-equivalent step) -- the read side of the DocumentPackage round trip a conversion's onDocument callback produces.",
+		description: "Rebuilds real document bytes in a target format from a DocumentTree previously serialised to JSON (e.g. by a caller's own --dump-package-equivalent step) -- the read side of the DocumentTree round trip a conversion's onDocument callback produces.",
 		inputSchema: z.object({
-			source: DocumentInputSchema.describe("The DocumentPackage JSON to read. 'path' points at a JSON file on disk -- its extension is never used to infer a document format, since the file holds a DocumentPackage, not a document. 'bytesBase64' carries the JSON inline; its 'format' field is required by the shared hybrid input shape but unused by this tool."),
-			targetFormat: DocumentFormatSchema.describe("The document format to build from the DocumentPackage."),
+			source: DocumentInputSchema.describe("The DocumentTree JSON to read. 'path' points at a JSON file on disk -- its extension is never used to infer a document format, since the file holds a DocumentTree, not a document. 'bytesBase64' carries the JSON inline; its 'format' field is required by the shared hybrid input shape but unused by this tool."),
+			targetFormat: DocumentFormatSchema.describe("The document format to build from the DocumentTree."),
 			output: DocumentOutputSchema.optional().describe("Where to write the resulting document. Omit entirely (or omit outputPath within it) to receive the bytes inline instead.")
 		})
 	}, async ({ source, targetFormat, output }) => {
@@ -341,7 +341,7 @@ function registerFromPackageTools(server) {
 				return errorResult(`'source' is not valid JSON: ${error instanceof Error ? error.message : String(error)}`);
 			}
 			const result = documentFromJson(parsed);
-			if (result.kind !== "DocumentPackage") return errorResult(`'source' is a ${result.kind}, not a DocumentPackage -- only a file carrying a real DocumentPackage (e.g. written by a caller's own --dump-package-equivalent step) can be read back by this tool`);
+			if (result.kind !== "DocumentTree") return errorResult(`'source' is a ${result.kind}, not a DocumentTree -- only a file carrying a real DocumentTree (e.g. written by a caller's own --dump-package-equivalent step) can be read back by this tool`);
 			const resolvedOutput = await resolveDocumentOutput(buildDocumentBytes(result.value, targetFormat), output ?? {});
 			return {
 				content: [{
@@ -351,9 +351,10 @@ function registerFromPackageTools(server) {
 				structuredContent: resolvedOutput
 			};
 		} catch (error) {
-			if (error instanceof UnrecognizedDocumentSchemaError) return errorResult("'source' has no recognised $schema -- only a file carrying a real DocumentPackage (e.g. written by a caller's own --dump-package-equivalent step) can be read back by this tool");
+			if (error instanceof UnrecognizedDocumentSchemaError) return errorResult("'source' has no recognised $schema -- only a file carrying a real DocumentTree (e.g. written by a caller's own --dump-package-equivalent step) can be read back by this tool");
 			if (isNamedError(error, "SchemaVersionMismatchError")) return errorResult(error.message);
 			if (isNamedError(error, "LayoutSchemaDemotedError")) return errorResult(error.message);
+			if (isNamedError(error, "DocumentPackageRenamedError")) return errorResult(error.message);
 			if (error instanceof z.ZodError) return errorResult(`'source' failed ${documentSchemaKindOf(parsed) ?? "document schema"} validation: ${error.message}`);
 			return errorResult(error instanceof Error ? error.message : String(error));
 		}
@@ -806,7 +807,7 @@ function registerOutlineTools(server) {
 	const converter = createLocalDocumentConverter();
 	server.registerTool("outline_document", {
 		title: "Outline document",
-		description: "Projects a document's table of contents as a structured outline: reads the source through documents.js's DocumentConverter port, takes the tree-form DocumentPackage the conversion reports, and runs document-outline.js's buildOutline over it. Groups carry { text, level, children } (a heading's, list item's, slide's, sheet's, or page's own label plus nested children); leaves carry { kind, text }. The outline is over the source's own content -- the internal conversion target preserves it and is pdf only for odf (the one format that only converts to pdf) and odg (whose alternative, svg, cannot represent more than one page).",
+		description: "Projects a document's table of contents as a structured outline: reads the source through documents.js's DocumentConverter port, takes the tree-form DocumentTree the conversion reports, and runs document-outline.js's buildOutline over it. Groups carry { text, level, children } (a heading's, list item's, slide's, sheet's, or page's own label plus nested children); leaves carry { kind, text }. The outline is over the source's own content -- the internal conversion target preserves it and is pdf only for odf (the one format that only converts to pdf) and odg (whose alternative, svg, cannot represent more than one page).",
 		inputSchema: z.object({ source: DocumentInputSchema.describe("The document to outline.") })
 	}, async ({ source }, ctx) => {
 		const { signal } = ctx.mcpReq;
@@ -819,7 +820,7 @@ function registerOutlineTools(server) {
 			},
 			targetFormat
 		}, { signal })).package;
-		if (pkg === void 0) throw new Error(`the ${format}-to-${targetFormat} conversion reported no DocumentPackage, so there is no tree to outline`);
+		if (pkg === void 0) throw new Error(`the ${format}-to-${targetFormat} conversion reported no DocumentTree, so there is no tree to outline`);
 		const structuredContent = {
 			sourceFormat: format,
 			kind: pkg.kind,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "document-mcp",
-  "version": "3.0.3",
+  "version": "4.0.0",
   "description": "MCP (Model Context Protocol) server exposing documents.js's document-conversion, .odb, metadata, and font tooling as MCP tools.",
   "type": "module",
   "repository": {
@@ -87,8 +87,8 @@
   "packageManager": "pnpm@11.6.0",
   "dependencies": {
     "@modelcontextprotocol/server": "^2.0.0",
-    "document-outline.js": "^2.1.2",
-    "documents.js": "^5.0.2",
+    "document-outline.js": "^3.0.0",
+    "documents.js": "^6.0.0",
     "zod": "^4.2.0"
   },
   "devDependencies": {
@@ -107,8 +107,8 @@
     "globals": "^17.8.0",
     "husky": "^9.1.7",
     "lint-staged": "^17.3.0",
-    "odf.js": "^5.5.2",
-    "pdf-codec": "^3.4.2",
+    "odf.js": "^6.0.0",
+    "pdf-codec": "^3.4.4",
     "publint": "^0.3.22",
     "semantic-release": "^25.0.8",
     "tsdown": "^0.22.14",