antdv-mcp

关键词

文档索引组件 API本地全文检索SQLite 数据库LLM 辅助查询
  • 项目简介
    • 该仓库实现了一个 MCP（Model Context Protocol）服务器，基于 Ant Design Vue 的文档数据及 API 信息，通过 SQLite 数据库提供资源查询、组件 API、以及文档搜索等功能，供 LLM 客户端以标准化 JSON-RPC 方式访问。
  • 主要功能点
    • 提供 MCP 工具集，让 LLM 客户端可以：
      • adv_search_docs：对文档和 API 进行全文检索，返回匹配的页面和 API 项的摘要
      • adv_list_components：列出指定版本下的组件清单
      • adv_get_component_api：获取某组件在指定版本下的 API 详情（props、events、slots、methods）
      • adv_find_prop：在指定组件中查找某个属性/项并给出近似匹配建议
    • 服务器搭载只读的 SQLite 数据库，数据结构包括 pages、components、api_items 及其对应的全角/半角匹配、别名等信息
    • 通过 stdio 传输（StdioServerTransport）对外提供服务，便于直接在 IDE/工具链中对接
  • 安装步骤
    1. 安装依赖并构建项目
      • 使用工作区工具安装依赖
      • 构建所有包以产出 dist/index.js
    2. 索引文档（如不存在数据库）
      • 使用索引工具建立并填充 data/antdv.sqlite 数据库（v3/v4 版本的文档索引）
    3. 启动 MCP 服务器
      • 服务器运行方式为标准输出/输入（stdio）通信
      • 服务器会读取环境变量 ANTDV_DB_PATH，定位本地数据库文件
    4. 与客户端连接
      • MCP 客户端需要准备一个配置，指明服务器名称、启动命令及参数等，以建立连接并调用工具
  • 服务器配置（MCP 客户端所需信息，使用 JSON 表示，便于插件/IDE 读取） 说明：以下配置用于指示客户端如何启动并连接到 MCP 服务器。请将路径替换为实际的构建产物路径与数据库路径。 { "server": "antdv-mcp-server", // 服务器在本地的名称标识 "command": "node", // 启动服务器的命令 "args": [ "/absolute/path/to/antdv-mcp/packages/mcp-server/dist/index.js" // 构建产物的入口脚本路径 ], "env": { "ANTDV_DB_PATH": "/absolute/path/to/antdv-mcp/data/antdv.sqlite" // 数据库文件的绝对路径 } // 备注：数据库文件应先通过 Indexer 生成并保存在指定路径，服务器启动后以只读方式访问 }
  • 基本使用方法
    1. 确保数据库文件已正确生成并可被服务器访问
    2. 启动 MCP 服务器（如上配置所示）并确保服务器启动日志输出正常
    3. 在你的 LLM 交互环境中调用工具：
      • adv_search_docs：传入 query、version、limit，获取文档与 API 的匹配结果
      • adv_list_components：传入 version，返回组件清单
      • adv_get_component_api：传入 component 与 version，返回组件 API 的详细结构
      • adv_find_prop：传入 component、prop、version，返回匹配的 Prop 或相似项
    4. 处理服务器返回的 content 字段（通常为文本 JSON 字符串），并将其呈现给用户/LLM

服务器信息

访问项目