AI 能力(MCP / Skills)
ReUI 提供 MCP 服务器与 Skills 知识包,让 AI 助手查询组件文档、示例与源码,并按团队规范产出代码。
ReUI 提供与 Semi Design MCP/Skills 同形态的 AI 能力:
- MCP(Model Context Protocol)负责「查得到」——组件文档 / 示例 / 源码 / 函数实现 / 跨库检索 / 库级指南, 以统一协议暴露给 AI 助手,无需为每个工具单独集成。
- Skills 负责「怎么用」——把引入方式、主题、国际化、Nuxt 接入、扩展规范与常见陷阱 以模块化文档安装到 IDE 的 skills 目录,让 AI 按团队规范产出代码。
一键配置(推荐)
一条命令同时写入 MCP 配置并安装 Skills(默认针对 Trae / CodeBuddy / Qoder):
各工具的项目级落地位置:
| 工具 | Skills 目录 | MCP 配置文件 |
|---|---|---|
| Trae | .trae/skills/<skill>/ | .trae/mcp.json |
| CodeBuddy | .codebuddy/skills/<skill>/ | .mcp.json(JSONC) |
| Qoder | .qoder/skills/<skill>/ | .mcp.json(或 .qoder/settings.json) |
| Cursor / Claude / 通用 | .cursor/skills/、.claude/skills/、.skills/ | .cursor/mcp.json、.mcp.json |
- 写入是幂等合并:只增改
mcpServers["reui-mcp"],其它服务器与顶层字段保持不变; 配置文件为非法 JSON 时默认报错不改动,--force会先备份为*.bak再重写。 - 各工具仍需手动完成的步骤(如 Trae 需在「设置 → MCP」打开项目级 MCP)与全部路径,见
npx -y @reglow/reui-mcp --list-tools。
手动配置 MCP
任意客户端(Trae / CodeBuddy / Qoder / Cursor / Claude Desktop 等)在 mcpServers 中加入:
等价的命令行方式:claude mcp add reui-mcp -- npx -y @reglow/reui-mcp、qoder mcp add reui-mcp -s project -- npx -y @reglow/reui-mcp。
仅安装 Skills 知识包
安装后落在 <project>/.trae/skills/reui-components/:
工具一览
| 工具 | 用途 |
|---|---|
get_reui_document | 组件文档 / 按分类的组件总览 |
get_reui_code_examples | 文档中的可复制示例(Vue / TS) |
list_component_files | 组件源码文件清单 |
get_file_code | 读取组件内文件内容(支持行号区间) |
get_function_code | 提取函数 / 常量 / 类定义 |
search_reui_docs | 跨文档与源码关键词检索 |
get_reui_guide | 库级指南(安装 / 主题 / i18n / Nuxt / 构建 / 约定) |
知识来源
| 来源 | 触发条件 | 内容 |
|---|---|---|
| 仓库工作区 | --root <reui 仓库路径> 或在本仓库内运行 | 组件 README + 全部源码 + 库级 guide.md |
| 项目本地安装 | 项目已安装 @reglow/reui(默认) | 与项目版本完全一致的文档与源码 |
| 指定 npm 版本 | version 参数 / --default-version | 下载该版本 tarball 后离线读取 |
| 官方文档站点 | 包内缺少 README 时自动兜底 | 抓取本站组件页并转 Markdown(会标注 ⚠️ 来源) |
CLI 选项
| 选项 | 说明 |
|---|---|
--root <dir> | 指定 ReUI 仓库工作区(开发组件库时使用) |
--default-version <ver> | 工具未传 version 时默认使用的版本(如 0.2.0、latest) |
--no-site | 禁用官方文档站点兜底(完全离线) |
--check | 自检:打印知识源、版本、组件数量后退出 |
--setup [tools] | 一键配置 AI 工具(MCP 配置 + Skills) |
--install-skills | 仅安装 Skills 知识包 |
--list-tools、--print-config | 列出支持的工具与路径 / 打印 MCP 客户端配置片段 |
完整说明见仓库 reui/mcp/README.md;包地址:npmjs.com/package/@reglow/reui-mcp。
