Documcp

🚀 DocuMCP - 智能文檔部署MCP服務器

DocuMCP是一款智能的模型上下文協議（MCP）服務器，它徹底改變了開源項目的文檔部署方式。它能夠對倉庫進行深度分析，智能推薦靜態網站生成器，並自動執行GitHub Pages部署工作流。

🚀 快速開始

DocuMCP可以分析你的倉庫，推薦最適合的靜態網站生成器（如Jekyll、Hugo、Docusaurus、MkDocs或Eleventy），按照Diataxis原則創建專業的文檔結構，並自動將其部署到GitHub Pages。你只需說“分析我的倉庫並部署文檔”即可開始。

✨ 主要特性

核心功能

• 🔍 倉庫分析：對項目結構、依賴項和文檔需求進行深度多層分析。
• 🎯 靜態網站生成器推薦：基於數據為Jekyll、Hugo、Docusaurus、MkDocs或Eleventy提供推薦。
• 📚 Diataxis框架：按照成熟原則自動創建結構良好的文檔。
• 🚀 GitHub Pages部署：生成具有靜態網站生成器特定優化的自動化工作流。
• ✅ 部署驗證：進行全面檢查和故障排除，確保部署成功。

智能與學習（第二階段）

• 🧠 歷史智能：從過去的部署中學習，以改進推薦。
• 👤 用戶偏好：根據你的偏好和模式提供個性化推薦。
• 📊 部署分析：全面洞察部署模式和成功率。
• 🎯 智能評分：根據類似項目的成功率對靜態網站生成器進行智能評分。
• 📈 趨勢分析：識別部署趨勢並提供健康評分。

文檔維護（v0.5.2+）

• 📅 新鮮度跟蹤：通過可配置的閾值監控文檔的陳舊程度。
• ✅ 新鮮度驗證：自動初始化和更新新鮮度元數據。
• 🗺️ 站點地圖管理：生成、驗證和管理sitemap.xml以進行SEO優化。
• 🔗 知識圖譜集成：跟蹤新鮮度歷史，以提供智能推薦。

人工智能驅動的語義分析（v0.6.0+）

• 🤖 大語言模型集成：可選擇與DeepSeek、OpenAI、Anthropic或Ollama集成。
• 🔍 語義代碼分析：使用人工智能檢測超越語法的行為變化。
• 🧪 示例驗證：模擬代碼執行以驗證文檔示例。
• 🎯 智能回退：當大語言模型不可用時，優雅降級到僅使用抽象語法樹（AST）分析。
• 🔒 隱私優先：通過抽象語法樹分析完全離線工作，大語言模型為可選。

📦 安裝指南

安裝要求

• Node.js：20.0.0或更高版本。
• npm：最新穩定版本。

安裝步驟

# 克隆倉庫
git clone https://github.com/tosin2013/documcp.git
cd documcp

# 安裝依賴項
npm install

# 構建項目
npm run build

💻 使用示例

MCP客戶端設置

DocuMCP可與各種支持MCP的客戶端配合使用，以下是配置方法：

Claude Desktop

1. 定位Claude Desktop的配置文件：
   • macOS：~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows：%APPDATA%\Claude\claude_desktop_config.json
   • Linux：~/.config/claude/claude_desktop_config.json
2. 添加documcp服務器配置：

{
  "mcpServers": {
    "documcp": {
      "command": "npx",
      "args": ["documcp"]
    }
  }
}

3. 重啟Claude Desktop 以加載配置。

VS Code with GitHub Copilot

1. 為VS Code安裝MCP擴展。
2. 在VS Code的settings.json中進行配置：

{
  "mcp.servers": {
    "documcp": {
      "command": "npx",
      "args": ["documcp"]
    }
  }
}

Cursor Editor

1. 在Cursor設置中進行配置：

{
  "mcpServers": {
    "documcp": {
      "command": "npx",
      "args": ["documcp"]
    }
  }
}

Gemini Code Assist

1. 查看Gemini文檔 以獲取MCP服務器配置信息。
2. 添加類似上述的配置。

故障排除

• 確保npx在你的PATH環境變量中可用。
• 對於全局安裝，使用完整路徑：

{
  "command": "node",
  "args": ["/usr/local/lib/node_modules/documcp/dist/index.js"]
}

• 查找安裝路徑：npm list -g documcp。

快速開始

配置好MCP客戶端後，只需用自然語言向DocuMCP發出提示：

# 完整工作流
"analyze my repository and deploy documentation to GitHub Pages"

# 分步操作
"analyze my repository for documentation needs"
"recommend the best static site generator for my project"
"set up documentation structure and deploy to GitHub Pages"

DocuMCP提供了30多種工具，包括倉庫分析、智能靜態網站生成器推薦、內容生成、帶跟蹤和驗證的部署自動化、用戶偏好管理、部署分析以及增強記憶的洞察。有關詳細的工具參考，請參閱 完整文檔。

關鍵工具

分析與推薦

• analyze_repository - 深度分析倉庫結構和依賴項。
• recommend_ssg - 結合歷史數據和用戶偏好進行智能靜態網站生成器推薦。
• detect_gaps - 識別缺失的文檔部分。

部署與跟蹤

• deploy_pages - 自動部署到GitHub Pages並跟蹤結果。
• verify_deployment - 全面驗證部署情況。
• analyze_deployments - 分析部署歷史以獲取洞察。

用戶偏好與學習

• manage_preferences - 管理用戶偏好以實現個性化推薦。
• 查看歷史成功率和部署模式。
• 根據類似項目的成功案例獲取推薦。

開發

# 以開發模式運行
npm run dev

# 運行測試
npm test

# 代碼檢查
npm run lint

# 類型檢查
npm run typecheck

🔧 技術細節

架構

DocuMCP採用模塊化、無狀態的架構：

• 基於TypeScript：使用官方MCP SDK實現。
• 無狀態操作：確保一致性和可靠性。
• 模塊化設計：職責明確分離。
• 漸進式複雜度：允許用戶從簡單開始。

文檔結構（Diataxis）

DocuMCP會自動按照Diataxis框架創建文檔：

• 教程：面向新手的學習指南。
• 操作指南：針對特定目標的任務型配方。
• 參考資料：面向信息的技術描述。
• 解釋說明：面向理解的概念性討論。

🤝 貢獻

我們歡迎貢獻！有關詳細信息，請參閱我們的 貢獻指南。

首次貢獻者

查找標記為“good first issue”的問題，以開始參與項目。我們歡迎所有經驗水平的開發者貢獻代碼。

報告問題

報告錯誤或請求功能時，請使用我們的 問題模板。

📄 許可證

本項目遵循 MIT許可證。

致謝

• 基於 Model Context Protocol 構建。
• 遵循 Diataxis Framework。
• 受開源項目對更好文檔需求的啟發。