Skip to content

审查 MCP 工具 ​

mcp-wordrelay 是词驿官方 MCP server(npm 公开包),提供五件审查工具。本页介绍安装、配置与用法。

一行安装(推荐) ​

bash
curl -fsSL https://review.wordrelay.chat/install.sh | bash

脚本做三件事:把词驿令牌与审查服务地址写入 ~/.config/mcp-wordrelay/config.json(权限 600,只属于当前用户)、检测到 Claude Code 时自动执行 claude mcp add、幂等补领体验额度。全程交互输入令牌(不回显、不进 shell history),不安装其他任何东西——工具本体由 npx 按需拉取,始终是最新版。

Windows 用户

本页命令需在 WSL 或 Git Bash 中运行;其他客户端按下方手动配置接入,效果相同。

手动安装 ​

bash
npx mcp-wordrelay init          # 交互写入用户级配置(令牌、审查服务地址)
claude mcp add wordrelay -- npx -y mcp-wordrelay

或在任何支持 MCP 的客户端里直接声明(项目级 .mcp.json 或客户端设置):

json
{
  "mcpServers": {
    "wordrelay": {
      "command": "npx",
      "args": ["-y", "mcp-wordrelay"],
      "env": { "WORDRELAY_API_KEY": "sk-你的令牌" }
    }
  }
}

WORDRELAY_API_KEY 是唯一必填项。若需使用服务端深度审查(review_remote),再补两个环境变量(从审查服务网页复制,一行安装会自动注入):

json
"env": {
  "WORDRELAY_API_KEY": "sk-你的令牌",
  "WORDRELAY_REVIEW_AGENT_URL": "https://review.wordrelay.chat",
  "WORDRELAY_REVIEW_AGENT_SECRET": "网页上复制的提交凭证"
}

密钥安全

不要把真实令牌提交到代码仓库。.mcp.json 若入库,改用环境变量或用户级配置文件(~/.config/mcp-wordrelay/config.json)承载令牌。

工具一览 ​

工具用途
list_models列出当前令牌可用的模型(配置默认审查模型组前先跑它)
review本地并行审查:指定文件路径或 git diff,并行发给多个模型,返回各模型 {verdict, summary, findings[{file, line, severity, note}]}
ask_model通用第二意见:问答 / 方案对比 / 翻译,context_files 传路径由工具读取
review_remote服务端深度审查:提交代码包(from_dir 目录 / git 仓库),返回 job_id
get_review按 job_id 轮询深度审查状态与结构化报告

典型用法(在你的 AI 编程工具里直接说,或显式调用):

review(files: ["src/auth.ts"], skill: "security")
review(diff: "main...", models: ["glm-5.3", "deepseek-v4-pro"])
review_remote(from_dir: ".")
get_review(job_id: "...")

审查视角(skill) ​

内置三个视角,skill 参数选用,也可传自定义 markdown 文件路径(内容即审查指令):

  • general(默认)— 常规代码审查
  • security — 注入 / 鉴权 / 敏感信息专项
  • performance — 复杂度 / N+1 查询 / 并发专项

输出 JSON 规范由工具统一追加,任何视角的产出都可结构化解析;模型不守格式时自动降级保留其文本意见。

配置 ​

优先级:调用参数 > 环境变量 > 配置文件 > 平台默认。配置文件支持项目级 .mcp-wordrelay.json 与用户级 ~/.config/mcp-wordrelay/config.json(同名 camelCase 字段,如 apiKey、models)。

环境变量默认说明
WORDRELAY_API_KEY(必填)词驿令牌,控制台「令牌」页创建
WORDRELAY_BASE_URLhttps://wordrelay.chat词驿引擎地址
WORDRELAY_MODELS平台推荐组默认审查模型组,逗号分隔
WORDRELAY_SKILLgeneral默认审查视角
WORDRELAY_TIMEOUT_MS120000单模型超时(本地并行审查)
WORDRELAY_MAX_BYTES_PER_FILE65536单文件读取上限(超出截断并标注)
WORDRELAY_MAX_TOTAL_BYTES524288单次审查材料总量上限

安全边界 ​

  • 文件读取与 skill 加载被限制在工作目录沙箱内(防路径逃逸)
  • git ref 走白名单校验,无 shell 注入面
  • 单文件 64KB / 总量 512KB 双重上限,二进制文件自动跳过
  • 令牌只在请求头中出现,日志与错误信息零泄露
  • 服务端深度审查的容器隔离与数据生命周期见服务总览