@documonster/mcp 0.8.0-canary.sha.09791dab

package/LICENSE

@@ -0,0 +1,205 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work, excluding
+          those notices that do not pertain to any part of the Derivative
+          Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one of
+          the following places: within a NOTICE text file distributed as
+          part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and do
+          not modify the License. You may add Your own attribution notices
+          within Derivative Works that You distribute, alongside or as an
+          addendum to the NOTICE text from the Work, provided that such
+          additional attribution notices cannot be construed as modifying
+          the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 cjnoname
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+   Portions of the Excel (XLSX) module are derived from ExcelJS, which is
+   licensed under the MIT License. Third-party software notices and
+   attributions are provided in THIRD_PARTY_NOTICES.md.

package/README.md

@@ -0,0 +1,253 @@
+# @documonster/mcp
+
+[Model Context Protocol](https://modelcontextprotocol.io) server for
+[documonster](https://github.com/documonster/documonster). Gives an AI assistant
+the ability to read, write and convert Excel, Word, PDF, CSV and ZIP documents
+on the local filesystem.
+
+> **Status: usable.** Nineteen tools cover spreadsheets, Word, PDF, templates and
+> archives — reading, writing, editing, searching and converting. See
+> [Roadmap](#roadmap) for what is deliberately absent.
+
+## Install
+
+No install needed — point your MCP client at `npx`.
+
+### Claude Desktop
+
+`claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "documonster": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "@documonster/mcp",
+        "--root",
+        "/path/to/your/documents",
+        "--output-root",
+        "/path/to/generated"
+      ]
+    }
+  }
+}
+```
+
+### opencode
+
+`opencode.json`:
+
+```json
+{
+  "mcp": {
+    "documonster": {
+      "type": "local",
+      "command": [
+        "npx",
+        "-y",
+        "@documonster/mcp",
+        "--root",
+        "/path/to/documents",
+        "--output-root",
+        "/path/to/generated"
+      ],
+      "enabled": true
+    }
+  }
+}
+```
+
+## Options
+
+| Flag                      | Default      | Meaning                                                                                               |
+| ------------------------- | ------------ | ----------------------------------------------------------------------------------------------------- |
+| `--root <dir>`            | cwd          | Sandbox root. Every path a tool touches must resolve inside it.                                       |
+| `--output-root <dir>`     | private temp | Separate writable root. Outputs are returned as `@output/<path>` for later calls.                     |
+| `--allow-in-place`        | off          | Permit edits below `--root`; disabled by default because it weakens isolation.                        |
+| `--readonly`              | off          | Withhold every mutating tool from the model's tool list.                                              |
+| `--enable <groups>`       | all          | Comma-separated tool groups: `core`, `excel`, `word`, `pdf`, `forms`, `archive`. `core` is always on. |
+| `--max-file-size <bytes>` | 67108864     | Reject larger input documents.                                                                        |
+| `--max-output-chars <n>`  | 40000        | Truncate tool output — a token budget in disguise.                                                    |
+
+## Security
+
+An MCP server hands a model the ability to name files, so the boundaries are
+part of the design rather than an afterthought.
+
+- **Read-only input by default.** Plain paths resolve below `--root`, and tools
+  never write there. New files go to a disjoint private `--output-root`; a path
+  returned as `@output/reports/q3.xlsx` can be passed to later tools. Editing an
+  input requires an explicit `out`, unless the operator deliberately enables
+  the weaker compatibility mode with `--allow-in-place`.
+- **Sandbox.** Every path follows symlinks segment by segment and then re-checks
+  containment. A symlink inside either root that points outside it is rejected.
+- **Read-only mode.** Under `--readonly`, always-writing tools are removed from
+  `tools/list`. Conditional tools remain for their read branch — list archive or
+  form fields, compare versions, compute pages — while their write branch is
+  rejected server-side.
+- **No network at all.** This server only reads local files; path arguments
+  reject URLs outright. When remote document support is added it will arrive as
+  an explicit opt-in flag, because outbound access from a model-driven process
+  can be aimed anywhere — including cloud metadata endpoints.
+- **Symlinks cannot be used to escape.** Every path is resolved segment by
+  segment, so a link inside the root that points outside it is rejected — whether
+  its target exists or not, and including sidecar paths such as `<name>.bak` and
+  the destination a tool extracts an archive into.
+- **Archives are treated as hostile.** Entries are written one at a time through
+  the same sandbox check, so a `..` entry name or a pre-planted symlink in the
+  destination is refused; symlink entries are never created, file modes are not
+  preserved, and the container's own size is checked before it is opened. Entry
+  names this server _writes_ are validated too, so it cannot produce a Zip Slip
+  payload for someone else.
+- **Size limits are enforced, not advertised.** Every tool that opens a document
+  checks `--max-file-size` first.
+- **Do not rely on your client's approval prompt.** Programmatic clients have no
+  prompt, so all of the above is enforced server-side.
+
+The sandbox protects against model-supplied paths and links already present
+when a call starts. It is not an OS security boundary against another local
+process that can concurrently replace directories inside `--root`; Node does
+not expose a portable `openat`/`O_NOFOLLOW` write API. Do not share a writable
+server root with an untrusted local account or process while the server runs.
+
+## Tools
+
+| Tool                    | Purpose                                                                                                                      |
+| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
+| **Orientation**         |                                                                                                                              |
+| `documonster_help`      | Conventions, path rules, and formula/document/editing notes kept out of tool schemas to save context.                        |
+| `doc_inspect`           | Identify a file (type, size, sheet list, CSV dialect, extension mismatches) or list a directory. Always first.               |
+| **Spreadsheets**        |                                                                                                                              |
+| `sheet_read`            | Read a bounded window as a Markdown table with column letters and row numbers. Paginates; reports what it omitted.           |
+| `sheet_write`           | Create an `.xlsx` from a declarative spec. `fromCsv` pulls source data in server-side.                                       |
+| `sheet_edit`            | Patch an existing `.xlsx` — cells, ranges, formulas, rows, styles, sheets. Atomic, backed up, `dryRun` available.            |
+| `formula_evaluate`      | Evaluate a formula against supplied values using the real engine (~450 functions). Touches no files.                         |
+| **Documents**           |                                                                                                                              |
+| `doc_read`              | Read `.docx` / `.pdf` / `.md` / `.txt`. Word returns Markdown; PDFs are reported page by page.                               |
+| `doc_write`             | Create a `.docx` or `.pdf` from Markdown.                                                                                    |
+| `doc_edit`              | Find and replace text in a `.docx`, including matches Word split across runs. Formatting preserved.                          |
+| `doc_search`            | Find text, or find text **by its formatting** — "which text is red", "what is highlighted".                                  |
+| `doc_paginate`          | Real page count and per-heading page numbers without Word installed; optionally refresh fields and the TOC.                  |
+| `doc_convert`           | `docx`→`md`/`html`/`pdf`/`txt`, `md`→`docx`/`pdf`, `xlsx`→`csv`/`pdf`, `csv`→`xlsx`. Lossy conversions state their loss.     |
+| `pdf_edit`              | Watermark, page numbers, stamps, rotate, delete/keep pages, append another PDF. Overlays never rewrite the original content. |
+| **Forms and templates** |                                                                                                                              |
+| `template_inspect`      | List a template's placeholders and print the JSON shape needed to fill it.                                                   |
+| `template_fill`         | Fill a Word template from JSON. A missing field fails loudly rather than shipping a blank.                                   |
+| `form_fill`             | List or fill Word form fields and PDF AcroForms. PDF values are verified by re-reading the saved file.                       |
+| **Archives**            |                                                                                                                              |
+| `archive_read`          | List or extract a `.zip`/`.tar`. Guards traversal, decompression bombs and symlink entries.                                  |
+| `archive_write`         | Package files and directories into a `.zip`/`.tar`, verified by reading it back.                                             |
+
+### Two worked examples
+
+**Spreadsheets** — a zip of CSVs in, a summary out:
+
+```jsonc
+archive_read  { "path": "reports.zip" }
+archive_read  { "path": "reports.zip", "action": "extract",
+                "out": "tmp", "entries": ["*.csv"] }
+doc_inspect   { "path": "@output/tmp/june.csv" }               // delimiter? BOM?
+formula_evaluate { "formula": "=SUMPRODUCT(A1:A3,B1:B3)", "context": { … } }
+sheet_write   { "path": "out/summary.xlsx",
+                "sheets": [{ "name": "June", "fromCsv": "@output/tmp/june.csv",
+                             "formulas": { "D2": "=B2*C2" } }] }
+sheet_read    { "path": "@output/out/summary.xlsx" }           // verify
+```
+
+**Documents** — fill a template, deliver a PDF:
+
+```jsonc
+template_inspect { "path": "invoice-template.docx" }           // what data is needed?
+template_fill    { "template": "invoice-template.docx",
+                   "out": "out/INV-014.docx",
+                   "data": { "client": { "name": "Acme" },
+                             "items": [{ "name": "Consulting", "amount": "12,000" }] } }
+doc_convert      { "from": "@output/out/INV-014.docx", "to": "out/INV-014.pdf" }
+doc_read         { "path": "@output/out/INV-014.pdf" }         // verify
+```
+
+Note what does **not** happen in either: no document bytes and no bulk rows pass
+through the model's context. `fromCsv`, the `entries` filter and template data
+keep the payload on the server.
+
+### Deliberately absent
+
+Not implemented, and the server tells the model to say so rather than improvise:
+password-protected files, PDF→Word (no faithful conversion exists), OCR, legacy
+binary `.doc`/`.xls`, and image/pivot-table insertion — the library supports
+those, no tool does yet. Spreadsheet charts are supported by `sheet_write` and
+`sheet_edit`.
+
+### Editing existing files
+
+`sheet_edit` and `doc_edit` change files a user already has, so they carry
+guarantees the create-only tools do not need:
+
+- **Safe replacement** — every operation is applied in memory first, then
+  written in a random private sibling directory. POSIX installs it with one
+  atomic rename; Windows uses a rollback rename because its filesystem does not
+  atomically replace an existing file. In either case a failed write restores or
+  leaves the old file rather than a truncated hybrid.
+- **Backed up** — an in-place edit copies the original to `<name>.bak`, and never
+  overwrites an existing backup: the second edit's copy goes to `.bak.2`, so the
+  pristine original stays recoverable.
+- **`dryRun`** — reports exactly what would change and writes nothing.
+- **No silent no-ops** — replacing a phrase that does not occur reports that
+  rather than rewriting the file unchanged.
+
+The failure these guard against is not a broken edit but a _correct edit in the
+wrong place_, which nothing in the output looks wrong after.
+
+## Resources and prompts
+
+Besides tools, the server publishes:
+
+- **Resources** — every help topic at `documonster://help/{topic}`, so a client can
+  display them and a model can read one without spending a tool call.
+- **Prompts** — five workflow templates (`summarise-spreadsheet`, `build-report`,
+  `fill-document`, `review-changes`, `convert-document`). Each encodes the working
+  order that matters — inspect, read narrowly, verify — and tells the model never
+  to invent a value it was not given.
+
+## Programmatic use
+
+```ts
+import { createServer, resolveConfig } from "@documonster/mcp";
+
+const server = createServer(resolveConfig(["--root", "./workspace", "--readonly"]));
+await server.connect(myTransport);
+```
+
+## Development
+
+This package lives in the documonster monorepo and consumes the core through its
+published `exports` map — never through internal path aliases. That means the
+core's ESM + type output must exist first:
+
+```bash
+pnpm i
+pnpm build:esm         # from the repo root — produces dist/esm + dist/types
+pnpm type:packages
+pnpm test:packages
+pnpm build:packages
+```
+
+`pnpm verify:packages` (part of `pnpm check`) fails the build if this package
+ever imports `@excel/*`, `@utils/*` or reaches into `../../src`.
+
+### Testing layers
+
+| Layer      | File                                                    | Catches                                                                                                                |
+| ---------- | ------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| Unit       | `config` / `sandbox` / `result` / `errors` / `registry` | Argument parsing, path containment, output budget, error text, tool filtering                                          |
+| Protocol   | `server.test.ts`                                        | Handshake, `tools/list`, JSON Schema generation, `tools/call`, in-memory transport                                     |
+| Executable | `stdio.e2e.test.ts`                                     | Real spawned process: `bin` entry, shebang, exit codes, manifest version, and that stdout carries nothing but JSON-RPC |
+
+The e2e suite compiles the package itself in `beforeAll`, so it never
+silently skips when `dist/` is absent.
+
+## License
+
+Apache-2.0

package/dist/capabilities.d.ts

@@ -0,0 +1,29 @@
+/**
+ * MCP resources and prompts.
+ *
+ * Both exist to move cost out of the model's context.
+ *
+ * **Resources** publish the help topics at stable URIs, so a client can show
+ * them and a model can read one without spending a tool call. The same content
+ * is still reachable through `documonster_help`, because not every client
+ * supports resources.
+ *
+ * **Prompts** are workflow templates the *user* invokes. They matter because the
+ * hardest part of using this server well is knowing the order to do things in —
+ * inspect, then read narrowly, then write, then verify. A prompt encodes that
+ * sequence once instead of relying on the user to describe it.
+ */
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { ServerConfig } from "./config.js";
+/** Register one resource per help topic. */
+export declare function registerResources(server: McpServer): void;
+/**
+ * Register workflow prompts.
+ *
+ * Each returns a single user message that states the goal *and* the discipline —
+ * inspect first, keep data server-side, verify by reading back. Those three
+ * habits are what separate a cheap correct run from an expensive wrong one, and
+ * a prompt is the only place to establish them before the model starts.
+ */
+export declare function registerPrompts(server: McpServer, config: ServerConfig): void;
+//# sourceMappingURL=capabilities.d.ts.map

package/dist/capabilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"capabilities.d.ts","sourceRoot":"","sources":["../src/capabilities.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAC;AAGzE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAMhD,4CAA4C;AAC5C,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CAezD;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,GAAG,IAAI,CAgL7E"}