Get the FREE Ultimate OpenClaw Setup Guide →

McpDocServer

一个基于MCP协议的开发文档服务器,专为各类开发框架文档设计

Installation
Run this command in your terminal to add the MCP server to Claude Code.
Run in terminal:
Command
claude mcp add --transport stdio ruan11223344-mcpdocserver node /absolute/path/server.js \
  --env PUPPETEER_SKIP_DOWNLOAD="true"

How to use

McpDocServer 是一个基于 MCP 协议的开发文档服务器,能够从本地文档、爬取的文档源以及内置文档源中提供高效的文档检索与详情查询。通过 MCP 工具集,你可以在 Cursor 或其他集成环境中执行工具调用,比如 search_docs 用于全文检索、get_doc_detail 用于获取指定文档的详细信息,以及通过查询参数触发文档重新加载(reload)。服务器会将文档源、页面内容和结构以标准化的 JSON 形式返回,帮助开发者在不同框架和版本之间进行准确对照,减少幻觉式错误。你可以根据需要指定文档源 name 进行过滤,亦可对文档进行跨源检索与定位。

How to install

Prerequisites:

  • 安装 Node.js(建议使用 LTS 版本)和 npm
  • 基本的网络访问权限以便爬虫和依赖下载

安装步骤:

  1. 将仓库克隆到本地后进入项目根目录 git clone <repository-url> cd <project-root>

  2. 安装依赖 npm install

  3. 配置并启动 MCP 服务器 将服务器入口文件路径替换为你本地的绝对路径后,使用以下命令启动服务器 npm start

  4. 运行测试(可选) npm test

  5. 在 Cursor 中配置对接(参照 README 的示例配置) 将服务器信息加入 mcp.json,以确保 Cursor 能正确加载 MCP 服务

注意:若你的爬虫需要下载浏览器二进制(如 Puppeteer),请根据 README 提供的环境变量设置来跳过下载并确保兼容性。

Additional notes

提示与常见问题:

  • 若首次运行需爬取文档,请按照 README 指定的 config/doc-sources.js 示例进行配置;爬虫完成后,文档将保存在 docs 目录下以供 MCP 服务器加载。
  • 重新加载文档时请使用 search_docs 的 query 参数传入 reload。
  • 确保 server.js 的绝对路径正确,否则 Cursor 将无法连接到 MCP 服务。
  • 当使用 puppeteer 进行爬取时,可以通过设置 PUPPETEER_SKIP_DOWNLOAD=true 跳过浏览器下载以节约时间,但请确保本地浏览器版本与页面兼容。
  • 如需并发爬取,请调整 crawlerConfig.maxConcurrency 的数值,避免对目标站点造成过大压力。
  • 本服务支持通过 source/name 过滤文档源,方便进行跨源比较与整合。

Related MCP Servers

Sponsor this space

Reach thousands of developers