GitHub: Get Copilot cloud agent configuration for a repository

← Copilot operations · Get started

Operation github.copilot_get_copilot_cloud_agent_configuration

Provider route: GET /repos/{owner}/{repo}/copilot/cloud-agent/configuration. Alter supplies the connection’s credentials and routing.

Call through Alter

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"]["copilotGetCopilotCloudAgentConfiguration"]>[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.copilotGetCopilotCloudAgentConfiguration(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_get_copilot_cloud_agent_configuration(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent

Response

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

Field	Type	Presence	Description and constraints
$	object	Root
custom_allowlist	array	Required within parent	A list of custom allowlist entries, as hosts or URLs, that the firewall will allow the Copilot cloud agent to access.
custom_allowlist[]	string	Each item	A custom allowlist entry, as a host or URL, that the firewall will allow the Copilot cloud agent to access.
enabled_tools	object	Required within parent	The enabled review tools for Copilot cloud agent.
enabled_tools.codeql	boolean	Required within parent	Whether the CodeQL tool is enabled for the Copilot cloud agent.
enabled_tools.copilot_code_review	boolean	Required within parent	Whether the Copilot code review tool is enabled for the Copilot cloud agent.
enabled_tools.dependency_vulnerability_checks	boolean	Required within parent	Whether the dependency vulnerability checks tool is enabled for the Copilot cloud agent.
enabled_tools.secret_scanning	boolean	Required within parent	Whether the secret scanning tool is enabled for the Copilot cloud agent.
is_automations_enabled	boolean	Required within parent	Whether automations are enabled in this repository. When true, users can create automations that automatically run agents on a schedule or in response to events like new issues or updated pull requests.
is_firewall_enabled	boolean	Required within parent	Whether the firewall is enabled.
is_firewall_recommended_allowlist_enabled	boolean	Required within parent	Whether the firewall recommended allowlist is enabled.
mcp_configuration	JSON	Required within parent
mcp_configuration (anyOf 1)	object	Alternative	The user-supplied MCP server configuration for the repository, as a free-form JSON object. This will be set to `null` if no configuration has been set. The shape of a valid MCP configuration may evolve over time, so this property is intentionally not strictly typed. Clients should not assume a fixed schema. Additional keys: allowed
mcp_configuration (anyOf 2)	null	Alternative
require_actions_workflow_approval	boolean	Required within parent	Whether Actions workflow approval is required for Copilot cloud agent pull requests.
require_write_access_for_automation_triggers	boolean	Required within parent	Whether write access is required for automation triggers. When true, automations will only run if the user triggering the event has write access to the repository. When false, users can create automations that listen for events triggered by users without write access.

Policy, approvals and errors

SDK function policy ID: github.copilot_get_copilot_cloud_agent_configuration. Catalog operation: copilot/get-copilot-cloud-agent-configuration. 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