MCP Server Doccreator

🚀 MCP 服务器（符合 MCP 协议）

本项目是一个符合 Model Context Protocol (MCP) 标准的 MCP 服务器，通过 MCP 协议公开文档生成功能，可与 Copilot、Cursor、Claude Desktop 等 AI 主机集成，为用户提供便捷的文档生成服务。

🚀 快速开始

先决条件

• Node.js（建议版本 v14+）
• Redis 服务器

安装

1. 克隆仓库：

   git clone <repository-url>
   cd mcp-server
   

2. 安装依赖项：

   npm install
   

3. 设置环境变量：
   • 复制 .env.example 为 .env，并填写所需的值。

运行服务器

npm start

运行测试

npx jest src/services/fileCreation.test.js --runInBand

✨ 主要特性

• 文档生成：基于 AI 驱动的提示，可生成 PDF、Word、PowerPoint 和 Excel 文件。
• 图片嵌入与缩放：支持在 DOCX 和 PPTX 文件中插入图片并调整其大小。
• 异步处理：借助 BullMQ 和 Redis 对文档生成任务进行排队和处理。
• 验证：通过捕获和分析截图来验证文档布局。
• API 首要：提供 RESTful 端点，用于文档生成、任务状态检查和结果下载。
• 可扩展性：采用模块化架构，便于添加新的文件类型或工具。

📦 安装指南

环境准备

确保系统中已安装 Node.js（建议版本 v14+）和 Redis 服务器。

代码克隆与依赖安装

git clone <repository-url>
cd mcp-server
npm install

环境变量配置

复制 .env.example 为 .env，并根据实际情况填写所需的值。

启动服务

npm start

💻 使用示例

构建与启动

npm run build
npm start

MCP 主机配置示例（stdio）

在你的主机的 mcp.json 中添加以下配置：

{
  "servers": {
    "your-server-name": {
      "type": "stdio",
      "command": "node",
      "args": ["server.js"]
    }
  }
}

验证连接

运行以下命令以验证与 MCP 服务器的连接：

mcp ls
mcp info your-server-name

📚 详细文档

MCP 功能

• MCP 工具：generateDocument 可从提示生成 PDF、DOCX、PPTX 或 XLSX 文件。
• 传输层：标准输入输出（本地，默认），若有需要，可添加服务器发送事件（SSE）以支持网络通信。
• 模式验证：使用 zod 进行输入验证。
• 可扩展性：能够轻松添加更多工具、资源或提示。

API 端点

• POST /documents/generate：请求文档生成（支持 PDF、DOCX、PPTX、XLSX 格式）。
• GET /documents/generate/status/:jobId：检查任务状态。
• GET /documents/generate/result/:jobId：下载生成的文件。

文件生成与验证

• 支持通过 Gemini/OpenAI 函数调用实现 AI 驱动的内容和布局。
• DOCX 和 PPTX 中支持图片插入及缩放功能。
• 布局验证使用截图（模拟或真实，见 aiFileValidationService）。

🔧 技术细节

项目结构

src/
  app.js
  server.js
  config/
  controllers/
  middleware/
  public/
  routes/
  services/
  utils/
  workers/
temp_image/
validation-screenshots/
test-output/

📄 许可证

文档中未提及相关许可证信息。

⚠️ 重要提示

• 确保 Redis 服务器已正确安装并运行。
• 在生产环境中，建议使用 HTTPS 并启用身份验证来保护 API 端点。
• 对于大规模任务处理，请根据需要优化 BullMQ 和 Redis 的性能参数。