AI万址

文档解析MCP服务

一个通过结构化接口使AI代理能够访问和理解软件包文档的模型上下文协议(MCP)服务器,支持文档自动生成工具、多模块访问和模糊搜索等功能。

文档解析MCP服务是 ZebraRoy 开发的 MCP 服务器:一个通过结构化接口使AI代理能够访问和理解软件包文档的模型上下文协议(MCP)服务器,支持文档自动生成工具、多模块访问和。接入两步走:npx -y read-docs-mcp --name=MyDocs --git-repo-path=https://github.com/user/private-repo --personal-token=your_personal_access_token_here,再把下文配置粘进客户端 mcpServers 段重启即可。

它是干什么的

先把话说清楚:文档解析MCP服务不是又一个大模型,而是一个标准的 MCP 服务器。装好之后,你的 AI 客户端多出一组新工具,模型可以按需调用。一个通过结构化接口使AI代理能够访问和理解软件包文档的模型上下文协议(MCP)服务器,支持文档自动生成工具、多模块访问和模糊搜索等功能

项目数据
开发者ZebraRoy
Star7
收藏0
质量等级A
平台分类开发效率
部署标签本地部署、文档解析、AI代理工具
仓库read-docs-mcp

核心能力

  • Automatically generates MCP tools from documentation structure
  • Supports multiple documentation modules (hooks, components, utilities, etc.)
  • Configurable naming patterns for documentation files and module folders
  • Provides listing, overview, and detailed documentation access
  • Dynamic tool generation based on configured modules
  • Fallback to package.json for version information
  • Customizable documentation path
  • Fuzzy search capability to find files by keyword with smart prioritization

适合谁用

两类人最该装:一是天天在 Claude Desktop、Cursor 里写代码,想让 AI 直接帮你跑命令、改仓库、读文件的人;二是已经在用 MCP 生态、想按需拼装能力的折腾型用户。反过来,如果你只需要偶尔手动用它背后的服务,直接开网页就行,不必上 MCP。

完整安装配置步骤

动手前确认环境齐了:

  • Node.js 18 或更高版本(旧版 npx 跑不动一部分新版 MCP 包)。
  • 一个支持 MCP 的客户端:Claude Desktop、Cursor、Cline、Windsurf 任选其一。

第 1 步:安装文档解析MCP服务

终端里任选一条(不同安装方式,效果等价):

bash
npx -y read-docs-mcp --name=MyDocs --git-repo-path=https://github.com/user/private-repo --personal-token=your_personal_access_token_here
npx -y read-docs-mcp --name=MyDocs --git-repo-path=git@gitlab.service-hub.tech:frontend/private-repo.git --personal-token=your_personal_access_token_here
npx -y read-docs-mcp --name=MyDocs --git-repo-path=https://github.com/user/repo
npx -y read-docs-mcp --name=MyDocs --git-repo-path=https://github.com/user/repo --mode=normal

第 2 步:按官方说明写入配置

文档解析MCP服务的 README 没给标准 mcpServers JSON,配置入口见 官方文档 的 Usage/Configuration 章节。原则不变:客户端配置文件里加 mcpServers 条目,重启生效。

第 3 步:重启并验证

完全退出客户端再打开(是托盘里真正退出,不是关窗口)。工具列表里出现文档解析MCP服务的工具即接入成功;调用报错的话,先查下面的坑点清单。

容易踩的坑

  • 改了配置没反应:客户端只重启了窗口没退进程。macOS 按 Cmd+Q,Windows 检查托盘。
  • JSON 报错打不开客户端:多半是最后多个逗号。粘进任何 JSON 校验器里查一遍再保存。

常见问题

Q

文档解析MCP服务免费吗?

A

代码在 GitHub(https://github.com/ZebraRoy/read-docs-mcp)开放获取。个别功能依赖第三方服务时费用另算,看仓库 LICENSE 和定价页。

Q

文档解析MCP服务能用在 Cursor / Cline 吗?

A

能。MCP 是通用协议,同一份 mcpServers 配置在这些客户端之间基本通用,只是配置文件位置不同。

Q

需要外网或代理吗?

A

拉包和调用官方 API 需要能访问 GitHub 与对应服务域名,内网环境先测 git ls-remote 和接口连通性。