Skip to content

GitHub: Update Copilot code review settings for a repository

GitHub copilot.copilotUpdateRepositoryCodeReviewSettings: arguments, response, policy and SDK examples.

← Copilot operations · Get started

Operation github.copilot_update_repository_code_review_settings

Provider route: PATCH /repos/{owner}/{repo}/copilot/code-review/settings. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";
async function execute(input: Parameters<GitHubIntegration["copilot"]["copilotUpdateRepositoryCodeReviewSettings"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.copilot.copilotUpdateRepositoryCodeReviewSettings(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.copilot.copilot_update_repository_code_review_settings(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.ownerstringRequired within parent
path.repostringRequired within parent
bodyobjectRequired within parentAdditional keys: not allowed
body.custom_instructions_enabledbooleanOptionalWhether reviews use the repository’s custom instructions.
body.mcp_enabledbooleanOptionalWhether reviews can use MCP servers.
body.review_effortstringOptionalThe review effort for the repository. Use `inherit` to clear the repository’s value. Only efforts listed in the settings’ `available_review_efforts` are accepted, and a rejected effort’s error message lists them. For more information, see [Review effort level](https://docs.github.com/copilot/concepts/agent-capabilities/agent-powered-workflows-and-operations/code-review#review-effort-level).
body.severity_filterstringOptionalWhich review comment severities Copilot code review leaves out. Can only be set when the severity filter is available for the repository.
One of: no_filter, low, low_and_medium

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Copilot code review settings for a repository — response body

Referenced models: Get Copilot code review settings for a repository — response body

Get Copilot code review settings for a repository — response body
FieldTypePresenceDescription and constraints
$objectRootThe repository's Copilot code review settings. These settings tune reviews; they do not enable Copilot code review.
available_review_effortsarrayRequired within parentThe review efforts that can currently be set for this repository, in display order.
available_review_efforts[]stringEach item
custom_instructions_enabledbooleanRequired within parentWhether reviews use the repository's custom instructions.
mcp_enabledbooleanRequired within parentWhether reviews can use MCP servers.
review_effortModelRequired within parentExpand Get Copilot code review settings for a repository — response body — review effort
severity_filterstringRequired within parentWhich review comment severities Copilot code review leaves out. `no_filter` keeps every comment, `low` leaves out low-severity comments, and `low_and_medium` leaves out low- and medium-severity comments.
Known values: no_filter, low, low_and_medium

Referenced models: Get Copilot code review settings for a repository — response body — review effort

Get Copilot code review settings for a repository — response body — review effort
FieldTypePresenceDescription and constraints
$objectRootThe review effort for the repository. For more information, see [Review effort level](https://docs.github.com/copilot/concepts/agent-capabilities/agent-powered-workflows-and-operations/code-review#review-effort-level).
configuredJSONRequired within parent
configured (anyOf 1)stringAlternativeThe review effort stored for the repository. Null means the repository inherits the default, or has stored a value that is not currently available.
configured (anyOf 2)nullAlternative
effectivestringRequired within parentThe review effort reviews use when the requester and the pull request do not choose one. When that effort is not currently available for the repository, this reports the effort reviews would use without it.

SDK function policy ID: github.copilot_update_repository_code_review_settings. Catalog operation: copilot/update-repository-code-review-settings. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.