McpDocServerBLOCK

English Documentation

一个基于MCP协议的开发文档服务器,专为各类开发框架文档设计。提供文档多线程爬取、本地文档加载、关键词搜索和文档详情获取功能。

核心功能演示

1. 文档爬取演示

从配置到执行`npm run crawl`的完整文档爬取过程

2. MCP服务器调用演示

在Cursor中查询API并获取准确文档结果的过程

解决Cursor幻觉问题

在使用Cursor进行各类框架开发时,经常会遇到AI对框架API不够精确的理解,导致的"幻觉"问题:

• 准确性问题:AI可能推荐不存在或已过时的框架API和组件
• 版本混淆:混合不同版本的API文档,导致代码无法正常运行
• 参数错误:对方法参数的理解不准确,特别是针对框架特有功能
• 兼容性误判:无法准确判断某个API在不同环境或平台中的兼容性

本MCP服务器通过提供精确的文档检索能力,有效解决上述问题:

• 实时精准查询:直接从官方文档源获取最新准确的API信息
• 上下文关联:将相关API和组件文档关联展示,提供完整参考
• 参数精确匹配:提供完整的方法签名和参数列表,消除参数错误
• 跨平台兼容标记:明确标识API在不同平台的兼容性
• 示例代码:提供官方示例代码,确保用法正确

通过集成此MCP服务器,可以显著提高Cursor在各类框架开发过程中的准确性和效率,避免"幻觉"带来的开发障碍。

功能特点

• 支持从本地 JSON 文件加载框架文档数据
• 提供强大的文档搜索功能
• 提供文档详情查询
• 自动识别可用文档源
• 支持特定文档源的定向查询
• 支持爬取外部文档,自动转换为本地可用格式
• 支持重新加载文档(通过搜索"reload"触发)

目录结构

/
├── server.js              # 服务器入口文件
├── docs/                  # 文档数据目录
│   ├── taro-docs.json     # Taro框架文档
│   └── taroify-docs.json  # Taroify组件库文档
├── scripts/               # 脚本目录
│   └── crawl.js           # 文档爬取脚本
├── tests/                 # 测试目录
│   └── mcp.test.js        # MCP测试脚本
├── config/                # 配置文件目录
│   └── doc-sources.js     # 文档源配置
└── package.json           # 项目配置

安装和运行

如果你本地已经安装了 Chrome 浏览器,并且希望 puppeteer 使用你已有的版本,可以设置 PUPPETEERSKIPDOWNLOAD 环境变量:

macOS/Linux:

export PUPPETEER_SKIP_DOWNLOAD=true
npm install

Windows (命令提示符):

set PUPPETEER_SKIP_DOWNLOAD=true
npm install

Windows (PowerShell):

$env:PUPPETEER_SKIP_DOWNLOAD = $true
npm install

1. 爬取文档数据

爬虫用于获取框架文档,是使用服务器前的重要步骤。您需要先创建爬虫配置文件,然后运行爬虫脚本。

创建爬虫配置

在 config 目录中创建 doc-sources.js 文件,参照以下格式:

// config/doc-sources.js

// 文档源配置
export const docSources = [
{
// 文档源名称 - 会用作搜索时的source参数
name: "taro",
// 文档网站基础URL
url: "https://docs.taro.zone/docs",
// 包含模式 - 指定要爬取的URL路径(空数组表示所有页面