项目简介

MCP Word文档生成服务('mcp-server-docx')是一个高性能、基于TypeScript的MCP(Model Context Protocol)服务器。它专为LLM(大型语言模型)客户端设计,能够以标准化的方式,将用户提供的Markdown文本或结构化数据高效转换为专业格式的Word文档(.docx)。该服务通过提供一系列易于使用的工具,极大地简化了自动化文档生成流程,是构建智能文档应用的核心组件。

主要功能点

  • 从Markdown快速生成Word文档(推荐):支持Markdown语法(如标题、列表、代码块、引用、粗体、斜体),能够一键将Markdown文本转换为排版专业的Word文档。这是最直观、最高效的文档创建方式。
  • 自定义文档样式:允许用户根据需求为Word文档中的标题、段落、列表等元素设置字体、字号、颜色、粗体、斜体、底边框等样式,实现高度个性化的文档输出。
  • 结构化内容批处理:提供精细化控制模式,通过接收包含段落、标题、列表等元素的结构化内容数组,以单次调用批量创建复杂布局和格式的文档,性能卓越。
  • 高性能表现:相较于传统逐行构建或基于Python的实现,该服务采用批处理和内存操作,文档生成速度显著提升,非常适合需要快速响应和批量处理的场景。
  • 会话式文档管理:支持文档创建、逐步添加内容,最终保存的会话模式,也支持一次性完成整个文档的创建和保存,提供灵活的工作流。
  • 内联Markdown格式支持:在段落和列表内容中,依然支持 '粗体' 和 '斜体' 等Markdown风格的内联格式。

安装步骤

要运行此MCP服务器,您需要首先在本地环境中进行设置:

  1. 克隆仓库并安装依赖 打开您的终端或命令行工具,执行以下命令:
    git clone https://github.com/jamesmehorter/mcp-server-docx.git
    cd mcp-server-docx
    npm install
    npm run build
    这些命令将下载项目代码,安装所有必要的依赖项,并编译TypeScript源代码生成可执行的JavaScript文件。

服务器配置

MCP服务器通常由LLM客户端(如Anthropic Claude Desktop)加载和使用。您需要将此MCP服务器的启动信息添加到您的MCP客户端配置文件中。

找到您的MCP客户端配置文件(通常在:

  • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%\Claude\claude_desktop_config.json'

在该配置文件中,找到或添加 'mcpServers' 部分,并加入以下配置信息。请注意,您需要将 '/绝对路径/到/mcp-server-docx' 替换为项目中 'dist/index.js' 文件的实际绝对路径。

{
  "mcpServers": {
    "word-document-server": { // 这是MCP服务器的唯一标识名称,LLM客户端将使用此名称引用它。
      "command": "node",     // 启动MCP服务器所使用的命令,这里是Node.js运行时。
      "args": ["/绝对路径/到/mcp-server-docx/dist/index.js"] // 启动命令的参数,指向编译后的服务器入口文件。
    }
  }
}

重要提示: 配置完成后,请务必完全退出并重新启动您的MCP客户端应用程序,以便加载新的MCP服务器配置。

基本使用方法

配置并重启MCP客户端后,LLM客户端即可通过自然语言指令或直接的工具调用来与MCP Word文档生成服务交互。以下是一些常见的使用示例,您可以直接在LLM客户端中尝试:

  • 从Markdown文本创建专业Word文档(推荐) 只需提供Markdown格式的内容,MCP服务器将自动解析并生成Word文档。

    Create a Word document at /tmp/my_report.docx from this markdown:
    
    # 项目报告
    
    ## 引言
    这是一份关于 **项目A** 的初步报告。
    
    *   目标:实现市场份额增长
    *   现状:正在开发中
  • 使用自定义样式创建Word文档 您可以为生成的文档指定特定的样式,例如字体和字号。

    Create a Word document at /tmp/styled_doc.docx from this markdown:
    
    # 标题
    
    这是一个自定义样式的段落。
    
    Use these custom styles:
    - All headings should be Helvetica
    - Paragraphs should be Arial 12pt
  • 通过结构化内容创建Word文档(高级用法) 当您需要对文档结构和格式进行更精确的控制时,可以通过描述调用 'create_document_from_content' 工具。LLM将根据您的描述自动构建并传递结构化内容数据。

    Create a resume at /tmp/my-resume.docx using create_document_from_content.
    
    Make the name "JANE SMITH" in Helvetica 36pt bold.
    Add a "PROFESSIONAL SUMMARY" H2 heading with a bottom border in Helvetica 14pt.
    Add a paragraph about my experience in Times New Roman 12pt.

    LLM将理解您的意图,并调用相应的MCP工具来生成符合您要求的Word文档。

信息

分类

开发者工具