MCP Server Doccreator

🚀 MCP 服務器（符合 MCP 協議）

本 MCP 服務器遵循 Model Context Protocol (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 端點，用於文檔生成、任務狀態檢查和結果下載。
• 可擴展性：採用模塊化架構，便於添加新的文件類型或工具。

📦 安裝指南

安裝步驟

1. 克隆倉庫：

   git clone <repository-url>
   cd mcp-server
   

2. 安裝依賴項：

   npm install
   

3. 設置環境變量：
   • 複製 .env.example 為 .env，並填寫所需的值。

💻 使用示例

基礎用法

構建與啟動

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 的性能參數。