Skip to content

Commit f487e59

Browse files
edgarcerecerezedgarcerecerez
authored
added a new page (#491)
* Updating bitbucket integration docs to account for on-prem Removed references to Bitbucket Cloud and left the more ambiguous Bitbucket to account for both on prem and cloud. * Update bitbucket-cloud.md * Delete future-development.md * added mcp doc * bug fixes
1 parent e34339b commit f487e59

File tree

9 files changed

+85
-7
lines changed

9 files changed

+85
-7
lines changed

‎docs/context-enrichment/mcp-server-integrations.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: MCP integrations
3+
description: MCP integrations allow CodeRabbit to access your documentation, project management tools, knowledge bases, Figma designs, and more.
4+
5+
---
6+
:::caution
7+
Pro feature — Early Access only
8+
:::
9+
10+
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:
11+
12+
- Code reviews
13+
- The validation step for code suggestions
14+
- Chat in the PR
15+
16+
Use the MCP integration as a way to access your documentation, project management tools, knowledge bases, Figma designs, and more.
17+
18+
## Considerations
19+
20+
A few things to keep in mind:
21+
22+
- CodeRabbit acts as the MCP client, not the server. It ingests data.
23+
- The constraint is understanding what MCP data can be helpful for code reviews. See above for how CodeRabbit uses MCP data.
24+
- 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.
25+
26+
## Setup
27+
28+
### Configuration steps
29+
30+
1. Navigate to Integrations Page within your CodeRabbit app settings and select the new MCP Server tab
31+
2. To add a new MCP server, click "Add MCP Integration" and provide your server connection details along with the name
32+
3. Complete the authentication process for your MCP server
33+
4. Enable or disable individual MCP tools for each server
34+
35+
## How it works
36+
37+
### During code reviews
38+
39+
CodeRabbit automatically calls relevant MCP tools during analysis to:
40+
41+
* Gather additional review context.
42+
* Validate and enhance suggested review comments.
43+
44+
Enhanced review comments will include enriched insights while maintaining your existing workflow. Tools used during analysis are listed under "Additional context used."
45+
46+
### In chat interactions
47+
48+
MCP integration enhances chat by:
49+
50+
* Retrieving contextual information based on discussion topics
51+
* Accessing external documentation and knowledge bases
52+

‎docs/finishing-touches/_category_.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,7 @@ label: Finishing Touches
22
position: 8
33
collapsible: true
44
collapsed: true
5+
link:
6+
type: generated-index
7+
title: Finishing Touches
8+
slug: /finishing-touches

‎docs/finishing-touches/docstrings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import ProPlanNotice from '@site/src/components/ProPlanNotice.mdx';
1111

1212
# Docstrings
1313

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

1616
## Usage
1717

‎docs/finishing-touches/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
id: finishing-touches
3+
title: Finishing Touches
4+
description: Enhance your pull requests with automated docstrings and unit test generation.
5+
slug: /finishing-touches
6+
---
7+
8+
Finishing Touches features help you polish pull requests after review:
9+
10+
- [Docstrings](/finishing-touches/docstrings)
11+
- [Unit Test Generation](/finishing-touches/unit-test-generation)
12+
13+
Use these tools to improve documentation and test coverage before merging.
14+
15+

‎docs/finishing-touches/unit-test-generation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This feature is in beta.
1515

1616
# Unit Test Generation
1717

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

2020
## Usage
2121

‎docs/guides/initial-configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ By default, CodeRabbit writes thorough code reviews with several sub-sections. I
7070
- [Sequence diagrams](/reference/configuration#sequence-diagrams): includes a visual diagram of object interactions.
7171
- [Assess linked issues](/reference/configuration#assess-linked-issues): assesses how well the pull request addresses any linked issues.
7272
- [Related issues](/reference/configuration#related-issues): lists issues found in your issue tracker that might be related to this pull request.
73-
- [Related pull requests](/reference/configuration#realted-prs): lists pull requests that might be related to this pull request.
73+
- [Related pull requests](/reference/configuration#related-prs): lists pull requests that might be related to this pull request.
7474
- [Suggested labels](/reference/configuration#suggested-labels): Suggests labels for this pull request.
7575
- [Suggested reviewers](/reference/configuration#suggested-reviewers): automatically suggest reviewers for PR
7676
- [Poem](/reference/configuration#poem): generates a short poem about this pull request.

‎docs/guides/issue-creation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ To create Jira issues, ensure you have [configured the Jira integration](../inte
3737

3838
### Linear
3939

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

4242
## Tips for Issue Creation
4343

‎docs/reference/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1980,7 +1980,7 @@ Specify the scope of learnings to use for the knowledge base. 'local' uses the r
19801980

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

19851985
#### Enable code guidelines
19861986

‎sidebars.ts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ const sidebars: SidebarsConfig = {
127127
{
128128
type: "category",
129129
collapsed: true,
130-
label: "Review local changes",
130+
label: "IDE extensions",
131131
items: [
132132
"guides/about-vscode",
133133
"guides/install-vscode",
@@ -137,6 +137,14 @@ const sidebars: SidebarsConfig = {
137137
"guides/uninstall-vscode",
138138
],
139139
},
140+
{
141+
type: "category",
142+
collapsed: true,
143+
label: "Context enrichment",
144+
items: [
145+
"context-enrichment/mcp-server-integrations",
146+
],
147+
},
140148
{
141149
type: "category",
142150
collapsed: true,
@@ -226,7 +234,6 @@ const sidebars: SidebarsConfig = {
226234
"overview/why-coderabbit",
227235
"faq",
228236
"early-access",
229-
"future-development",
230237
"changelog",
231238
],
232239
},

0 commit comments

Comments
 (0)