AI 能力(MCP / Skills)

ReView 提供 MCP 服务器与 Skills 知识包,让 AI 助手查询组件文档、uvue 示例与源码,并按团队规范产出代码。

ReView 提供与同仓库 ReUI 同形态的 AI 能力:

  • MCP(Model Context Protocol)负责「查得到」——组件文档 / uvue 示例 / 源码 / 函数实现 / 跨库检索 / 库级指南。
  • Skills 负责「怎么用」——把 uni_modules 安装、easycom、平台差异、主题、i18n 与常见陷阱 以模块化文档安装到 IDE 的 skills 目录,让 AI 按团队规范产出代码。

ReView 组件库本身未发布到 npm(通过 DCloud 插件市场 / uni_modules 安装),因此 MCP 的知识来源为 本地仓库、项目内已安装的 uni_modules/reglow-review,或回退官方文档站点;version 参数保留但传值只会得到提示。

一键配置(推荐)

一条命令同时写入 MCP 配置并安装 Skills(默认针对 Trae / CodeBuddy / Qoder):

npx -y -p @reglow/review-mcp review-setup                              # 默认 trae,codebuddy,qoder
npx -y -p @reglow/review-mcp review-setup --tools trae,qoder           # 指定工具
npx -y -p @reglow/review-mcp review-setup --tools all --scope user     # 全部工具 / 用户级
npx -y -p @reglow/review-mcp review-setup --dry-run                    # 先预览再执行

各工具的项目级落地位置:

工具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["review-mcp"],其它服务器与顶层字段保持不变;各工具仍需手动完成的步骤 (如 Trae 需在「设置 → MCP」打开项目级 MCP)与全部路径,见 npx -y @reglow/review-mcp --list-tools。

手动配置 MCP

任意客户端(Trae / CodeBuddy / Qoder / Cursor / Claude Desktop 等)在 mcpServers 中加入:

{
  "mcpServers": {
    "review-mcp": {
      "command": "npx",
      "args": ["-y", "@reglow/review-mcp"]
    }
  }
}

在组件库仓库内开发时可追加 --root <review 仓库路径>。

仅安装 Skills 知识包

npx -y -p @reglow/review-mcp review-skills                        # 默认写入 .trae/skills
npx -y -p @reglow/review-mcp review-skills --target qoder         # .qoder/skills
npx -y -p @reglow/review-mcp review-skills --all                  # 全部已知工具目录
npx -y -p @reglow/review-mcp review-skills --list                 # 查看可用目标

安装后落在 <project>/.trae/skills/review-components/:

SKILL.md            技能入口(何时使用 + 组件库关键事实 + 硬性规则 + 文件导航)
WORKFLOWS.md        MCP 工具工作流与 6 个完整任务示例
BEST_PRACTICES.md   安装、easycom、平台差异、主题、i18n、性能与常见陷阱
COMPONENTS.md       按分类的组件选型清单(tag + 用途 + 文档路径)

工具一览

工具用途
get_review_document组件文档 / 按分类的组件总览(含 easycom 标签与官网链接)
get_review_code_examples从官方演示页提取可复制的 uvue 片段
list_component_files组件源码文件清单
get_file_code读取组件目录内文件内容(读 type Props / withDefaults 常用)
get_function_code提取函数 / 常量 / 类 / type 定义的完整实现
search_review_docs跨组件文档、演示页、源码与库级文档检索
get_review_guide库级指南(安装 / easycom / 主题 / i18n / 平台 / 更新日志 / 约定)
  • 组件名用 kebab-case 且不带 re- 前缀(button、search-history),也接受 easycom 标签写法(re-button)。
  • 所有返回都以「知识源 + 组件库版本 + 版本来源」开头(如 知识源:本地 ReView 仓库|组件库版本:1.0.6(2026-09-22)), 当内容来自官方文档站点兜底时会额外标注 ⚠️。

知识来源

来源触发条件内容
本地 ReView 仓库--root <dir>、REVIEW_ROOT 或在仓库内运行(默认)组件文档 + 全部源码 + 演示页 + README.md / CHANGELOG.md / docs/guide/*.md
项目内 uni_modules工作目录含 uni_modules/reglow-review仅组件源码(文档与官方链接回退官网)
官方文档站点本地缺文档、或未找到本地来源抓取本站组件页 / 指南页 / 版本记录页
  • 组件分类以 docs/.vitepress/sidebar.ts 为权威(9 个分类,与本站 components/<category>/<name> 路由段一致)。

完整说明见仓库 review/mcp/README.md;包地址:npmjs.com/package/@reglow/review-mcp。