diff --git a/README.md b/README.md index 8167aa97..a88a85a7 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,13 @@

+--- + +# CodeRabbit docs have moved over to Mintlify as a private repo. These docs are no longer maintained. + +--- + + # CodeRabbit Documentation Welcome to the official docs for [**CodeRabbit**](https://coderabbit.ai), the code review dev tool that helps you ship quality code faster. diff --git a/docs/context-enrichment/mcp-server-integrations.md b/docs/context-enrichment/mcp-server-integrations.md new file mode 100644 index 00000000..3d9334ad --- /dev/null +++ b/docs/context-enrichment/mcp-server-integrations.md @@ -0,0 +1,51 @@ +--- +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 diff --git a/docs/faq.md b/docs/faq.md index f248b517..ed5599a8 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -205,13 +205,13 @@ In-trial and open-source plans have lower rate limits than the paid plan. In all The following limits are enforced _per developer_: -| Feature | Free Plan | Trial Plan | OSS Plan | Pro/Lite Plan | -| -------------------------------- | ------------------------------------------ | --------------------------------- | ----------------------------- | ----------------------------- | -| Files per hour | 200/hour | 200/hour | 200/hour | 400/hour | -| Files per PR | 100 | 100 | 100 | 200 | -| Reviews per hour | 3 back-to-back, then 2/hour (Summary only) | 4 back-to-back, then 3/hour | 3 back-to-back, then 2/hour | 5 back-to-back, then 4/hour | -| Reviews per hour (IDE Extension) | 1/hour | 5/hour (Pro trial), 1/hour(Other) | 1/hour | 5/hour (Pro), 1/hour(Lite) | -| Chat | N/A | 25 back-to-back, then 50/hour | 10 back-to-back, then 25/hour | 25 back-to-back, then 50/hour | +| Feature | Free Plan | Trial Plan | OSS Plan | Pro/Lite Plan | +| -------------------------------- | ------------------------------------------ | ----------------------------- | ----------------------------- | ------------------------------------------------------------------------ | +| Files per hour | 200/hour | 200/hour | 200/hour | 400/hour | +| Files per PR | 100 | 100 | 100 | 200 | +| Reviews per hour (Git platforms) | 3 back-to-back, then 2/hour (Summary only) | 4 back-to-back, then 3/hour | 3 back-to-back, then 2/hour | 5 back-to-back, then 4/hour | +| Reviews per hour (IDE Extension) | 1 back-to-back, then 1/hour | 4 back-to-back, then 3/hour | 1 back-to-back, then 1/hour | Pro: 4 back-to-back, then 5/hour.
Lite: 1 back-to-back, then 1/hour. | +| Chat | N/A | 25 back-to-back, then 50/hour | 10 back-to-back, then 25/hour | 25 back-to-back, then 50/hour | ## Integration Guide {#integration-guide} diff --git a/docs/finishing-touches/_category_.yaml b/docs/finishing-touches/_category_.yaml index 81a96253..1bd50e46 100644 --- a/docs/finishing-touches/_category_.yaml +++ b/docs/finishing-touches/_category_.yaml @@ -2,3 +2,7 @@ label: Finishing Touches position: 8 collapsible: true collapsed: true +link: + type: generated-index + title: Finishing Touches + slug: /finishing-touches diff --git a/docs/finishing-touches/docstrings.md b/docs/finishing-touches/docstrings.md index c504fa8a..dd4f6467 100644 --- a/docs/finishing-touches/docstrings.md +++ b/docs/finishing-touches/docstrings.md @@ -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 diff --git a/docs/finishing-touches/index.md b/docs/finishing-touches/index.md new file mode 100644 index 00000000..824fc5e8 --- /dev/null +++ b/docs/finishing-touches/index.md @@ -0,0 +1,13 @@ +--- +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. diff --git a/docs/finishing-touches/unit-test-generation.md b/docs/finishing-touches/unit-test-generation.md index 71fe5431..d2e7ac11 100644 --- a/docs/finishing-touches/unit-test-generation.md +++ b/docs/finishing-touches/unit-test-generation.md @@ -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 diff --git a/docs/future-development.md b/docs/future-development.md deleted file mode 100644 index e3c7c4d6..00000000 --- a/docs/future-development.md +++ /dev/null @@ -1,58 +0,0 @@ ---- -title: CodeRabbit Features -sidebar_label: Future Development -description: Learn how CodeRabbit works in a pull request review. -sidebar_position: 12 ---- - -# Future Development - -We are actively iterating and refining CodeRabbit, and this is a sneak peek into the upcoming milestones and releases. We are focused on making the Applied AI review better than the median manual review. In addition to that, we are looking at a holistic user experience with various integrations and types of reviews. - -## Applied AI Improvements - -We are actively trying to make the application of Generative AI more useful, relevant, meaningful for the coder and reviewer journey. Our immediate focus is - -### Accuracy and Conciseness Enhancements - -- Refining knowledge base context understanding -- Implementing advanced summarization techniques -- Implementing a knowledge base feature library - -### Learning Refinements - -- We have made significant improvement of the learning Enhancing reinforcement learning based on the user feedback - -## New Feature Enhancements - -### Expanded Integrations - -We are integrating various tool chains to enable coders and reviewers to have a consistent experience irrespective of the tools. The immediate tools would be: - -- **Circle CI** -- **Jenkins** - -### Communication Tool Integrations - -Communication and the user experience of review via various communication tools will be key. We will start with integrations to Slack and Microsoft Teams and will be diving into the design engineering of these flows further: - -- **Slack**: Real-time notifications and interactive discussions -- **Microsoft Teams**: Code review conversations within the Microsoft ecosystem - -### Enhanced Review Capabilities - -These are additional capabilities that can also be reviewed in the same PR to accelerate the coder and reviewer journey. This includes pipeline failure analysis and resolution, as well as vulnerability assessment. - -#### Pipeline Failure Analysis - -- Automated analysis of CI/CD pipeline failures -- AI-driven suggestions for resolving issues -- Historical tracking of pipeline performance - -### Finishing Touches - -Finishing touches are about experience that often take developers time away from what they like doing best coding. But adding finishing touches is crucial and should follow the ontology and taxonomy. We will start by looking into specific areas such as documentation of code as an example. - -> Disclaimer: any product roadmap features mentioned below are only meant to outline -> our general product direction. This documentation is for informational purposes -> only and may not be incorporated into any contract. diff --git a/docs/guides/initial-configuration.md b/docs/guides/initial-configuration.md index 5cea2afd..26fc3a2b 100644 --- a/docs/guides/initial-configuration.md +++ b/docs/guides/initial-configuration.md @@ -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. diff --git a/docs/guides/issue-creation.md b/docs/guides/issue-creation.md index f6228b57..61928e7a 100644 --- a/docs/guides/issue-creation.md +++ b/docs/guides/issue-creation.md @@ -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 diff --git a/docs/platforms/bitbucket-cloud.md b/docs/platforms/bitbucket-cloud.md index 385d46ed..5813e5eb 100644 --- a/docs/platforms/bitbucket-cloud.md +++ b/docs/platforms/bitbucket-cloud.md @@ -1,17 +1,17 @@ --- title: "Bitbucket Cloud" description: "Learn how to integrate CodeRabbit with Bitbucket Cloud." -sidebar_label: "Bitbucket Cloud" +sidebar_label: "Bitbucket" sidebar_position: 6 --- -CodeRabbit integrates with Bitbucket Cloud to enhance code review and collaboration by: +CodeRabbit integrates with Bitbucket to enhance code review and collaboration by: - Automatically initiating code reviews for newly created merge requests. - 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. +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/docs/reference/configuration.md b/docs/reference/configuration.md index d95fbaa0..14b7e32e 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -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 diff --git a/docs/reference/yaml-template.md b/docs/reference/yaml-template.md index 9fac39e2..99fafa34 100644 --- a/docs/reference/yaml-template.md +++ b/docs/reference/yaml-template.md @@ -31,6 +31,7 @@ reviews: collapse_walkthrough: false changed_files_summary: true sequence_diagrams: true + estimate_code_review_effort: true assess_linked_issues: true related_issues: true related_prs: true diff --git a/sidebars.ts b/sidebars.ts index 487a363b..31081f0c 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -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", @@ -137,6 +137,12 @@ const sidebars: SidebarsConfig = { "guides/uninstall-vscode", ], }, + { + type: "category", + collapsed: true, + label: "Context enrichment", + items: ["context-enrichment/mcp-server-integrations"], + }, { type: "category", collapsed: true, @@ -226,7 +232,6 @@ const sidebars: SidebarsConfig = { "overview/why-coderabbit", "faq", "early-access", - "future-development", "changelog", ], }, diff --git a/static/schema/schema.v2.json b/static/schema/schema.v2.json index b31867ae..56e4b78d 100644 --- a/static/schema/schema.v2.json +++ b/static/schema/schema.v2.json @@ -1063,6 +1063,19 @@ "additionalProperties": false, "default": {}, "description": "checkmake is a linter for Makefiles." + }, + "osvScanner": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "default": true, + "description": "Enable OSV Scanner | OSV Scanner is a tool for vulnerability package scanning | v2.1.0" + } + }, + "additionalProperties": false, + "default": {}, + "description": "OSV Scanner is a tool for vulnerability package scanning." } }, "additionalProperties": false, @@ -1077,6 +1090,11 @@ "chat": { "type": "object", "properties": { + "art": { + "type": "boolean", + "default": true, + "description": "Generate art in response to chat messages. CodeRabbit expresses emotions as either ASCII or Emoji art." + }, "auto_reply": { "type": "boolean", "default": true, @@ -1240,6 +1258,27 @@ }, "additionalProperties": false, "default": {} + }, + "mcp": { + "type": "object", + "properties": { + "usage": { + "type": "string", + "enum": ["auto", "enabled", "disabled"], + "default": "auto", + "description": "MCP | Enable the MCP knowledge base integration. 'auto' disables the integration for public repositories." + }, + "disabled_servers": { + "type": "array", + "items": { + "type": "string" + }, + "default": [], + "description": "MCP Disabled Servers | Specify MCP server labels to disable (case-insensitive). These servers will be excluded from reviews and knowledge base queries." + } + }, + "additionalProperties": false, + "default": {} } }, "additionalProperties": false,