diff --git a/docs/context-enrichment/mcp-server-integrations.md b/docs/context-enrichment/mcp-server-integrations.md index 04818323..3d9334ad 100644 --- a/docs/context-enrichment/mcp-server-integrations.md +++ b/docs/context-enrichment/mcp-server-integrations.md @@ -1,35 +1,35 @@ --- 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 +- 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. +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. +- 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 +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 @@ -38,8 +38,8 @@ A few things to keep in mind: CodeRabbit automatically calls relevant MCP tools during analysis to: -* Gather additional review context. -* Validate and enhance suggested review comments. +- 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." @@ -47,6 +47,5 @@ Enhanced review comments will include enriched insights while maintaining your e MCP integration enhances chat by: -* Retrieving contextual information based on discussion topics -* Accessing external documentation and knowledge bases - +- Retrieving contextual information based on discussion topics +- Accessing external documentation and knowledge bases diff --git a/docs/finishing-touches/index.md b/docs/finishing-touches/index.md index 0dda55c8..824fc5e8 100644 --- a/docs/finishing-touches/index.md +++ b/docs/finishing-touches/index.md @@ -11,5 +11,3 @@ Finishing Touches features help you polish pull requests after review: - [Unit Test Generation](/finishing-touches/unit-test-generation) Use these tools to improve documentation and test coverage before merging. - - diff --git a/docs/platforms/bitbucket-cloud.md b/docs/platforms/bitbucket-cloud.md index a708441b..5813e5eb 100644 --- a/docs/platforms/bitbucket-cloud.md +++ b/docs/platforms/bitbucket-cloud.md @@ -11,7 +11,7 @@ CodeRabbit integrates with Bitbucket to enhance code review and collaboration by - Displaying review comments and suggestions directly on merge requests. - Enabling seamless interaction with the CodeRabbit bot for real-time feedback and assistance. -This guide will assist you in effectively integrating CodeRabbit with Bitbucket Cloud. [Click here](https://docs.coderabbit.ai/self-hosted/bitbucket) for instructions integrating Bitbucket Data Center with CodeRabit self-hosted edition. +This guide will assist you in effectively integrating CodeRabbit with Bitbucket Cloud. [Click here](https://docs.coderabbit.ai/self-hosted/bitbucket) for instructions integrating Bitbucket Data Center with CodeRabit self-hosted edition. ## Configure API Token diff --git a/sidebars.ts b/sidebars.ts index b8459b09..31081f0c 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -141,9 +141,7 @@ const sidebars: SidebarsConfig = { type: "category", collapsed: true, label: "Context enrichment", - items: [ - "context-enrichment/mcp-server-integrations", - ], + items: ["context-enrichment/mcp-server-integrations"], }, { type: "category",