JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 39
  • Score
    100M100P100Q61881F
  • License MIT

MCP Server with Code Review

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (code-review-mcp-server) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Code Review MCP Tool

    This tool is a Model Context Protocol (MCP) server that provides automated code review and leaves GitHub PR comments for any app that supports MCP integration.

    Ask DeepWiki

    Features

    • Compare code differences between two git branches
    • Compare code differences from GitHub pull request URLs
    • Add summary comments to GitHub pull requests
    • Add line-specific comments to GitHub pull requests
    • Provide detailed code review guidelines
    • Support Notion integration to retrieve review guidelines from Notion code blocks, with default guidelines as fallback
    • Include pre-configured style and code review guidelines

    Tools

    • CodeReview: Runs git diff between branch and base branch. Returns the diff along with instructions to review and fix issues.
    • CodeReviewWithGithubUrl: Fetches diff from a GitHub PR URL. Returns the diff along with instructions to review and fix issues.
    • AddPRSummaryComment: Adds a summary comment to a GitHub PR.
    • AddPRLineComment: Adds multiple comments to specific lines in a GitHub PR. Supports commenting on specific changed lines in the PR diff.

    Architecture

    • MCP Server: Listens for code review requests from any MCP-compatible client app.
    • Git Integration: Uses local git or GitHub PRs to generate diffs.
    • Notion Integration: Fetches review guidelines from Notion code blocks if configured.
    • Automated Review: Analyzes code diffs and generates review comments and suggestions.

    Prerequisites

    • Node.js (v18 or above recommended)
    • Git installed on your system
    • For GitHub PR review, you must provide either:
      • a GITHUB_TOKEN environment variable (to use the GitHub RESTful API), or
      • have the GitHub CLI (gh) installed and authenticated
    • (Optional) Notion API token for guideline integration

    MCP Configuration

    To use this tool in any app that supports MCP, follow these steps:

    1. Open the configuration file for your MCP-supported app.
    2. Add the following configuration:
    {
      "mcpServers": {
        "code-review-tool": {
          "command": "npx",
          "args": ["-y", "code-review-mcp-server"],
          "env": {
            "GITHUB_TOKEN": "github_token",
            "NOTION_API_KEY": "notion_api_key",
            "NOTION_CODE_REVIEW_GUIDELINE_CODE_BLOCK_URL": "notion_code_block_url_here",
            "NOTION_STYLE_GUIDELINE_CODE_BLOCK_URL": "notion_code_block_url_here",
            "IGNORE_PATTERNS": "pattern1,pattern2,pattern3"
          }
        }
      }
    }

    Environment Variables Description:

    • GITHUB_TOKEN: GitHub personal access token for API access. Optional - falls back to GitHub CLI if not provided.
    • NOTION_API_KEY: Required for fetching review guidelines from Notion.
    • NOTION_CODE_REVIEW_GUIDELINE_CODE_BLOCK_URL: Notion URL containing code review guidelines. Must point to a Notion </> Code block and requires valid NOTION_API_KEY to function. Falls back to default guidelines if not configured or API key is missing.
    • NOTION_STYLE_GUIDELINE_CODE_BLOCK_URL: Notion URL containing style guidelines. Must point to a Notion </> Code block and requires valid NOTION_API_KEY to function. Falls back to default guidelines if not configured or API key is missing.
    • IGNORE_PATTERNS: Optional comma-separated glob patterns for files to exclude from review.

    Notion Integration Setup

    1. Request Notion API Token

    1. Visit Notion Developers
    2. Create a new Integration
    3. Obtain the API token

    For detailed instructions, refer to: Notion API Authorization Guide

    2. Configure Environment Variables

    The tool requires the following environment variables:

    NOTION_API_KEY=your_token_here
    NOTION_CODE_REVIEW_GUIDELINE_CODE_BLOCK_URL=your_notion_code_block_url
    NOTION_STYLE_GUIDELINE_CODE_BLOCK_URL=your_notion_style_guideline_url

    These can be provided in the env section of your MCP configuration as shown above.

    3. Add Integration to Notion Page

    1. Click the Share button on your Notion page
    2. Add your Integration to the page's share list

    Note: Currently only supports reading code blocks from Notion

    For detailed instructions, refer to: Notion API Connections Guide

    Usage

    Tip: For better review results, it's recommended to switch to the branch being reviewed before running the code review command.

    Local Git Branch Review

    In your MCP-compatible app, send the following command:

    code review
    base branch: branch/any_branch

    This will:

    1. Compare differences between the current branch and the specified base branch
    2. Automatically generate a git diff
    3. Perform a review based on style and code review guidelines
    4. Provide detailed review results and improvement suggestions

    GitHub PR Review

    In your MCP-compatible app, send the following command:

    code review
    https://github.com/owner/repo/pull/123
    
    After generating the review report, please:
    
    1.  Add PR summary comment
    2.  If individual files require suggested changes, use line comments.

    This will fetch the PR's diff, provide a code review, and leave PR comments directly on GitHub.

    CI Integration for Automated Code Review

    You can automate code review in your CI pipeline by triggering an n8n webhook, which will call this project's MCP tool to perform the review and return results or leave comments on your PR.

    For a step-by-step guide and recommended workflow diagram, see: CI Integration with n8n and MCP Tool

    Review Guidelines

    This tool provides two default sets of guidelines:

    1. Style Guide: Includes code style standards for variable naming, function naming, constant naming, etc.
    2. Code Review Guidelines: Includes code quality standards based on SOLID principles, readability, immutability, etc.

    You can also customize these guidelines through Notion integration.