New

docx-editor 1.x has shipped. Vue support, i18n, agents. Read the migration guide →

API Referencev1.0.2

@eigenpal/docx-editor-core/mcp

MCP Server Module

Model Context Protocol server for exposing document editing tools to AI clients.

Functions(3)

Create an MCP server instance

declare function createMcpServer(config?: McpServerConfig): McpServer;

Handle a JSON-RPC request

declare function handleJsonRpcRequest(server: McpServer, request: JsonRpcRequest): Promise<JsonRpcResponse>;

Start the MCP server with stdio transport

Reads JSON-RPC requests from stdin, writes responses to stdout. This is the standard way to run an MCP server for Claude Desktop.

declare function startStdioServer(config?: McpServerConfig): Promise<void>;

Interfaces(3)

MCP Server instance

interface McpServer
MemberTypeSummary
getInfoGet server info
handleToolCallHandle a tool call
listToolsList available tools
sessionMcpSessionActive session
toolsMap<string, McpToolDefinition>All registered tools

MCP Server configuration

interface McpServerConfig
MemberTypeSummary
additionalTools?McpToolDefinition[]Custom tools to add
debug?booleanEnable debug logging
includeCoreTools?booleanInclude core tools (default: true)
name?stringServer name
version?stringServer version

Tool info for listing

interface McpToolInfo
MemberTypeSummary
category?string
descriptionstring
inputSchemaJsonSchema
namestring

Variables(11)

Apply paragraph style

applyStyleTool: McpToolDefinition

Close a document

closeDocumentTool: McpToolDefinition
coreMcpTools: McpToolDefinition[]

Delete text in a range

deleteTextTool: McpToolDefinition

Apply text formatting

formatTextTool: McpToolDefinition

Get document information

getDocumentInfoTool: McpToolDefinition

Get document plain text

getDocumentTextTool: McpToolDefinition

Insert text at a position

insertTextTool: McpToolDefinition

Load a DOCX document from base64

loadDocumentTool: McpToolDefinition

Replace text in a range

replaceTextTool: McpToolDefinition

Save a document to base64

saveDocumentTool: McpToolDefinition