> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CodeRabbit MCP tools

> Every tool the CodeRabbit MCP server offers, the scopes each group of tools needs, and the API operation behind each tool.

The [CodeRabbit MCP server](https://docs.coderabbit.ai/api/mcp.md) builds most of its tools from the CodeRabbit API. A tool has the same name as its API operation's `operationId`, and the operation's summary and description as its title and description: `create_code_task` is the tool for [Create a coding task](https://docs.coderabbit.ai/api/reference/create-code-task.md). It takes the operation's path, query, and body fields as one set of arguments, returns the same response, and runs the same permission and plan checks. Leave out `org_id`: the connection already selects the organization.

The **Access** column shows the hint each tool gives your client. **Read** marks tools that only read data, which your client sees as read-only. **Write** marks every other tool, including previews that change nothing, such as `preview_triage_rule` and `preview_repository_configuration`. Your client can use the hint to ask you before the agent runs a **Write** tool.

## Scopes by area

A tool needs the read scope of its group to read data and the write scope to change it. Every tool except `connection_status`, `list_pull_requests`, `get_pull_request`, `start_code_review`, and `get_code_review` also needs `account:read`, so include it in every scope list. If your connection lacks a scope, the call fails with `insufficient_scope` and names the missing scope; add it in your client and sign in again, as [Choose scopes](https://docs.coderabbit.ai/api/mcp.md#choose-scopes) describes.

| Group | Read scope | Write scope |
| - | - | - |
| Organizations and repositories | `repositories:read` for repositories, `configuration:read` for organizations and linked repositories. `get_me` needs only `account:read`, and `connection_status` only `connection`. | |
| Pull requests and reviews | `pull_requests:read`. `get_code_review` needs `review`. | `reviews:write` for `request_pull_request_review`. `start_code_review` needs `review`. |
| Coding Agent | `code:read` | `code:write` |
| Coding environments | `code:read` | `code:write` |
| Verify | `verify:read` | `verify:write` |
| Triage | `triage:read`, which is also enough for `preview_triage_rule` | `triage:write` together with `triage:read` |
| Security | `security:read` | `security:write` |
| Knowledge Base | `knowledge:read` | `knowledge:write` |
| Automations | `automations:read` | `automations:write` |
| Reports | `reports:read` | `reports:write` |
| Configuration | `configuration:read` | `configuration:write` |
| Connections | `connections:read` | `connections:write` |
| Users and roles | `configuration:read` | `configuration:write` |
| Usage and metrics | `usage:read` | |

## Differences from the API

Tools marked **MCP only** have no API operation with the same name:

* `connection_status` checks the connected account, organization, and region.
* `list_pull_requests` and `get_pull_request` find and read pull requests by repository, branch, or pull request URL. They take the place of the [List pull requests](https://docs.coderabbit.ai/api/reference/list-repository-pull-requests.md) and [Get a pull request](https://docs.coderabbit.ai/api/reference/get-repository-pull-request.md) operations, which aren't tools.
* `start_code_review` and `get_code_review` run a CodeRabbit review of local code, which the CodeRabbit CLI uploads from your machine.
* `list_organizations`, `list_organization_repositories`, `list_linked_repositories`, `list_users`, `manage_seats`, and `list_audit_logs` do the jobs of export and user-management operations such as [List users](https://docs.coderabbit.ai/api/reference/list-users.md) and [List audit log entries](https://docs.coderabbit.ai/api/reference/audit-logs-list.md), in the connected organization only. `manage_seats` takes user IDs and doesn't work in an Enterprise SSO workspace; there, [manage seats with a workspace API token](https://docs.coderabbit.ai/api/workspace-api-tokens.md).

These API operations have no tool, so call them through the [API](https://docs.coderabbit.ai/api.md) or the [CLI](https://docs.coderabbit.ai/api/cli.md):

* The metrics exports, such as [review metrics](https://docs.coderabbit.ai/api/reference/review-metrics.md).
* The organization Learnings operations on `/v1/learnings`. The Knowledge Base tools, such as `list_learnings`, work with Learnings too; see [Learnings](https://docs.coderabbit.ai/api/guides/learnings.md).
* The Deep Scan and Bug Scan findings exports.
* Adding users to a self-hosted organization, changing roles, and changing the seat assignment mode.
* `download_verify_evidence`, which returns a file. The `get_verify_evidence` tool returns the evidence details.

## Tools

### Organizations and repositories

| Tool | What it does | Access | REST operation |
| - | - | - | - |
| `get_me` | Get the authenticated principal and selected organization | Read | [`GET /v1/me`](https://docs.coderabbit.ai/api/reference/get-me) |
| `list_repositories` | List accessible installed repositories | Read | [`GET /v1/repositories`](https://docs.coderabbit.ai/api/reference/list-repositories) |
| `get_repository` | Get an accessible installed repository | Read | [`GET /v1/repositories/{repository_id}`](https://docs.coderabbit.ai/api/reference/get-repository) |
| `connection_status` | Check the connected account and organization. | Read | MCP only |
| `list_organizations` | Read the selected organization inventory | Read | MCP only |
| `list_organization_repositories` | List onboarded organization repositories | Read | MCP only |
| `list_linked_repositories` | List saved linked repository associations | Read | MCP only |

### Pull requests and reviews

| Tool | What it does | Access | REST operation |
| - | - | - | - |
| `get_pull_request_change_stack` | Read a saved Change Stack overview and layers | Read | [`GET /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/change-stack`](https://docs.coderabbit.ai/api/reference/get-pull-request-change-stack) |
| `get_pull_request_change_stack_layer_diff` | Read one saved Change Stack layer's diff | Read | [`GET /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/change-stack/groups/{group_id}/layers/{layer_id}/diff`](https://docs.coderabbit.ai/api/reference/get-pull-request-change-stack-layer-diff) |
| `get_pull_request_review` | Read the existing CodeRabbit review status for a pull request | Read | [`GET /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review`](https://docs.coderabbit.ai/api/reference/get-pull-request-review) |
| `request_pull_request_review` | Request a review of the current pull-request head | Write | [`POST /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review`](https://docs.coderabbit.ai/api/reference/request-pull-request-review) |
| `get_pull_request_review_summary` | Read the full published CodeRabbit summary | Read | [`GET /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review/summary`](https://docs.coderabbit.ai/api/reference/get-pull-request-review-summary) |
| `list_pull_request_review_thread_comments` | List all comments in a pull-request review thread | Read | [`GET /v1/repositories/{repository_id}/pull-requests/{pull_request_number}/review-threads/{thread_id}/comments`](https://docs.coderabbit.ai/api/reference/list-pull-request-review-thread-comments) |
| `list_pull_requests` | Find accessible GitHub Cloud pull requests in the connected organization. | Read | MCP only |
| `get_pull_request` | Get a GitHub Cloud PR's metadata, review state and known merge blockers using a linked GitHub account. | Read | MCP only |
| `start_code_review` | Authorize one local code review in the connected organization. | Write | MCP only |
| `get_code_review` | Read the saved result of an existing local review. | Read | MCP only |

### Coding Agent

| Tool | What it does | Access | REST operation |
| - | - | - | - |
| `get_code_autofix` | Read existing autofix status for a task or pull request | Read | [`GET /v1/code/autofix`](https://docs.coderabbit.ai/api/reference/get-code-autofix) |
| `set_code_autofix` | Enable, disable, resume or recover existing autofix | Write | [`POST /v1/code/autofix/commands`](https://docs.coderabbit.ai/api/reference/set-code-autofix) |
| `list_code_tasks` | List accessible coding tasks | Read | [`GET /v1/code/tasks`](https://docs.coderabbit.ai/api/reference/list-code-tasks) |
| `create_code_task` | Create a coding task | Write | [`POST /v1/code/tasks`](https://docs.coderabbit.ai/api/reference/create-code-task) |
| `get_code_task` | Read an accessible coding task | Read | [`GET /v1/code/tasks/{task_id}`](https://docs.coderabbit.ai/api/reference/get-code-task) |
| `cancel_code_task_turn` | Request the existing human Stop action for a coding task | Write | [`POST /v1/code/tasks/{task_id}/cancel`](https://docs.coderabbit.ai/api/reference/cancel-code-task-turn) |
| `deliver_code_task` | Deliver a task patch using the caller's existing repository write authorization | Write | [`POST /v1/code/tasks/{task_id}/delivery`](https://docs.coderabbit.ai/api/reference/deliver-code-task) |
| `get_code_task_patch` | Read a coding task's stored patch | Read | [`GET /v1/code/tasks/{task_id}/patch`](https://docs.coderabbit.ai/api/reference/get-code-task-patch) |
| `get_code_task_plan` | Read a stored coding plan version | Read | [`GET /v1/code/tasks/{task_id}/plan`](https://docs.coderabbit.ai/api/reference/get-code-task-plan) |
| `set_code_task_plan_approval` | Approve or withdraw approval of a coding plan | Write | [`PUT /v1/code/tasks/{task_id}/plan/approval`](https://docs.coderabbit.ai/api/reference/set-code-task-plan-approval) |
| `list_code_task_plan_comments` | Read feedback on a specific stored plan version | Read | [`GET /v1/code/tasks/{task_id}/plan/comments`](https://docs.coderabbit.ai/api/reference/list-code-task-plan-comments) |
| `replace_code_task_plan_comment` | Replace your Plan comment text | Write | [`PUT /v1/code/tasks/{task_id}/plan/comments/{comment_id}`](https://docs.coderabbit.ai/api/reference/replace-code-task-plan-comment) |
| `delete_code_task_plan_comment` | Delete your Plan comment | Write | [`DELETE /v1/code/tasks/{task_id}/plan/comments/{comment_id}`](https://docs.coderabbit.ai/api/reference/delete-code-task-plan-comment) |
| `reopen_code_task_plan_comment_thread` | Reopen a Plan feedback thread | Write | [`POST /v1/code/tasks/{task_id}/plan/comments/threads/{thread_id}/reopen`](https://docs.coderabbit.ai/api/reference/reopen-code-task-plan-comment-thread) |
| `reply_code_task_plan_comment_thread` | Reply to an existing Plan feedback thread | Write | [`POST /v1/code/tasks/{task_id}/plan/comments/threads/{thread_id}/replies`](https://docs.coderabbit.ai/api/reference/reply-code-task-plan-comment-thread) |
| `resolve_code_task_plan_comment_thread` | Resolve a Plan feedback thread | Write | [`POST /v1/code/tasks/{task_id}/plan/comments/threads/{thread_id}/resolve`](https://docs.coderabbit.ai/api/reference/resolve-code-task-plan-comment-thread) |
| `implement_code_task_plan` | Implement a stored plan after its existing readiness checks | Write | [`POST /v1/code/tasks/{task_id}/plan/implementation`](https://docs.coderabbit.ai/api/reference/implement-code-task-plan) |
| `revise_code_task_plan` | Queue a plan revision using the existing replan operation | Write | [`POST /v1/code/tasks/{task_id}/plan/revisions`](https://docs.coderabbit.ai/api/reference/revise-code-task-plan) |
| `list_code_task_questions` | Read questions recorded in a task's recent execution history | Read | [`GET /v1/code/tasks/{task_id}/questions`](https://docs.coderabbit.ai/api/reference/list-code-task-questions) |
| `answer_code_task_question` | Answer an existing coding task interaction | Write | [`POST /v1/code/tasks/{task_id}/questions/{interaction_id}/answers`](https://docs.coderabbit.ai/api/reference/answer-code-task-question) |
| `get_code_task_queue` | Read queued coding task messages | Read | [`GET /v1/code/tasks/{task_id}/queue`](https://docs.coderabbit.ai/api/reference/get-code-task-queue) |
| `list_code_task_turns` | List retained coding execution turns | Read | [`GET /v1/code/tasks/{task_id}/turns`](https://docs.coderabbit.ai/api/reference/list-code-task-turns) |
| `create_code_task_turn` | Queue a follow-up coding message | Write | [`POST /v1/code/tasks/{task_id}/turns`](https://docs.coderabbit.ai/api/reference/create-code-task-turn) |
| `get_code_task_turn` | Read a retained coding execution turn by its native start sequence | Read | [`GET /v1/code/tasks/{task_id}/turns/{turn_start_seq}`](https://docs.coderabbit.ai/api/reference/get-code-task-turn) |

### Coding environments

| Tool | What it does | Access | REST operation |
| - | - | - | - |
| `list_code_environment_assignments` | List existing repository environment assignments | Read | [`GET /v1/code/environment-assignments`](https://docs.coderabbit.ai/api/reference/list-code-environment-assignments) |
| `list_code_environments` | List coding environments | Read | [`GET /v1/code/environments`](https://docs.coderabbit.ai/api/reference/list-code-environments) |
| `create_code_environment` | Create a coding environment with existing preparation behavior | Write | [`POST /v1/code/environments`](https://docs.coderabbit.ai/api/reference/create-code-environment) |
| `get_code_environment` | Read environment configuration without secret values | Read | [`GET /v1/code/environments/{environmentId}`](https://docs.coderabbit.ai/api/reference/get-code-environment) |
| `update_code_environment` | Update environment configuration with native revision checks | Write | [`PUT /v1/code/environments/{environmentId}`](https://docs.coderabbit.ai/api/reference/update-code-environment) |
| `archive_code_environment` | Archive a coding environment | Write | [`DELETE /v1/code/environments/{environmentId}`](https://docs.coderabbit.ai/api/reference/archive-code-environment) |
| `add_code_environment_repository` | Assign a repository to a coding environment | Write | [`POST /v1/code/environments/{environmentId}/repositories`](https://docs.coderabbit.ai/api/reference/add-code-environment-repository) |
| `update_code_environment_repository` | Update repository setup using its native revision check | Write | [`PUT /v1/code/environments/{environmentId}/repositories/{repositoryAssignmentId}`](https://docs.coderabbit.ai/api/reference/update-code-environment-repository) |
| `remove_code_environment_repository` | Remove a repository environment assignment | Write | [`DELETE /v1/code/environments/{environmentId}/repositories/{repositoryAssignmentId}`](https://docs.coderabbit.ai/api/reference/remove-code-environment-repository) |
| `set_code_environment_variable` | Set an environment variable using existing encrypted storage | Write | [`PUT /v1/code/environments/{environmentId}/variables`](https://docs.coderabbit.ai/api/reference/set-code-environment-variable) |
| `delete_code_environment_variable` | Delete an environment variable | Write | [`DELETE /v1/code/environments/{environmentId}/variables/{variableId}`](https://docs.coderabbit.ai/api/reference/delete-code-environment-variable) |

### Verify

| Tool | What it does | Access | REST operation |
| - | - | - | - |
| `list_verify_repositories` | List registered Verify repositories | Read | [`GET /v1/verify/repositories`](https://docs.coderabbit.ai/api/reference/list-verify-repositories) |
| `register_verify_repository` | Register an accessible repository with an existing execution environment | Write | [`POST /v1/verify/repositories`](https://docs.coderabbit.ai/api/reference/register-verify-repository) |
| `get_verify_repository` | Read a Verify repository and its recent jobs | Read | [`GET /v1/verify/repositories/{repository_id}`](https://docs.coderabbit.ai/api/reference/get-verify-repository) |
| `configure_verify_repository` | Configure an existing Verify repository | Write | [`PUT /v1/verify/repositories/{repository_id}`](https://docs.coderabbit.ai/api/reference/configure-verify-repository) |
| `get_verify_bug_history` | Read a Verify bug's observed history | Read | [`GET /v1/verify/repositories/{repository_id}/bugs/{bug_id}/history`](https://docs.coderabbit.ai/api/reference/get-verify-bug-history) |
| `get_verify_execution` | Read a Verify execution result | Read | [`GET /v1/verify/repositories/{repository_id}/executions/{execution_id}`](https://docs.coderabbit.ai/api/reference/get-verify-execution) |
| `get_verify_evidence` | Read published Verify evidence metadata | Read | [`GET /v1/verify/repositories/{repository_id}/executions/{execution_id}/evidence/{artifact_id}`](https://docs.coderabbit.ai/api/reference/get-verify-evidence) |
| `list_verify_findings` | List current Verify findings | Read | [`GET /v1/verify/repositories/{repository_id}/findings`](https://docs.coderabbit.ai/api/reference/list-verify-findings) |
| `list_verify_jobs` | List Verify jobs | Read | [`GET /v1/verify/repositories/{repository_id}/jobs`](https://docs.coderabbit.ai/api/reference/list-verify-jobs) |
| `start_verify_job` | Start an existing Verify authoring, testability or execution operation | Write | [`POST /v1/verify/repositories/{repository_id}/jobs`](https://docs.coderabbit.ai/api/reference/start-verify-job) |
| `get_verify_job` | Read a Verify job and execution statuses | Read | [`GET /v1/verify/repositories/{repository_id}/jobs/{job_id}`](https://docs.coderabbit.ai/api/reference/get-verify-job) |
| `get_verify_job_bugs` | Read observed bugs from a Verify job | Read | [`GET /v1/verify/repositories/{repository_id}/jobs/{job_id}/bugs`](https://docs.coderabbit.ai/api/reference/get-verify-job-bugs) |
| `list_verify_journeys` | List registered user journeys | Read | [`GET /v1/verify/repositories/{repository_id}/journeys`](https://docs.coderabbit.ai/api/reference/list-verify-journeys) |
| `create_verify_journey` | Create a user journey | Write | [`POST /v1/verify/repositories/{repository_id}/journeys`](https://docs.coderabbit.ai/api/reference/create-verify-journey) |
| `update_verify_journey` | Update or archive a user journey with native revision checks | Write | [`PUT /v1/verify/repositories/{repository_id}/journeys/{cuj_id}`](https://docs.coderabbit.ai/api/reference/update-verify-journey) |
| `list_verify_schedules` | List Verify schedules | Read | [`GET /v1/verify/repositories/{repository_id}/schedules`](https://docs.coderabbit.ai/api/reference/list-verify-schedules) |
| `get_verify_schedule_history` | Read Verify schedule occurrences | Read | [`GET /v1/verify/repositories/{repository_id}/schedules/{schedule_id}/history`](https://docs.coderabbit.ai/api/reference/get-verify-schedule-history) |
| `change_verify_schedule` | Create, update or delete a Verify schedule with native revision checks | Write | [`POST /v1/verify/repositories/{repository_id}/schedules/changes`](https://docs.coderabbit.ai/api/reference/change-verify-schedule) |

### Triage

| Tool | What it does | Access | REST operation |
| - | - | - | - |
| `list_triage_changes` | List the caller's accessible Triage changes | Read | [`GET /v1/triage/changes`](https://docs.coderabbit.ai/api/reference/list-triage-changes) |
| `get_triage_change` | Read an accessible Triage change | Read | [`GET /v1/triage/changes/{id}`](https://docs.coderabbit.ai/api/reference/get-triage-change) |
| `list_triage_change_history` | Read the recorded priority and close-candidacy history | Read | [`GET /v1/triage/changes/{id}/history`](https://docs.coderabbit.ai/api/reference/list-triage-change-history) |
| `set_triage_change_priority` | Set a change's manual priority | Write | [`PUT /v1/triage/changes/{id}/priority`](https://docs.coderabbit.ai/api/reference/set-triage-change-priority) |
| `list_triage_rules` | List Triage rules | Read | [`GET /v1/triage/rules`](https://docs.coderabbit.ai/api/reference/list-triage-rules) |
| `create_triage_rule` | Create a Triage rule | Write | [`POST /v1/triage/rules`](https://docs.coderabbit.ai/api/reference/create-triage-rule) |
| `get_triage_rule` | Read a Triage rule and its definition | Read | [`GET /v1/triage/rules/{ruleId}`](https://docs.coderabbit.ai/api/reference/get-triage-rule) |
| `update_triage_rule` | Replace a Triage rule definition | Write | [`PUT /v1/triage/rules/{ruleId}`](https://docs.coderabbit.ai/api/reference/update-triage-rule) |
| `delete_triage_rule` | Delete a Triage rule | Write | [`DELETE /v1/triage/rules/{ruleId}`](https://docs.coderabbit.ai/api/reference/delete-triage-rule) |
| `list_triage_rule_executions` | Read executions for a rule revision | Read | [`GET /v1/triage/rules/{ruleId}/executions`](https://docs.coderabbit.ai/api/reference/list-triage-rule-executions) |
| `transition_triage_rule` | Activate, pause, or resume a Triage rule | Write | [`POST /v1/triage/rules/{ruleId}/transition`](https://docs.coderabbit.ai/api/reference/transition-triage-rule) |
| `preview_triage_rule` | Preview existing changes matching a rule definition | Write | [`POST /v1/triage/rules/preview`](https://docs.coderabbit.ai/api/reference/preview-triage-rule) |
| `list_triage_teams` | List accessible Triage teams | Read | [`GET /v1/triage/teams`](https://docs.coderabbit.ai/api/reference/list-triage-teams) |

### Security

| Tool | What it does | Access | REST operation |
| - | - | - | - |
| `list_security_dependencies` | List vulnerable dependencies | Read | [`GET /v1/security/dependencies`](https://docs.coderabbit.ai/api/reference/list-security-dependencies) |
| `list_security_findings` | List code and secret findings | Read | [`GET /v1/security/findings`](https://docs.coderabbit.ai/api/reference/list-security-findings) |
| `get_security_dependency` | Read a dependency and its advisories | Read | [`GET /v1/security/repositories/{repository_id}/dependencies/{dependency_id}`](https://docs.coderabbit.ai/api/reference/get-security-dependency) |
| `get_security_finding` | Read a code security finding | Read | [`GET /v1/security/repositories/{repository_id}/findings/{finding_id}`](https://docs.coderabbit.ai/api/reference/get-security-finding) |
| `dismiss_security_finding` | Dismiss a security finding | Write | [`POST /v1/security/repositories/{repository_id}/findings/{finding_id}/dismiss`](https://docs.coderabbit.ai/api/reference/dismiss-security-finding) |
| `fix_security_finding` | Request an AI fix for a security finding | Write | [`POST /v1/security/repositories/{repository_id}/findings/{finding_id}/fix`](https://docs.coderabbit.ai/api/reference/fix-security-finding) |
| `reopen_security_finding` | Reopen a code security finding | Write | [`POST /v1/security/repositories/{repository_id}/findings/{finding_id}/reopen`](https://docs.coderabbit.ai/api/reference/reopen-security-finding) |
| `get_security_runtime_validation_capability` | Read runtime validation availability for a finding | Read | [`GET /v1/security/repositories/{repository_id}/findings/{finding_id}/validation-capability`](https://docs.coderabbit.ai/api/reference/get-security-runtime-validation-capability) |
| `get_security_scan` | Read an existing security scan | Read | [`GET /v1/security/repositories/{repository_id}/scans/{scan_id}`](https://docs.coderabbit.ai/api/reference/get-security-scan) |
| `get_security_scan_quote` | Estimate an AI Deep Scan | Read | [`GET /v1/security/repositories/{repository_id}/scans/quote`](https://docs.coderabbit.ai/api/reference/get-security-scan-quote) |
| `get_security_secret_finding` | Read a secret finding | Read | [`GET /v1/security/repositories/{repository_id}/secrets/{finding_id}`](https://docs.coderabbit.ai/api/reference/get-security-secret-finding) |
| `list_security_runtime_validations` | List runtime validation attempts for a finding | Read | [`GET /v1/security/repositories/{repository_id}/validations`](https://docs.coderabbit.ai/api/reference/list-security-runtime-validations) |
| `get_security_runtime_validation` | Read a runtime validation result | Read | [`GET /v1/security/repositories/{repository_id}/validations/{validation_id}`](https://docs.coderabbit.ai/api/reference/get-security-runtime-validation) |
| `list_security_sbom` | List software bill of materials components | Read | [`GET /v1/security/sbom`](https://docs.coderabbit.ai/api/reference/list-security-sbom) |
| `export_security_sbom` | Export a software bill of materials | Read | [`GET /v1/security/sbom/export`](https://docs.coderabbit.ai/api/reference/export-security-sbom) |
| `list_security_scans` | List security scan activity | Read | [`GET /v1/security/scans`](https://docs.coderabbit.ai/api/reference/list-security-scans) |
| `start_security_scans` | Request security scans for installed repositories | Write | [`POST /v1/security/scans`](https://docs.coderabbit.ai/api/reference/start-security-scans) |
| `list_security_secret_findings` | List secret scanner findings | Read | [`GET /v1/security/secrets`](https://docs.coderabbit.ai/api/reference/list-security-secret-findings) |

### Knowledge Base

| Tool | What it does | Access | REST operation |
| - | - | - | - |
| `get_architecture_capabilities` | Read available architecture knowledge scopes | Read | [`GET /v1/knowledge/architecture/capabilities`](https://docs.coderabbit.ai/api/reference/get-architecture-capabilities) |
| `get_architecture_document` | Read an architecture knowledge document at an observed revision | Read | [`GET /v1/knowledge/architecture/document`](https://docs.coderabbit.ai/api/reference/get-architecture-document) |
| `list_architecture_repositories` | List repositories with architecture knowledge | Read | [`GET /v1/knowledge/architecture/repositories`](https://docs.coderabbit.ai/api/reference/list-architecture-repositories) |
| `get_architecture_tree` | List the current architecture knowledge document tree | Read | [`GET /v1/knowledge/architecture/tree`](https://docs.coderabbit.ai/api/reference/get-architecture-tree) |
| `list_knowledge_connections` | List connected knowledge repositories | Read | [`GET /v1/knowledge/connected-repositories`](https://docs.coderabbit.ai/api/reference/list-knowledge-connections) |
| `connect_knowledge_repository` | Connect an installed repository as a knowledge source | Write | [`POST /v1/knowledge/connected-repositories`](https://docs.coderabbit.ai/api/reference/connect-knowledge-repository) |
| `disconnect_knowledge_repository` | Disconnect a knowledge repository | Write | [`DELETE /v1/knowledge/connected-repositories/{repository_id}`](https://docs.coderabbit.ai/api/reference/disconnect-knowledge-repository) |
| `reindex_knowledge_repository` | Request a connected repository index refresh | Write | [`POST /v1/knowledge/connected-repositories/{repository_id}/reindex`](https://docs.coderabbit.ai/api/reference/reindex-knowledge-repository) |
| `list_learnings` | List saved Learnings | Read | [`GET /v1/knowledge/learnings`](https://docs.coderabbit.ai/api/reference/list-learnings) |
| `create_learnings` | Create Learnings | Write | [`POST /v1/knowledge/learnings`](https://docs.coderabbit.ai/api/reference/create-learnings) |
| `get_learning` | Read a saved Learning | Read | [`GET /v1/knowledge/learnings/{learning_id}`](https://docs.coderabbit.ai/api/reference/get-learning) |
| `delete_learning` | Delete a Learning | Write | [`DELETE /v1/knowledge/learnings/{learning_id}`](https://docs.coderabbit.ai/api/reference/delete-learning) |
| `update_learning` | Update a Learning | Write | [`PATCH /v1/knowledge/learnings/{learning_id}`](https://docs.coderabbit.ai/api/reference/update-learning) |
| `export_learnings` | Export saved Learnings | Read | [`GET /v1/knowledge/learnings/export`](https://docs.coderabbit.ai/api/reference/export-learnings) |
| `get_learning_filters` | Read available Learning filters | Read | [`GET /v1/knowledge/learnings/filters`](https://docs.coderabbit.ai/api/reference/get-learning-filters) |
| `get_learning_statistics` | Read recorded Learning usage statistics | Read | [`GET /v1/knowledge/learnings/statistics`](https://docs.coderabbit.ai/api/reference/get-learning-statistics) |

### Automations

| Tool | What it does | Access | REST operation |
| - | - | - | - |
| `list_automations` | List accessible automations | Read | [`GET /v1/automations`](https://docs.coderabbit.ai/api/reference/list-automations) |
| `create_automation` | Create an ordinary Automation | Write | [`POST /v1/automations`](https://docs.coderabbit.ai/api/reference/create-automation) |
| `get_automation` | Read an ordinary Automation and its editable definition | Read | [`GET /v1/automations/{automation_id}`](https://docs.coderabbit.ai/api/reference/get-automation) |
| `update_automation` | Replace an ordinary Automation definition at its observed revision | Write | [`PUT /v1/automations/{automation_id}`](https://docs.coderabbit.ai/api/reference/update-automation) |
| `command_automation` | Run, pause, resume, or delete an ordinary Automation | Write | [`POST /v1/automations/{automation_id}/commands`](https://docs.coderabbit.ai/api/reference/command-automation) |
| `list_automation_runs` | List recorded ordinary Automation runs | Read | [`GET /v1/automations/{automation_id}/runs`](https://docs.coderabbit.ai/api/reference/list-automation-runs) |

### Reports

| Tool | What it does | Access | REST operation |
| - | - | - | - |
| `list_reports` | List existing report configurations | Read | [`GET /v1/reports`](https://docs.coderabbit.ai/api/reference/list-reports) |
| `create_report` | Create an on-demand or scheduled report | Write | [`POST /v1/reports`](https://docs.coderabbit.ai/api/reference/create-report) |
| `get_report` | Read an existing report configuration | Read | [`GET /v1/reports/{report_id}`](https://docs.coderabbit.ai/api/reference/get-report) |
| `update_report` | Replace a recurring report configuration | Write | [`PUT /v1/reports/{report_id}`](https://docs.coderabbit.ai/api/reference/update-report) |
| `delete_report` | Delete a report configuration | Write | [`DELETE /v1/reports/{report_id}`](https://docs.coderabbit.ai/api/reference/delete-report) |
| `set_report_status` | Enable or disable a report schedule | Write | [`PATCH /v1/reports/{report_id}`](https://docs.coderabbit.ai/api/reference/set-report-status) |

### Configuration

| Tool | What it does | Access | REST operation |
| - | - | - | - |
| `get_organization_configuration` | Read organization review configuration | Read | [`GET /v1/configuration/organization`](https://docs.coderabbit.ai/api/reference/get-organization-configuration) |
| `set_organization_configuration` | Replace organization review configuration | Write | [`PUT /v1/configuration/organization`](https://docs.coderabbit.ai/api/reference/set-organization-configuration) |
| `get_workspace_configuration` | Read workspace review configuration | Read | [`GET /v1/configuration/workspace`](https://docs.coderabbit.ai/api/reference/get-workspace-configuration) |
| `get_workspace_configuration_defaults` | Read the workspace configuration-default policy | Read | [`GET /v1/configuration/workspace-defaults`](https://docs.coderabbit.ai/api/reference/get-workspace-configuration-defaults) |
| `set_workspace_configuration_defaults` | Set the workspace configuration-default policy | Write | [`PUT /v1/configuration/workspace-defaults`](https://docs.coderabbit.ai/api/reference/set-workspace-configuration-defaults) |
| `get_repository_configuration` | Read repository review configuration | Read | [`GET /v1/repositories/{repository_id}/configuration`](https://docs.coderabbit.ai/api/reference/get-repository-configuration) |
| `set_repository_configuration` | Replace repository review configuration | Write | [`PUT /v1/repositories/{repository_id}/configuration`](https://docs.coderabbit.ai/api/reference/set-repository-configuration) |
| `get_effective_repository_configuration` | Read the effective review configuration and its layers | Read | [`GET /v1/repositories/{repository_id}/configuration/effective`](https://docs.coderabbit.ai/api/reference/get-effective-repository-configuration) |
| `preview_repository_configuration` | Preview effective repository configuration without saving | Write | [`POST /v1/repositories/{repository_id}/configuration/preview`](https://docs.coderabbit.ai/api/reference/preview-repository-configuration) |
| `get_repository_configuration_source` | Read a repository's configuration source | Read | [`GET /v1/repositories/{repository_id}/configuration/source`](https://docs.coderabbit.ai/api/reference/get-repository-configuration-source) |
| `set_repository_configuration_source` | Set a repository's configuration source | Write | [`PUT /v1/repositories/{repository_id}/configuration/source`](https://docs.coderabbit.ai/api/reference/set-repository-configuration-source) |

### Connections

| Tool | What it does | Access | REST operation |
| - | - | - | - |
| `list_connections` | List accessible workspace connections | Read | [`GET /v1/connections`](https://docs.coderabbit.ai/api/reference/list-connections) |
| `create_connection` | Create a workspace connection | Write | [`POST /v1/connections`](https://docs.coderabbit.ai/api/reference/create-connection) |
| `get_connection` | Read masked saved-connection configuration | Read | [`GET /v1/connections/{connectionId}`](https://docs.coderabbit.ai/api/reference/get-connection) |
| `update_connection` | Update a workspace connection | Write | [`PUT /v1/connections/{connectionId}`](https://docs.coderabbit.ai/api/reference/update-connection) |
| `delete_connection` | Delete a workspace connection | Write | [`DELETE /v1/connections/{connectionId}`](https://docs.coderabbit.ai/api/reference/delete-connection) |
| `patch_connection_metadata` | Update a connection's name or description | Write | [`PATCH /v1/connections/{connectionId}`](https://docs.coderabbit.ai/api/reference/patch-connection-metadata) |
| `complete_connection_requests` | Verify a saved connection and complete matching requests | Write | [`POST /v1/connections/{connectionId}/complete-requests`](https://docs.coderabbit.ai/api/reference/complete-connection-requests) |
| `discover_connection_mcp_tools` | Discover tools from a configured MCP connection | Write | [`POST /v1/connections/mcp/tools`](https://docs.coderabbit.ai/api/reference/discover-connection-mcp-tools) |
| `list_connection_requests` | List pending workspace connection requests | Read | [`GET /v1/connections/requests`](https://docs.coderabbit.ai/api/reference/list-connection-requests) |
| `get_connection_request` | Read an existing connection-request intent | Read | [`GET /v1/connections/requests/{intent}`](https://docs.coderabbit.ai/api/reference/get-connection-request) |
| `submit_connection_request` | Submit an existing connection-request intent | Write | [`POST /v1/connections/requests/{intent}`](https://docs.coderabbit.ai/api/reference/submit-connection-request) |
| `test_connection` | Test a connection with existing credential and provider checks | Write | [`POST /v1/connections/test`](https://docs.coderabbit.ai/api/reference/test-connection) |

### Users and roles

| Tool | What it does | Access | REST operation |
| - | - | - | - |
| `list_roles` | List organization roles | Read | [`GET /v1/configuration/roles`](https://docs.coderabbit.ai/api/reference/list-roles) |
| `create_role` | Create a custom role by copying an existing role | Write | [`POST /v1/configuration/roles`](https://docs.coderabbit.ai/api/reference/create-role) |
| `get_role` | Read a role and its permissions | Read | [`GET /v1/configuration/roles/{roleId}`](https://docs.coderabbit.ai/api/reference/get-role) |
| `delete_role` | Delete an unassigned custom role | Write | [`DELETE /v1/configuration/roles/{roleId}`](https://docs.coderabbit.ai/api/reference/delete-role) |
| `update_role` | Update a custom role | Write | [`PATCH /v1/configuration/roles/{roleId}`](https://docs.coderabbit.ai/api/reference/update-role) |
| `list_role_permission_options` | List supported role permissions | Read | [`GET /v1/configuration/roles/permissions`](https://docs.coderabbit.ai/api/reference/list-role-permission-options) |
| `list_users` | List organization users and seat assignments | Read | MCP only |
| `manage_seats` | Assign or unassign organization seats | Write | MCP only |
| `list_audit_logs` | List organization audit logs | Read | MCP only |

### Usage and metrics

| Tool | What it does | Access | REST operation |
| - | - | - | - |
| `get_credits` | Read permitted credit balances | Read | [`GET /v1/credits`](https://docs.coderabbit.ai/api/reference/get-credits) |
| `get_usage` | Read current usage and permitted credit balances | Read | [`GET /v1/usage`](https://docs.coderabbit.ai/api/reference/get-usage) |
| `get_usage_budget` | Read current usage budget policy and consumption | Read | [`GET /v1/usage/budget`](https://docs.coderabbit.ai/api/reference/get-usage-budget) |
| `list_usage_budget_members` | Read paginated member usage budgets | Read | [`GET /v1/usage/budget/members`](https://docs.coderabbit.ai/api/reference/list-usage-budget-members) |

## What's next

> [card] [Connect an MCP client](https://docs.coderabbit.ai/api/mcp.md)
>
> Connect your agent and choose the scopes for the tools it calls.

> [card] [Request and read reviews](https://docs.coderabbit.ai/api/guides/pull-request-reviews.md)
>
> Find a pull request, request a review, and follow its status.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.