代码审查工具

一个通过命令行接口(CLI)执行代码审查的工具,支持多种审查模式和配置选项。

  • by 2001Y
  • TypeScript
  • 本地部署
  • 更新于
在 GitHub 查看 2001Y/coderabbit-cli-mcp

使用说明

coderabbit cli mcp

英文文档就在这里。完整的日文版本可在 README.ja.md.

run_review 是此服务器公开的唯一MCP工具。当CodeRabbit CLI丢失或未经身份验证时,相同的工具响应会解释如何引导它,并提醒Codex向用户报告,而不是自主操作。

快速入门(Codex CLI)

已发布的包(npx)

codex mcp add coderabbit-cli-mcp \
  -- "npx" \
  "-y" \
  "coderabbit-cli-mcp"

开发检查(本地 tsx)

codex mcp add coderabbit-cli-mcp \
  --env TSX_BANNER=false \
  -- "$(pwd)/node_modules/.bin/tsx" \
  "$(pwd)/src/server.ts"

注册后,您可以使用以下工具检查工具 codex mcp call coderabbit-cli-mcp tools/list 或触发器 run_review 通过 codex mcp call.

Codex配置(客户端)

~/.codex/config.toml 控制Codex如何启动MCP服务器。从上面的最小条目开始,然后添加可选旋钮:

[mcp_servers.coderabbit-cli-mcp]
command = "npx"
args = ["coderabbit-cli-mcp@latest"]
tool_timeout_sec = 1800  # allow up to 30 minutes (default 60)
# startup_timeout_sec = 60

[mcp_servers.coderabbit-cli-mcp.env]
# CODERRABBIT_MCP_LOCK_MODE = "plain"
# CODERRABBIT_MCP_LOCK_TYPE = "uncommitted"
# CODERRABBIT_MCP_LOCK_CONFIG_FILES = "[\".coderabbit.yaml\"]"
# CODERRABBIT_TOOL_TIMEOUT_SEC = "1800"
  • 取消注释您需要的可选行。保持 command/args 对于已发布的安装,也可以将其替换为本地安装 tsx 命令从快速启动部分。
  • tool_timeout_sec 当评论可能超过一分钟时,应≥600。
  • CODERRABBIT_MCP_LOCK_MODE / _TYPE 用普通的绳子。
  • CODERRABBIT_MCP_LOCK_CONFIG_FILES 必须是JSON数组(CodeRabbit的 -c 标志接受多个文件,因此在那里列出所有必需的配置路径)。
  • CODERRABBIT_TOOL_TIMEOUT_SEC 应与您分配的值匹配 tool_timeout_sec 因此该服务器可以确认配置。
  • 这些环境变量是 不 通过MCP工具参数接受;Codex的环境是放置它们的唯一场所。
  • 因为环境携带这些值,所以不需要额外的服务器端配置文件。

提供的工具

工具 角色 关键参数
run_review 执行 coderabbit 全旗覆盖。如果CLI丢失或未经身份验证,则相同的响应包括设置指南,并指示Codex询问用户。 mode, type, base, baseCommit, cwd, extraArgs[]

run_review参数

参数 类型 描述 默认值
mode interactive plain prompt-only
type all committed uncommitted
base string 覆盖基础分支(--base). 未设置
baseCommit string 推翻基础承诺(--base-commit). 未设置
cwd string CLI运行的目录;必须存在。 服务器 process.cwd()
configFiles string[] 通过预配置 CODERRABBIT_MCP_LOCK_CONFIG_FILES (JSON数组)。 未设置
extraArgs string[] 逐字附加到CLI argv(谨慎使用)。 未设置
  • --no-color 始终附加,以便MCP客户端接收纯输出。
  • 仅 mode/type/configFiles 可以通过Codex进行预配置;每次工具调用都必须提供所有其他参数。

安全和操作说明

  • 服务器从不尝试安装CodeRabbit或运行 coderabbit auth login。按照发出的指导,在您自己的shell中手动执行命令。
  • Codex(或任何MCP客户) 不得 当发生错误时,可以自行运行其他命令。将指导报告给用户,等待明确指示后重试。
  • 不支持Windows本机;取而代之的是提供WSL2指令。PATH的修改仍然是手动的。
  • MCP服务器不读取Codex的 AGENTS.md 动态。保持治理规则 AGENTS.md,并依靠上述环境变量来执行 mode/type.

发展

npm install
npm run build
npm run dev

CLI烟雾测试

# List tools through the MCP inspector
npx @modelcontextprotocol/inspector \
  --cli node dist/server.js \
  --method tools/list

# Call run_review (plain output against uncommitted changes)
npx @modelcontextprotocol/inspector \
  --cli node dist/server.js \
  --method tools/call \
  --tool-name run_review \
  --tool-arg mode=plain \
  --tool-arg type=uncommitted

# List report:// resources for recent runs
npx @modelcontextprotocol/inspector \
  --cli node dist/server.js \
  --method resources/list

# List prompts
npx @modelcontextprotocol/inspector \
  --cli node dist/server.js \
  --method prompts/list

npm发布清单

npm run build
npm pkg fix
npm version patch   # or minor / major as needed
npm publish --access public
npm view coderabbit-cli-mcp version