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。
• 受开源项目对更好文档需求的启发。