DocuMind MCP Server 使用说明

项目简介

DocuMind MCP Server 是一款基于 Model Context Protocol (MCP) 的服务器应用，它利用先进的神经处理技术，对软件仓库中的文档（主要是 README 文件）进行深入分析，评估文档质量，并提供改进建议。旨在帮助开发者提升项目文档的规范性和可读性。

主要功能点

README 文件质量评估: 使用 AI 算法分析 README 文件的结构、内容和格式。
SVG Header 图片分析: 评估 README 文件头部 SVG 图片的质量和规范性。
多语言支持: 支持英文和日文等多种语言的文档分析。
改进建议: 基于分析结果，提供具体的文档改进建议，例如添加语言切换 badge、优化图片质量等。
MCP 工具集成: 作为一个 MCP 服务器，可以通过客户端调用 'evaluate_readme' 工具，对指定项目路径下的 README 文件进行评估。

安装步骤

安装 Node.js: 确保你的系统中已安装 Node.js 18 或更高版本。
克隆仓库: 将仓库 'https://github.com/Sunwood-ai-labs/documind-mcp-server' 克隆到本地。
安装依赖: 在仓库根目录下，运行以下命令安装项目依赖：
```
npm install
```
构建项目: 运行以下命令编译 TypeScript 代码：
```
npm run build
```

服务器配置

要将 DocuMind MCP Server 集成到 MCP 客户端（例如 Claude Desktop），你需要配置服务器的启动命令。以下是配置示例，以 Claude Desktop 为例，编辑其配置文件 'claude_desktop_config.json'（Windows 路径通常为 '%APPDATA%/Claude/claude_desktop_config.json'）：

{
  "mcpServers": {
    "documind-mcp-server": {
      "command": "/path/to/documind-mcp-server/build/index.js"
    }
  }
}

配置参数说明:

'server name': 'documind-mcp-server' (服务器名称，可以自定义，用于在客户端中标识)
'command': '/path/to/documind-mcp-server/build/index.js' (指向 DocuMind MCP Server 构建后的入口文件 'index.js' 的绝对路径。请将 '/path/to/documind-mcp-server' 替换为你的本地仓库路径)
'args': （可选参数，本项目无需额外参数）

基本使用方法

配置完成后，在 MCP 客户端中，你可以调用 DocuMind MCP Server 提供的 'evaluate_readme' 工具来分析项目文档。

调用 'evaluate_readme' 工具示例 (JSON-RPC 请求):

{
  "jsonrpc": "2.0",
  "method": "MCP.CallTool",
  "params": {
    "serverName": "documind-mcp-server",
    "toolName": "evaluate_readme",
    "arguments": {
      "projectPath": "/path/to/your/project"  //  替换为你要分析的项目的根目录的绝对路径
    }
  },
  "id": 1
}

请求参数说明:

'serverName': 'documind-mcp-server' (你在客户端配置中设置的服务器名称)
'toolName': 'evaluate_readme' (要调用的工具名称)
'arguments': 工具的参数，'evaluate_readme' 工具需要 'projectPath' 参数，指定要分析的项目的根目录的绝对路径。

服务器会分析指定项目根目录及其子目录下的所有 'README.md' 和 'README.ja.md' 文件，并返回分析结果，包括文件路径、质量评分、改进建议等。分析结果将以 JSON 字符串的形式包含在 MCP 响应的 'content' 字段中。

响应示例 (JSON-RPC 响应):

{
  "jsonrpc": "2.0",
  "result": {
    "content": [
      {
        "type": "text",
        "text": "[{\"filePath\":\"/path/to/your/project/README.md\",\"hasHeaderImage\":true,\"headerImageQuality\":{\"hasGradient\":true,\"hasAnimation\":true,...},\"score\":95,\"suggestions\":[\"Consider adding language badges\",...]}]"
      }
    ]
  },
  "id": 1
}

分析结果会详细指出 README 文件存在的问题和改进方向，帮助开发者编写更高质量的项目文档。

关键词