@eigenpal/docx-editor-agents

Create an EditorBridge backed by a DocxReviewer. The agent (or MCP client) can read, comment, propose changes, etc., against a parsed DOCX file on disk. Call `reviewer.toBuffer()` afterwards to get the modified DOCX.

declare function createReviewerBridge(reviewer: DocxReviewer): EditorBridge;

Execute a tool call against an EditorBridge. Returns the result (never throws).

declare function executeToolCall(toolName: string, input: Record<string, unknown>, bridge: EditorBridge): AgentToolResult;

Get tool schemas in OpenAI function-calling format. Works directly with the OpenAI SDK and Anthropic's tools API. For Vercel AI SDK, LangChain, or other agent runtimes, transform this output to that runtime's required shape — see `examples/agent-chat-demo/` for a Vercel AI SDK example. The package stays runtime-agnostic.

declare function getToolSchemas(): {
    type: "function";
    function: {
        name: string;
        description: string;
        parameters: Record<string, unknown>;
    };
}[];

declare class ChangeNotFoundError extends Error

declare class CommentNotFoundError extends Error

Headless DOCX reviewer — parse a file, read/comment/track changes against the document model, write the modified DOCX back out. No DOM, no editor instance. Pair with `createReviewerBridge()` to drive the built-in agent tools against a file on disk.

declare class DocxReviewer

```ts
const reviewer = await DocxReviewer.fromBuffer(buffer, 'AI Reviewer');
reviewer.addComment(5, 'Fix this paragraph.');
reviewer.replace(5, '$50k', '$500k');
const output = await reviewer.toBuffer();
```

Thrown when accept/reject resolves a tracked change to a footnote or endnote body. accept/reject operate on the document body only, and a tracked-change `w:id` is unique only within its part (document.xml / footnotes.xml / endnotes.xml), so a note change cannot be mutated through this reviewer yet. Fails closed rather than silently no-op'ing or mis-reporting the change as not-found.

declare class NoteChangeNotEditableError extends Error

Error classes for eigenpal/docx-editor-agents

declare class TextNotFoundError extends Error

Definition of an agent tool — name, JSON-schema input, handler. Use this to build custom tools alongside the built-in `agentTools`.

interface AgentToolDefinition<TInput = Record<string, unknown>>

Result returned by a tool handler. `success: false` carries an `error` message; `success: true` may carry tool-specific `data`.

interface AgentToolResult

interface BatchError

interface BatchResult

interface BatchReviewOptions

interface GetContentOptions

interface ReviewChange

interface ReviewComment

The formal Word-JS-API parity surface. Each method maps to one or more Word API methods (named in the JSDoc above each member).

If you change the EditorBridge surface, this interface must change too — the static assertion at the bottom of the file enforces it.

interface WordCompatBridge

type ContentBlock = HeadingBlock | ParagraphBlock | TableBlock | ListItemBlock;

All built-in agent tools — read/write document content, comments, and tracked changes. Use `getToolSchemas()` to feed them to an LLM and `executeToolCall()` to run the handlers against an `EditorBridge`.

agentTools: AgentToolDefinition<any>[]