doraemon-docs-mcp

MCP Server for @zcy/doraemon component library documentation.

通过 Playwright 无头渲染内网 SPA 页面，为 Claude Code / MCP 客户端提供组件文档查询能力。

安装

# 全局安装（可直接作为 MCP 命令使用）
npm install -g doraemon-docs-mcp

# 或作为项目依赖
npm install doraemon-docs-mcp

注意：首次使用前需安装 Playwright 浏览器：npx playwright install chromium

工具

| 工具名 | 说明 | |--------|------| | get_component_doc | 获取指定组件的完整文档（支持中英文组件名） | | list_components | 列出所有可用组件 | | search_components | 按关键词模糊搜索组件 |

MCP 配置

添加到 Claude Code 的 MCP 配置中（~/.claude.json）：

全局安装方式：

{
  "mcpServers": {
    "doraemon-docs": {
      "type": "stdio",
      "command": "doraemon-docs-mcp"
    }
  }
}

npx 方式（无需全局安装）：

{
  "mcpServers": {
    "doraemon-docs": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "doraemon-docs-mcp"]
    }
  }
}

本地路径方式：

{
  "mcpServers": {
    "doraemon-docs": {
      "type": "stdio",
      "command": "node",
      "args": ["/path/to/doraemon-docs-mcp/dist/index.js"]
    }
  }
}

开发

npm install
npm run dev       # 开发模式
npm run build     # 构建
npm run test      # 测试
npm run typecheck # 类型检查
npm run lint      # 代码检查

项目结构

src/
  index.ts          # MCP Server 入口
  scraper.ts        # Playwright 抓取逻辑
  component-map.ts  # 组件名称 -> slug 映射
  types.ts          # 类型定义

技术栈

• TypeScript — 严格模式
• tsup — 构建工具（基于 esbuild）
• Playwright — 无头浏览器渲染
• @modelcontextprotocol/sdk — MCP 协议实现

License

MIT