read-docs-mcp 是一个Model Context Protocol (MCP) 服务器，旨在为AI Agent提供结构化的方式来访问和理解软件项目的文档，同时也提供创建符合其读取格式的文档的指导。

项目简介

read-docs-mcp 允许支持MCP协议的客户端（如某些IDE或LLM应用）连接到它，然后通过调用它提供的工具来获取特定Git仓库中项目文档的内容。它通过预定义的文档结构和配置，将文档内容转化为AI可理解和利用的上下文信息。

主要功能点

文档访问: 能够从指定的Git仓库中读取项目文档。
动态工具生成: 根据仓库中配置的文档模块（如 hooks, components），自动生成用于访问这些模块文档的工具（如获取列表、概览、详细信息）。
结构化读取: 支持根据配置读取特定文件（如概览、列表）和根据名称读取详细文件。
文档创建指导: 在未指定仓库时，提供如何组织文档结构和配置文件的详细指南。
配置灵活: 支持自定义文档路径、分支以及文档文件和文件夹的命名模式。

安装步骤

read-docs-mcp 通常通过 Node.js 包管理器 'npx' 直接运行，无需预先全局安装。确保您的系统已安装 Node.js 环境即可使用。

服务器配置

read-docs-mcp 服务器由支持MCP的客户端启动和管理。您需要在客户端（例如 Cursor 编辑器）的设置中配置本服务器的启动命令和参数。配置信息通常以 JSON 格式存储。

以下是两种使用模式的配置示例结构（请根据您的实际情况修改参数值，无需复制此处的代码框）：

// Read Documentation Mode (用于连接并读取现有Git仓库的文档)
{
  // 您为这个MCP服务器实例定义的名称，YourLibName应替换为您项目的实际名称
  "read-docs-YourLibName": {
    "command": "npx", // 启动服务器的命令
    "args": [ // 传递给命令的参数列表
      "-y", // npx 参数，自动确认安装read-docs-mcp
      "read-docs-mcp", // 要运行的MCP包名称
      "--git-repo-path=https://github.com/user/repo", // **必需**：您的Git仓库的HTTPS或SSH URL
      "--name=YourLibName", // **必需**：您项目的名称，用于标识和内部路径管理
      "--branch=main", // (可选) 要读取的分支名称，默认为 "main"
      "--docs-path=docs" // (可选) 文档在仓库中的相对路径，默认为 "docs"
      // "--clone-location=/path/to/clone" // (可选) 指定在本地克隆仓库的路径，默认为用户主目录下的临时目录
    ]
  }
}

// Create Documentation Mode (用于启动服务器以获取文档创建的指导)
{
  // 您为这个MCP服务器实例定义的名称
  "create-read-docs": {
    "command": "npx", // 启动服务器的命令
    "args": [ // 传递给命令的参数列表
      "-y", // npx 参数，自动确认安装read-docs-mcp
      "read-docs-mcp" // 要运行的MCP包名称，无需提供仓库信息
    ]
  }
}

将上述示例配置添加到您的MCP客户端的 'mcpServers' 设置中，并根据您要读取的仓库或获取指导的需求填写正确的参数。

基本使用方法

在您的MCP客户端中配置 read-docs-mcp 服务器并启动客户端。客户端会自动与服务器建立连接。
在客户端提供的AI Agent交互界面中，通过提及您在配置中为服务器定义的名称，来请求服务器提供的功能。
如果您配置了 Read Documentation Mode (例如 'read-docs-YourLibName')，您可以向AI Agent提问关于该仓库文档的问题，例如："Using the 'read-docs-YourLibName' MCP, can you give me an overview of the components module?" (使用 'read-docs-YourLibName' MCP，你能给我组件模块的概览吗？)。AI Agent会调用对应的工具获取信息。
如果您配置了 Create Documentation Mode (例如 'create-read-docs')，您可以向AI Agent寻求关于如何组织文档的帮助，例如："Using the 'create-read-docs' MCP, how should I structure my documentation files?" (使用 'create-read-docs' MCP，我该如何组织我的文档文件？)。

关键词

信息