@Shareworker/Code Review

English | 中文

English

An MCP server that exposes the deterministic engineering layer of code review as tools, callable by host agents (Claude Code, Codex, Devin) within their own LLM loops. The server never calls an LLM — all reasoning happens in the host session.

Why

General-purpose agents doing code review via Skills suffer from: incomplete coverage (skipping files on large changesets), position drift (line numbers don't match actual code), and unstable quality (minor prompt variations cause large quality swings). This server enforces hard constraints on the review process — file selection, smart bundling, rule matching, comment positioning, and comment reflection — so quality is stable regardless of host model variation.

Tools

Installation

One command — auto-detects your agent, writes MCP config, installs the skill:

# macOS / Linux
npx @shareworker/code-review-mcp setup

# Windows (PowerShell) — npx has a known issue passing args to scoped bins
npm install -g @shareworker/code-review-mcp && code-review-mcp setup

That's it. Restart your agent and the code-review MCP server is available.

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

Configuration

Optional — the server works out of the box with built-in default rules (correctness, security, performance, maintainability, test coverage). Only create .code-review/rules.json when you need project-specific rules.

To generate an example config in your repo:

npx @shareworker/code-review-mcp init-config

Or create .code-review/rules.json manually (or ~/.code-review/rules.json for global config):

{
  "filters": {
    "exclude": ["**/*.lock", "**/*.min.js", "**/*.map"],
    "include": ["**/*.ts", "**/*.js"]
  },
  "rules": [
    {
      "path": "**/*.ts",
      "rule": "Check for any types and proper null handling"
    },
    {
      "path": "**/*mapper*.xml",
      "rule": "Check SQL for injection risks and missing closing tags"
    }
  ]
}

Configuration Resolution Priority

1. --rule <path> flag (highest) — not exposed via MCP, reserved for future CLI
2. <repo>/.code-review/rules.json — project-level
3. ~/.code-review/rules.json — global/user-level
4. Built-in defaults (lowest) — covers correctness, security, performance, maintainability, test coverage

For MVP, only layers 2-4 are active (no --rule flag since there's no CLI). The first matching user rule replaces the built-in system rule at the same layer.

filters

• exclude: glob patterns for files to exclude (merged with built-in defaults)
• include: glob patterns — when present, only matching files are reviewed

rules

Array of { "path": "<glob>", "rule": "<text>" }. First match wins. The rule text is returned as prompt_section for the host LLM to inject into its review prompt.

Development

npm install
npm run build      # compile TypeScript
npm test           # run unit tests
npm run dev        # watch mode

License

MIT

中文

一个 MCP 服务器，将代码审查的确定性工程层封装为工具，供宿主代理（Claude Code、 Codex、Devin）在自身的 LLM 循环中调用。服务器自身不调用任何 LLM —— 所有推理 都在宿主会话中完成。

为什么需要

通用代理通过 Skill 做代码审查时存在三大问题：覆盖不完整（大变更集时跳过文件）、 定位漂移（行号与实际代码不匹配）、质量不稳定（提示词微小变化导致质量大幅波动）。 本服务器对审查流程施加硬约束 —— 文件选择、智能打包、规则匹配、评论定位、 评论反思 —— 使质量不受宿主模型变化影响。

工具

安装

一条命令——自动检测你的 agent，写入 MCP 配置，安装 skill：

# macOS / Linux
npx @shareworker/code-review-mcp setup

# Windows (PowerShell) — npx 对 scoped 包传参有已知问题
npm install -g @shareworker/code-review-mcp && code-review-mcp setup

完成。重启 agent 即可使用 code-review MCP 服务器。

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

配置

可选 —— 服务器开箱即用，内置默认规则（正确性、安全性、性能、可维护性、 测试覆盖率）。仅在需要项目特定规则时才创建 .code-review/rules.json。

在仓库中生成示例配置：

npx @shareworker/code-review-mcp init-config

或手动创建 .code-review/rules.json（或 ~/.code-review/rules.json 作为全局配置）：

{
  "filters": {
    "exclude": ["**/*.lock", "**/*.min.js", "**/*.map"],
    "include": ["**/*.ts", "**/*.js"]
  },
  "rules": [
    {
      "path": "**/*.ts",
      "rule": "检查 any 类型和空值处理"
    },
    {
      "path": "**/*mapper*.xml",
      "rule": "检查 SQL 注入风险和标签闭合"
    }
  ]
}

配置优先级

1. --rule <path> 命令行参数（最高）—— MCP 未暴露，预留给未来 CLI
2. <repo>/.code-review/rules.json —— 项目级
3. ~/.code-review/rules.json —— 全局/用户级
4. 内置默认规则（最低）—— 覆盖正确性、安全性、性能、可维护性、测试覆盖率

MVP 版本仅启用 2-4 层（无 CLI 故无 --rule 参数）。同一层中首个匹配的用户规则 替换内置系统规则。

filters

• exclude：排除文件的 glob 模式（与内置默认黑名单合并）
• include：包含文件的 glob 模式 —— 存在时仅审查匹配的文件

rules

{ "path": "<glob>", "rule": "<文本>" } 数组。首个匹配生效。rule 文本作为 prompt_section 返回，供宿主 LLM 注入审查提示词。

开发

npm install
npm run build      # 编译 TypeScript
npm test           # 运行单元测试
npm run dev        # 监听模式

许可证

MIT