You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-7Lines changed: 25 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,6 +30,7 @@ AI systems are good at generating text, but Word documents are structured packag
30
30
-**Structure validation** for package parts, content controls, tables, paragraphs, fields, comments, images, revisions, and protected body blocks.
31
31
-**Python MCP facade and bridge runtime** for local agent integration, path policy, session queues, and distribution compatibility.
32
32
-**.NET 8 Open XML SDK engine** as the authoritative offline DOCX transaction backend, using a packaged native binary or Release DLL when available.
33
+
-**Single-file standalone binaries and quickstart bundles** for no-clone, no-venv, no-.NET-SDK offline DOCX editing and one-command Agent Skill installation.
33
34
-**Office.js taskpane** for Word-side anchors, PatchSet preview, dry-run, apply, and open-document content-control editing with hash checks.
34
35
-**Live Word session tools** (`word_session_*`) so Codex can read, preview, apply, and roll back edits in the currently open Word document through Office.js.
35
36
-**Local HTTP bridge** secured by a local token and localhost-only CORS for Office add-in workflows.
@@ -58,17 +59,31 @@ The Office.js taskpane is the Word session layer. It creates and lists content c
58
59
Use the most native distribution path your agent host supports:
59
60
60
61
1.**MCP Registry / MCPB first**: install the MCP server from the official MCP Registry using server name `io.github.flyfish-dev/word-ai`.
61
-
2.**Agent Skill next**: install the `word-ai` Skill so Codex, Claude Code, and compatible agents know when to choose offline `docx_*` versus live `word_session_*`.
62
-
3.**Local source install for full Word sessions**: use this when you need the Office.js taskpane, localhost bridge, .NET Open XML regression path, or development workflow.
63
-
4.**npm as a secondary channel**: use npm only when your MCP host cannot consume MCP Registry/MCPB yet, or when you want a no-clone stdio server command.
62
+
2.**Standalone quickstart for the lowest local setup cost**: download the current-platform GitHub Release bundle when you want one executable that can run MCP, install the Skill, and generate Codex config without a source checkout.
63
+
3.**Agent Skill next**: install the `word-ai` Skill so Codex, Claude Code, and compatible agents know when to choose offline `docx_*` versus live `word_session_*`.
64
+
4.**Local source install for full Word sessions**: use this when you need the Office.js taskpane, localhost bridge, .NET Open XML regression path, or development workflow.
65
+
5.**npm as a secondary channel**: use npm only when your MCP host cannot consume MCP Registry/MCPB yet, or when you want a no-clone stdio server command.
Choose the artifact matching your platform: `linux-x64`, `linux-arm64`, `osx-arm64`, `osx-x64`, `win-x64`, or `win-arm64`. See [Distribution](docs/DISTRIBUTION.md) for the complete release asset policy.
86
+
72
87
Install the Skill and full local runtime:
73
88
74
89
```bash
@@ -134,7 +149,7 @@ Offline file transactions use the .NET Open XML backend by default when it is av
134
149
3. Local source project via `dotnet run --project dotnet/WordAi.OpenXml/WordAi.OpenXml.csproj`.
135
150
4. Python OOXML fallback only when .NET is unavailable and `WORD_AI_ENGINE=auto`.
136
151
137
-
MCPB and GitHub Release assets include self-contained native backends for `osx-arm64`, `osx-x64`, `linux-x64`, `linux-arm64`, `linux-musl-x64`, `linux-musl-arm64`, `win-x64`, and `win-arm64`. Word AI detects the current RID, including Linux glibc vs musl, and loads the matching binary automatically. The npm launcher keeps the package small: on first run it downloads only the current-platform native archive from the GitHub Release, verifies the SHA-256 checksum, caches it under the user cache, and sets `WORD_AI_DOTNET_NATIVE_DIR`. Advanced deployments can override detection with `WORD_AI_DOTNET_RID`, `WORD_AI_DOTNET_EXE`, or `WORD_AI_DOTNET_NATIVE_DIR`; set `WORD_AI_SKIP_NATIVE_DOWNLOAD=1` to disable npm native downloads.
152
+
MCPB and GitHub Release assets include self-contained native backends for `osx-arm64`, `osx-x64`, `linux-x64`, `linux-arm64`, `linux-musl-x64`, `linux-musl-arm64`, `win-x64`, and `win-arm64`. Standalone quickstart bundles are built for standard hosted platforms: `linux-x64`, `linux-arm64`, `osx-arm64`, `osx-x64`, `win-x64`, and `win-arm64`. Word AI detects the current RID, including Linux glibc vs musl for native backend loading, and loads the matching binary automatically. The npm launcher keeps the package small: on first run it downloads only the current-platform native archive from the GitHub Release, verifies the SHA-256 checksum, caches it under the user cache, and sets `WORD_AI_DOTNET_NATIVE_DIR`. Advanced deployments can override detection with `WORD_AI_DOTNET_RID`, `WORD_AI_DOTNET_EXE`, or `WORD_AI_DOTNET_NATIVE_DIR`; set `WORD_AI_SKIP_NATIVE_DOWNLOAD=1` to disable npm native downloads.
138
153
139
154
Control it with `WORD_AI_ENGINE=auto|dotnet|python`, or pass `engine` to `docx_assess_patchset`, `docx_dry_run_patchset`, `docx_apply_patchset`, and `docx_validate`. Use `WORD_AI_ENGINE=dotnet` in production to fail fast instead of silently falling back.
140
155
@@ -176,9 +191,10 @@ After installation, start a new agent session or restart the client if the skill
176
191
Word AI is published for discovery through the official MCP Registry and MCPB distribution. Prefer this channel for MCP host installation because it carries standardized server metadata, versioning, transport details, and provenance:
177
192
178
193
- MCP server name: `io.github.flyfish-dev/word-ai`
- Standalone and quickstart guide: [Distribution](docs/DISTRIBUTION.md)
182
198
183
199
Local container smoke test:
184
200
@@ -190,7 +206,7 @@ docker run --rm -i \
190
206
word-ai:local
191
207
```
192
208
193
-
The MCP Registry release uses a public MCPB artifact for one-click-friendly local server installation. The MCPB package requires Python 3.10+ and bootstraps a local virtual environment on first run. The Dockerfile remains available for local or self-hosted builds. For full Office.js live-session editing, use the local install path because the Word taskpane and localhost bridge must run on the user's machine.
209
+
The MCP Registry release uses a public MCPB artifact for one-click-friendly local server installation. The standalone quickstart bundle is the lowest-friction local command path because it embeds the Python facade, dependencies, current-platform .NET Open XML backend, schemas, and Skill template in one executable. The MCPB package requires Python 3.10+ and bootstraps a local virtual environment on first run. The Dockerfile remains available for local or self-hosted builds. For full Office.js live-session editing, use the local source install path because the Word taskpane and localhost bridge must run on the user's machine.
0 commit comments