README.md
Perform code reviews by accessing staged files, git diffs, and file content.
Git Code Review MCP
An MCP (Model Context Protocol) server that allows AI to review your changes before pushing. This tool provides AI assistants with access to git repository information, staged files, and diffs to help with code review workflows.
Features
- Get Staged Files: List all files currently staged for commit
- View Diffs: Show the diff of staged changes with space-change filtering
- File Content Access: Retrieve the content of any file from the repository
- Repository Agnostic: Works with any git repository by specifying the path
Example MCP Client Configuration
If you're using this with an MCP client, add it to your configuration:
{
"mcpServers": {
"git-codereview": {
"command": "npx",
"args": ["git-codereview"]
}
}
}
Installation
The easiest way to use this MCP server is with npx:
npx git-codereview
This will run the MCP server directly without needing to install it globally.
Alternative Installation Methods
Global Installation
npm install -g git-codereview
git-codereview
Local Development
git clone https://github.com/AyoubTRD/git-codereview-mcp.git
cd git-codereview-mcp
npm install
npm run build
node build/index.js
Usage
This MCP server runs over stdio and is designed to be used with MCP-compatible AI tools. The server provides three main tools:
Available Tools
get_staged_files
- Lists all files currently staged for commit
- Requires:
repoPath(full path to git repository)
get_diff
- Shows the diff of staged files with added/modified filter
- Ignores whitespace changes for cleaner output
- Requires:
repoPath(full path to git repository)
get_file_content
- Retrieves the content of any file from the repository
- Useful when diff doesn't provide enough context
- Requires:
repoPath(full path to git repository) andfilePath(relative path to file)
Requirements
- Node.js (version 16 or higher)
- Git repository (the target repository must be git-initialized)
- MCP-compatible AI tool or client
License
ISC
Contributing
Issues and pull requests are welcome at GitHub.
Tools (3)
get_staged_filesLists all files currently staged for commit in the repository.get_diffShows the diff of staged files with added/modified filtering and ignores whitespace.get_file_contentRetrieves the content of any file from the repository.Configuration
claude_desktop_config.json
{"mcpServers": {"git-codereview": {"command": "npx", "args": ["git-codereview"]}}}Try it
→List all the files I have currently staged for commit in my project.
→Show me the diff of the staged changes to review my current work.
→Read the content of src/index.js to help me understand the context for my current changes.
→Review my staged changes and suggest improvements based on the diff.