CodeRabbit Documentation

website·Indexed 42 days ago

https://docs.coderabbit.ai

AI-powered code review and investigation platform. Features include Change Stack for structured pull request reviews, CodeRabbit Agent for autonomous planning and action, and a REST API for managing organizations, repositories, roles, and metrics. Supports integrations with GitHub, GitLab, Bitbucket, Azure DevOps, and Claude Code.

Tokens
183.7K
Snippets
558
Records
1.5K
Agent score
88%

What's inside CodeRabbit

  1. Overview of MCP Servers in CodeRabbit

    CodeRabbit acts as an MCP (Model Context Protocol) client, allowing it to query external MCP servers to gather additional context for code reviews and chat. This enables CodeRabbit to access internal documentation, wikis, project management tickets (issues/specs), and design assets (e.g., Figma) to make review comments more relevant to organizational standards. The number of supported MCP server connections varies by plan: Essentials (5), Team (10), Advanced (15), and Enterprise (20).
  2. Overview of CodeRabbit Agent for Discord

    CodeRabbit Agent for Discord integrates a coding assistant into public Discord channels. It allows community members to investigate repository context, answer implementation questions, prepare code changes, and open pull requests directly from the conversation where maintainers are coordinating work.
  3. Overview of CodeRabbit Knowledge Base context sources

    CodeRabbit enriches code reviews by combining the diff with several context sources to provide smarter analysis:

    • Learnings: Adaptive AI memory that learns team preferences from natural-language chat.
    • Code Guidelines: Automatically detects rules from files like .cursorrules, CLAUDE.md, and .github/copilot-instructions.md.
    • Multi-repo Analysis: Detects breaking changes and API mismatches across linked repositories.
    • MCP Servers: Accesses internal APIs, databases, or documentation via the Model Context Protocol.
    • Web Search: Gathers up-to-date external documentation on libraries and APIs.
    • Linked Issues: Reads GitHub, GitLab, Jira, and Linear issues to understand PR intent and validate changes.
  4. Overview of CodeRabbit Change Stack

    Change Stack is a review workspace that converts a pull request into a structured artifact. Unlike standard PR views that list files alphabetically, Change Stack groups changes into coherent, numbered 'layers' based on how the change was built and the logical dependencies between components. It allows developers to read changes, ask questions via chat, and perform review actions (comment, approve, merge) in a single interface.
  5. Overview of OSV-Scanner in CodeRabbit

    CodeRabbit integrates OSV-Scanner (version 2.5.1), a tool by Google that identifies vulnerabilities in project dependencies by cross-referencing them with the OSV.dev database. It scans dependency manifest and lock files to provide vulnerability severity scores and detailed information.
  6. Overview of Luacheck static analysis in CodeRabbit

    Luacheck is a static analyzer and linter for Lua code integrated into CodeRabbit. It detects issues such as undefined global variables, unused variables and values, accessing uninitialized variables, and unreachable code. It automatically runs on files with the .lua extension.
  7. Overview of CodeRabbit supported analysis tools

    CodeRabbit integrates various third-party open-source linters, security analyzers, and CI/CD tools to perform code reviews. These tools are used to identify general bugs, security risks, secret exposure, insecure dependencies, misconfigured infrastructure-as-code (IaC), and CI/CD pipeline failures. Tools are categorized by their primary function, such as Code Quality, Code Security, Secret Scanning, and PII detection.
  8. Overview of CodeRabbit Plan

    CodeRabbit Plan transforms high-level ideas, issues, PRDs, and designs into precise, project-aware Coding Plans. Unlike generic outlines, these plans are grounded in deep codebase understanding and the project's Knowledge Base, ensuring they reference the correct files and follow established architectural patterns. The workflow consists of three main stages: Create, Refine, and Handoff.
  9. Overview of OpenGrep in CodeRabbit

    CodeRabbit utilizes OpenGrep (version 1.28.0), a high-performance static code analysis engine, to identify security vulnerabilities and bugs. OpenGrep is compatible with Semgrep rule sets.
  10. Overview of ember-template-lint in CodeRabbit

    CodeRabbit uses ember-template-lint to analyze Ember and Glimmer Handlebars (.hbs) template files during pull requests. The tool identifies accessibility violations, deprecated patterns, template anti-patterns, and style issues.
  11. Overview of CodeRabbit IDE Extension capabilities

    The CodeRabbit IDE extension allows developers to review code changes before committing and create agent-ready Coding Plans directly within their editor. It can be used as a standalone tool for local development or combined with CodeRabbit's pull request reviews for full code quality coverage.
  12. Overview of CodeRabbit Jira Integration capabilities

    Connecting CodeRabbit to Jira enables several AI-driven development workflows:

    • Context Enrichment: Pulls Jira issue details into PR reviews so the AI understands the purpose of changes.
    • Requirement Validation: Validates if code changes satisfy the linked issue's acceptance criteria.
    • Issue Planning: Generates step-by-step Coding Plans from Jira issues for coding agents and IDE copilots.
    • Issue Creation: Allows creating new Jira issues directly from PR review comments.