read-docs-mcp
2025.05.06
1
JavaScript文档管理开发工具开发效率
read-docs-mcp 是一个模型控制协议（MCP）服务器，旨在帮助AI代理通过结构化接口访问和理解软件包的文档。它支持自动从文档结构中生成MCP工具，并提供多种文档模块（如钩子、组件、工具等）的访问。该服务器具有两种使用模式：读取文档模式和创建文档模式，分别用于访问现有文档和指导创建新的文档结构。
View on GitHub
Overview
基本能力
产品定位
read-docs-mcp 是一个专为AI代理设计的文档访问和理解工具，通过MCP协议提供结构化的文档访问接口。
核心功能
- 自动从文档结构生成MCP工具
- 支持多种文档模块（钩子、组件、工具等）
- 可配置的文档文件和模块文件夹命名模式
- 提供列表、概览和详细文档访问
- 基于配置模块的动态工具生成
- 回退到package.json获取版本信息
- 可自定义文档路径
适用场景
- AI代理需要访问和理解软件包文档
- 开发者需要为他们的库创建结构化文档
- 团队需要统一和自动化文档访问流程
工具列表
读取文档模式工具
get-[module]-list: 获取模块中所有项目的列表get-[module]-details: 获取模块中特定项目的详细信息get-[module]-overview: 获取模块的概览
创建文档模式工具
get-create-docs-instructions: 获取创建文档结构的详细指导
常见问题解答
- Git认证问题: 确保本地机器配置了正确的SSH密钥或HTTPS访问令牌
- 文档结构问题: 遵循预期的文档结构，或在创建文档模式下获取指导
- 命名模式问题: 确保模块文件夹和文件遵循配置的命名模式
使用教程
使用依赖
确保已安装Node.js和npm/npx。
安装教程
通过npx直接运行:
npx -y read-docs-mcp
或配置到Cursor设置中（参见README中的配置示例）。
调试方式
运行服务器后，可以通过提供的工具接口进行测试:
# 测试获取模块列表
curl -X POST http://localhost:<port>/get-hooks-list
# 测试获取模块详情
curl -X POST http://localhost:<port>/get-hook-details -d '{"name":"use-state"}'