Skip to content

added a new page #491

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Aug 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions docs/context-enrichment/mcp-server-integrations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: MCP integrations
description: MCP integrations allow CodeRabbit to access your documentation, project management tools, knowledge bases, Figma designs, and more.

---
:::caution
Pro feature — Early Access only
:::

You can enable CodeRabbit to connect to external tools and data sources through the Model Context Protocol (MCP) integration. This allows CodeRabbit to serve as the client, and grants it with richer contextual understanding for:

- Code reviews
- The validation step for code suggestions
- Chat in the PR

Use the MCP integration as a way to access your documentation, project management tools, knowledge bases, Figma designs, and more.

## Considerations

A few things to keep in mind:

- CodeRabbit acts as the MCP client, not the server. It ingests data.
- The constraint is understanding what MCP data can be helpful for code reviews. See above for how CodeRabbit uses MCP data.
- This approach unlocks integrations in a way that wasn’t possible before. You don’t have to wait for CodeRabbit to have a formal integration, if it has an MCP server, we can connect to it.

## Setup

### Configuration steps

1. Navigate to Integrations Page within your CodeRabbit app settings and select the new MCP Server tab
2. To add a new MCP server, click "Add MCP Integration" and provide your server connection details along with the name
3. Complete the authentication process for your MCP server
4. Enable or disable individual MCP tools for each server

## How it works

### During code reviews

CodeRabbit automatically calls relevant MCP tools during analysis to:

* Gather additional review context.
* Validate and enhance suggested review comments.

Enhanced review comments will include enriched insights while maintaining your existing workflow. Tools used during analysis are listed under "Additional context used."

### In chat interactions

MCP integration enhances chat by:

* Retrieving contextual information based on discussion topics
* Accessing external documentation and knowledge bases

4 changes: 4 additions & 0 deletions docs/finishing-touches/_category_.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,7 @@ label: Finishing Touches
position: 8
collapsible: true
collapsed: true
link:
type: generated-index
title: Finishing Touches
slug: /finishing-touches
2 changes: 1 addition & 1 deletion docs/finishing-touches/docstrings.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';

# Docstrings

Docstrings generation is part of the [finishing touches](/future-development#finishing-touches).
Docstrings generation is part of the [Finishing Touches](/finishing-touches).

## Usage

Expand Down
15 changes: 15 additions & 0 deletions docs/finishing-touches/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
id: finishing-touches
title: Finishing Touches
description: Enhance your pull requests with automated docstrings and unit test generation.
slug: /finishing-touches
---

Finishing Touches features help you polish pull requests after review:

- [Docstrings](/finishing-touches/docstrings)
- [Unit Test Generation](/finishing-touches/unit-test-generation)

Use these tools to improve documentation and test coverage before merging.


2 changes: 1 addition & 1 deletion docs/finishing-touches/unit-test-generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This feature is in beta.

# Unit Test Generation

Unit Test Generation is part of the [finishing touches](/future-development#finishing-touches).
Unit Test Generation is part of the [Finishing Touches](/finishing-touches).

## Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/guides/initial-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ By default, CodeRabbit writes thorough code reviews with several sub-sections. I
- [Sequence diagrams](/reference/configuration#sequence-diagrams): includes a visual diagram of object interactions.
- [Assess linked issues](/reference/configuration#assess-linked-issues): assesses how well the pull request addresses any linked issues.
- [Related issues](/reference/configuration#related-issues): lists issues found in your issue tracker that might be related to this pull request.
- [Related pull requests](/reference/configuration#realted-prs): lists pull requests that might be related to this pull request.
- [Related pull requests](/reference/configuration#related-prs): lists pull requests that might be related to this pull request.
- [Suggested labels](/reference/configuration#suggested-labels): Suggests labels for this pull request.
- [Suggested reviewers](/reference/configuration#suggested-reviewers): automatically suggest reviewers for PR
- [Poem](/reference/configuration#poem): generates a short poem about this pull request.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/issue-creation.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ To create Jira issues, ensure you have [configured the Jira integration](../inte

### Linear

Make sure you have [set up the Linear integration](../integrations/issue-integrations.md#linear) to create Linear issues.
Make sure you have [set up the Linear integration](../integrations/issue-integrations.md#Linear) to create Linear issues.

## Tips for Issue Creation

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -1980,7 +1980,7 @@ Specify the scope of learnings to use for the knowledge base. 'local' uses the r

You can define a list of paths that guide CodeRabbit to your organization's code guidelines.
If you do, then CodeRabbit applies these guidelines to its code reviews. For more
information, see [Code Guidelines](/integrations/knowledge-base#code_guidelines).
information, see [Code Guidelines](/integrations/knowledge-base#code-guidelines).

#### Enable code guidelines

Expand Down
11 changes: 9 additions & 2 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ const sidebars: SidebarsConfig = {
{
type: "category",
collapsed: true,
label: "Review local changes",
label: "IDE extensions",
items: [
"guides/about-vscode",
"guides/install-vscode",
Expand All @@ -137,6 +137,14 @@ const sidebars: SidebarsConfig = {
"guides/uninstall-vscode",
],
},
{
type: "category",
collapsed: true,
label: "Context enrichment",
items: [
"context-enrichment/mcp-server-integrations",
],
},
{
type: "category",
collapsed: true,
Expand Down Expand Up @@ -226,7 +234,6 @@ const sidebars: SidebarsConfig = {
"overview/why-coderabbit",
"faq",
"early-access",
"future-development",
"changelog",
],
},
Expand Down
Loading