Skip to main content

repo_cloud_agent_configuration

Creates, updates, deletes, gets or lists a repo_cloud_agent_configuration resource.

Overview

Namerepo_cloud_agent_configuration
TypeResource
Idgithub.copilot.repo_cloud_agent_configuration

Fields

The following fields are returned by SELECT queries:

Response

NameDatatypeDescription
custom_allowlistarrayA list of custom allowlist entries, as hosts or URLs, that the firewall will allow the Copilot cloud agent to access.
enabled_toolsobjectThe enabled review tools for Copilot cloud agent.
is_automations_enabledbooleanWhether 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_enabledbooleanWhether the firewall is enabled.
is_firewall_recommended_allowlist_enabledbooleanWhether the firewall recommended allowlist is enabled.
mcp_configurationobjectThe 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.
require_actions_workflow_approvalbooleanWhether Actions workflow approval is required for Copilot cloud agent pull requests.
require_write_access_for_automation_triggersbooleanWhether 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.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_copilot_cloud_agent_configurationselectowner, repo> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets the Copilot cloud agent configuration for a repository, including MCP server
configuration, enabled review tools, Actions workflow approval settings, and firewall
configuration.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
ownerstringThe account owner of the repository. The name is not case sensitive.
repostringThe name of the repository without the .git extension. The name is not case sensitive.

SELECT examples

> [!NOTE]
> This endpoint is in public preview and is subject to change.

Gets the Copilot cloud agent configuration for a repository, including MCP server
configuration, enabled review tools, Actions workflow approval settings, and firewall
configuration.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

SELECT
custom_allowlist,
enabled_tools,
is_automations_enabled,
is_firewall_enabled,
is_firewall_recommended_allowlist_enabled,
mcp_configuration,
require_actions_workflow_approval,
require_write_access_for_automation_triggers
FROM github.copilot.repo_cloud_agent_configuration
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
;