Document Engine is in alpha and subject to breaking changes while the contract and adapters continue to evolve.
.docx files without a visible editor:
| Surface | Best for | Runtime |
|---|
| Document API | In-browser editing via editor.doc.* | Browser |
| SDKs | Backend automation with typed methods | Node / Python |
| CLI | Scripts and CI pipelines | Any shell |
| MCP Server | AI agents (Claude Code, Cursor, custom) | Local subprocess |
find is editor.doc.find() in the browser, superdoc.doc.find() in the SDK, superdoc find in the CLI, and superdoc_find in MCP.
How it works
The Document API defines the canonical operations. The CLI and MCP server wrap them for different consumers. The SDKs manage the CLI process and expose typed methods.
Which surface should I use?
| Your setup | Surface | Why |
|---|
| Web app with a visible editor | Document API | Direct access via editor.doc.* — no network round-trips |
| AI agent (Claude Code, Cursor, Windsurf, custom) | MCP Server | Sessions keep the editor alive across tool calls |
| Backend automation (Node.js / Python) | SDKs | Typed methods, session management, error handling built in |
| Shell scripts or CI pipelines | CLI | Stateless one-shot commands — no process to manage |
| Serverless (Lambda, Vercel, Workers) | CLI or SDKs | Open the file, run the operation, return the result |
