review-assist
Turn an AI coding agent's session into a guided, verifiable pull-request review. Open-source intent documents, a validator, an MCP server, and a GitHub review app that explains the why behind every change.
Documentation
Review Assist
Review AI-written code as fast as agents write it.
Turn a coding agent's session into a guided, verifiable pull-request review.
·
·
·
·
·
·
AI agents write code faster than anyone can read diffs — and the context that makes
review fast (what was asked, what was assumed, what was tried and abandoned, what was
tested) is thrown away the moment the PR opens. Review Assist captures it at the source:
an agent's session becomes an Intent Document, a validator proves it actually covers
the diff, and a GitHub App renders it as a guided review on top of the pull request.
Fully open source, self-hostable, and stores none of your code. Your session
transcript never leaves your machine. The app has no database: it reads the document and
diff from GitHub per request with the reviewer's own token, keeps them in memory for the
length of that request, and serves them `private, no-store` to a viewer that renders in
the reviewer's browser. Nothing is written down, but your code does pass through the
service in transit — if that matters to you, self-host it.
Install
Two one-time installs — the MCP server on the developer's side, the GitHub App on the repo's.
1. Register the MCP server with your agent (so it can author Intent Documents).
Claude Code and Codex keep separate configs, so registering with one does not register
with the other — run the section(s) you use.
Claude Code
claude mcp add -s user review-assist -- npx -y review-assist-mcpThe CLI and the VS Code extension share this one `-s user` config — but only when the
extension inherits your shell's `PATH` (launched via `code .`, not the Dock). Launched
from the Dock, GUI apps on macOS get just `/usr/bin:/bin:/usr/sbin:/sbin`, so `npx`
isn't found and the server shows *not connected* with no error. Register without `npx`
instead:
npm install -g review-assist-mcp
claude mcp add -s user review-assist -- "$(which node)" "$(npm root -g)/review-assist-mcp/dist/index.js"Codex
codex mcp add review-assist -- npx -y review-assist-mcpShared with the IDE extension (`~/.codex/config.toml`) under the same `code .` caveat as
above. Dock-launched VS Code:
npm install -g review-assist-mcp
codex mcp add review-assist -- "$(which node)" "$(npm root -g)/review-assist-mcp/dist/index.js"(Skip `npm install -g` if you already ran it for Claude Code — one global install
serves both extensions; each still needs its own `mcp add`.)
Claude desktop app — one-click, no terminal:
and open it.
**2. Install the GitHub App →**
One click. Read-only code + PR comments, no workflow files — it adds the automatic
check on every PR, the summary comment, and the guided-review viewer.
Update
Only relevant if you used the global-install form above (`npm install -g`) — `npx -y`
resolves to the latest release on every launch by itself.
npm install -g review-assist-mcp@latestRestart your agent afterward so it respawns the server process.
Uninstall
claude mcp remove -s user review-assist # or: codex mcp remove review-assist
npm uninstall -g review-assist-mcp # only if you used the global-install form
rm -rf ~/.review-assist # consent decisions and local run stateHow it works
Architecture
Three systems and two external actors. Your machine produces the change and its Intent
Document; the session transcript never leaves it. GitHub holds the pull request and every
durable piece of review state. The application reacts to `pull_request` events and posts
the check as its bot identity, then serves the guided review, reading and writing GitHub
as the signed-in reviewer.
The two-agent distillation — author and reviewer as separate role-locked contexts, and the
tools each one may reach — is a component-level view, kept in
`docs/ARCHITECTURE.md` along with the full route list.
Developing
| Path | Component |
|---|---|
| `packages/schema` | The format — JSON Schema (draft 2020-12) + TypeScript types |
| `packages/validator` | `review-assist` CLI + library: the five checks and the Markdown renderer |
| `packages/mcp-server` | MCP server that drives distillation and gatekeeps submissions |
| `apps/github-app/worker` | Stateless Cloudflare Worker: OAuth broker + thin GitHub proxy |
| `apps/github-app/viewer` | Client-side guided-review viewer |
| `SPEC.md` | The frozen design: the document's six sections and the five checks |
npm install
npm run build
# Validate and render the example Intent Document
node packages/validator/dist/cli.js validate packages/schema/src/example.json
node packages/validator/dist/cli.js render packages/schema/src/example.json
# Preview the guided viewer with mock data → http://localhost:8787/#acme/checkout-service/pull/42
node scripts/mockserver.mjs
# Tests
npx vitest runArchitecture and internals: `docs/ARCHITECTURE.md`.
Contributing
Issues and pull requests are welcome. If the guided review reads wrong on one of your
pull requests, open an issue with the
Intent Document and the diff that produced it — that pair is usually enough to reproduce.
Proposals to change the format itself are worth raising as an issue first, since
`SPEC.md` is deliberately frozen and any change ripples through the validator,
the viewer, and every document already committed.
Before opening a pull request, run the checks under Developing; CI runs the
same build, typecheck, tests, and example validation.
License
Frequently asked questions
What is review-assist?
review-assist is Turn an AI coding agent's session into a guided, verifiable pull-request review. Open-source intent documents, a validator, an MCP server, and a GitHub review app that explains the why behind every change.
How do I install review-assist?
Open the GitHub repository and follow its README. Most MCP servers are added to your client's MCP config, then called by your agent.
Is review-assist open source?
Yes — it is hosted on GitHub at https://github.com/uditk2/review-assist and has 2 stars.
Related MCP tools
The go-to web for your AI coding agent — local-first search, fetch, crawl & research over MCP. No API keys, no cloud, $0/query. Public beta.
MCP server that enables AI assistants to interact with Google Gemini CLI, leveraging Gemini's massive token window for large file analysis and codebase understanding
superglue (YC W25) builds integrations and tools from natural language. Get production-grade tools for long tail and enterprise systems.
Universal AI context generator. Saves thousands of tokens per conversation in Claude Code, Cursor, Copilot, Codex, and more.
A desktop MCP client designed as a tool unitary utility integration, accelerating AI adoption through the Model Context Protocol (MCP) and enabling cross-vendor LLM API orchestration.
Cut AI token costs 95%+ on code exploration. The leading MCP server for precise, symbol-level GitHub code retrieval via tree-sitter AST. Works with Claude Code, Cursor & any MCP client. 313B+ tokens saved.
Run your own MCP server? See who uses it and what to fix.
Measure it with TrackMCP