diff --git a/assets/images/help/copilot/cloud-agent/approve-and-run-workflows.png b/assets/images/help/copilot/cloud-agent/approve-and-run-workflows.png new file mode 100644 index 000000000000..db566bb3ad0e Binary files /dev/null and b/assets/images/help/copilot/cloud-agent/approve-and-run-workflows.png differ diff --git a/assets/images/help/copilot/cloud-agent/assign-to-copilot-dialog.png b/assets/images/help/copilot/cloud-agent/assign-to-copilot-dialog.png new file mode 100644 index 000000000000..8864e2e7a0c6 Binary files /dev/null and b/assets/images/help/copilot/cloud-agent/assign-to-copilot-dialog.png differ diff --git a/assets/images/help/copilot/cloud-agent/assign-to-copilot.png b/assets/images/help/copilot/cloud-agent/assign-to-copilot.png new file mode 100644 index 000000000000..850ad4fc89d5 Binary files /dev/null and b/assets/images/help/copilot/cloud-agent/assign-to-copilot.png differ diff --git a/assets/images/help/copilot/cloud-agent/comment-to-agent-on-pr.png b/assets/images/help/copilot/cloud-agent/comment-to-agent-on-pr.png new file mode 100644 index 000000000000..4b8d26fab03f Binary files /dev/null and b/assets/images/help/copilot/cloud-agent/comment-to-agent-on-pr.png differ diff --git a/assets/images/help/copilot/cloud-agent/firewall-warning.png b/assets/images/help/copilot/cloud-agent/firewall-warning.png new file mode 100644 index 000000000000..285d93ee2e09 Binary files /dev/null and b/assets/images/help/copilot/cloud-agent/firewall-warning.png differ diff --git a/assets/images/help/copilot/cloud-agent/log-stop-session.png b/assets/images/help/copilot/cloud-agent/log-stop-session.png new file mode 100644 index 000000000000..4c3dc631305e Binary files /dev/null and b/assets/images/help/copilot/cloud-agent/log-stop-session.png differ diff --git a/assets/images/help/copilot/cloud-agent/mobile-status-dropdown.png b/assets/images/help/copilot/cloud-agent/mobile-status-dropdown.png new file mode 100644 index 000000000000..308a3b5dded8 Binary files /dev/null and b/assets/images/help/copilot/cloud-agent/mobile-status-dropdown.png differ diff --git a/assets/images/help/copilot/cloud-agent/open-agent-session-in-copilot-cli.png b/assets/images/help/copilot/cloud-agent/open-agent-session-in-copilot-cli.png new file mode 100644 index 000000000000..4feaa802831e Binary files /dev/null and b/assets/images/help/copilot/cloud-agent/open-agent-session-in-copilot-cli.png differ diff --git a/content/account-and-profile/get-started/personal-dashboard-quickstart.md b/content/account-and-profile/get-started/personal-dashboard-quickstart.md index 44d3f1cf0cf5..8b0484bf58be 100644 --- a/content/account-and-profile/get-started/personal-dashboard-quickstart.md +++ b/content/account-and-profile/get-started/personal-dashboard-quickstart.md @@ -75,7 +75,7 @@ This feed shows activity and recommendations based on your network on {% data va {% data reusables.dashboard.home-dashboard-public-preview-note %} -The home dashboard view gives you visibility into your {% data variables.copilot.copilot_coding_agent %} sessions and helps you manage your most important tasks more efficiently. You can prompt {% data variables.product.prodname_copilot %} directly from the dashboard, track the latest agent sessions you've triggered, quickly access agent logs to see progress, and manage the resulting pull requests and tasks. This centralized view makes it easier to stay on top of your agent activities and follow up on their outcomes. +The home dashboard view gives you visibility into your {% data variables.copilot.copilot_cloud_agent %} sessions and helps you manage your most important tasks more efficiently. You can prompt {% data variables.product.prodname_copilot %} directly from the dashboard, track the latest agent sessions you've triggered, quickly access agent logs to see progress, and manage the resulting pull requests and tasks. This centralized view makes it easier to stay on top of your agent activities and follow up on their outcomes. To view the updated home dashboard, which is currently in {% data variables.release-phases.public_preview %}, you will first need to enable **New Dashboard Experience** with feature preview. For more information, see [AUTOTITLE](/get-started/using-github/exploring-early-access-releases-with-feature-preview#exploring-public-preview-releases-with-feature-preview). diff --git a/content/account-and-profile/reference/personal-dashboard.md b/content/account-and-profile/reference/personal-dashboard.md index 7783b00c4646..009fe8cadc7a 100644 --- a/content/account-and-profile/reference/personal-dashboard.md +++ b/content/account-and-profile/reference/personal-dashboard.md @@ -85,8 +85,8 @@ To view the updated home dashboard, which is currently in {% data variables.rele The home dashboard includes: -* **A {% data variables.product.prodname_copilot %} prompt box**: You can prompt {% data variables.product.prodname_copilot %}, assign {% data variables.copilot.copilot_coding_agent %} to tasks, create an issue with {% data variables.product.prodname_copilot %}, and start building with {% data variables.product.prodname_spark %}. -* **Agent sessions**: A list of your running and past {% data variables.copilot.copilot_coding_agent %} sessions. Click **View all** to open the agents tab. +* **A {% data variables.product.prodname_copilot %} prompt box**: You can prompt {% data variables.product.prodname_copilot %}, assign {% data variables.copilot.copilot_cloud_agent %} to tasks, create an issue with {% data variables.product.prodname_copilot %}, and start building with {% data variables.product.prodname_spark %}. +* **Agent sessions**: A list of your running and past {% data variables.copilot.copilot_cloud_agent %} sessions. Click **View all** to open the agents tab. * **Pull requests**: A list of the most recent pull requests that you authored, reviewed, were mentioned on, or where you've been requested as a reviewer. * **Issues**: A list of the most recent issues assigned to you or involving you. diff --git a/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-governance.md b/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-governance.md index 201bdede9d38..0ee8c29f0ee0 100644 --- a/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-governance.md +++ b/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-governance.md @@ -61,7 +61,7 @@ The following are eligible for bypass access: * Repository admins, organization owners, and enterprise owners * The maintain or write role, or deploy keys. {%- ifversion ghec %} -* {% data variables.copilot.copilot_coding_agent %}. For more information about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-coding-agent#limitations-in-copilot-coding-agents-compatibility-with-other-features). +* {% data variables.copilot.copilot_cloud_agent %}. For more information about {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent#limitations-in-copilot-cloud-agents-compatibility-with-other-features). {%- endif %} 1. To grant bypass permissions for the ruleset, in the "Bypass list" section, click **Add bypass**. @@ -121,7 +121,7 @@ You can grant certain roles, teams, or apps bypass permissions as well as the ab * Repository admins, organization owners, and enterprise owners * The maintain or write role, or deploy keys {%- ifversion ghec %} -* {% data variables.copilot.copilot_coding_agent %}. For more information about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-coding-agent#limitations-in-copilot-coding-agents-compatibility-with-other-features). +* {% data variables.copilot.copilot_cloud_agent %}. For more information about {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent#limitations-in-copilot-cloud-agents-compatibility-with-other-features). {%- endif %} 1. To grant bypass permissions for the ruleset, in the "Bypass list" section, click **Add bypass**. diff --git a/content/admin/managing-iam/understanding-iam-for-enterprises/abilities-and-restrictions-of-managed-user-accounts.md b/content/admin/managing-iam/understanding-iam-for-enterprises/abilities-and-restrictions-of-managed-user-accounts.md index 2188aae3042d..fc5f9e493320 100644 --- a/content/admin/managing-iam/understanding-iam-for-enterprises/abilities-and-restrictions-of-managed-user-accounts.md +++ b/content/admin/managing-iam/understanding-iam-for-enterprises/abilities-and-restrictions-of-managed-user-accounts.md @@ -46,7 +46,7 @@ With {% data variables.product.prodname_emus %}, you can control the user accoun ## {% data variables.product.prodname_copilot %} * {% data variables.enterprise.prodname_managed_users_caps %} cannot sign up for {% data variables.copilot.copilot_pro %} or {% data variables.copilot.copilot_free %}. To allow a managed user to use {% data variables.product.prodname_copilot_short %}, you must grant the user access to a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} subscription. See [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot#getting-access-to-copilot). -* {% data reusables.copilot.coding-agent-emu-limitation %} +* {% data reusables.copilot.cloud-agent-emu-limitation %} ## {% data variables.product.prodname_pages %} diff --git a/content/billing/concepts/product-billing/github-copilot-premium-requests.md b/content/billing/concepts/product-billing/github-copilot-premium-requests.md index ebadfe645299..2038f1824c8a 100644 --- a/content/billing/concepts/product-billing/github-copilot-premium-requests.md +++ b/content/billing/concepts/product-billing/github-copilot-premium-requests.md @@ -22,14 +22,14 @@ Examples include: * Using {% data variables.copilot.copilot_chat_short %} with premium models * Large context windows or advanced reasoning models -* Features like {% data variables.copilot.copilot_coding_agent %} +* Features like {% data variables.copilot.copilot_cloud_agent %} * {% data variables.product.prodname_spark_short %} app creation Each product's premium request usage is attributed to a premium request SKU: * **{% data variables.product.prodname_copilot_short %} premium requests** - Chat, CLI, Code Review, Extensions, and Spaces * **{% data variables.product.prodname_spark_short %} premium requests** - {% data variables.product.prodname_spark_short %} app creation -* **{% data variables.copilot.copilot_coding_agent %} premium requests** - {% data variables.copilot.copilot_coding_agent %} sessions +* **{% data variables.copilot.copilot_cloud_agent %} premium requests** - {% data variables.copilot.copilot_cloud_agent %} sessions See [AUTOTITLE](/copilot/concepts/billing/copilot-requests) for details on which models and features consume premium requests and their SKU attribution. @@ -54,9 +54,9 @@ If you receive licenses from multiple enterprises, you must choose which entity * For example, advanced reasoning models may consume 5× or 20× the standard rate. * If you exceed your allowance and overages are enabled, extra usage is billed at the standard rate. -### Usage by {% data variables.copilot.copilot_coding_agent %} +### Usage by {% data variables.copilot.copilot_cloud_agent %} -When you use {% data variables.copilot.copilot_coding_agent %}, including any {% data variables.copilot.copilot_custom_agents %}, both **{% data variables.product.prodname_actions %} minutes** and **premium requests** are consumed: +When you use {% data variables.copilot.copilot_cloud_agent %}, including any {% data variables.copilot.copilot_custom_agents %}, both **{% data variables.product.prodname_actions %} minutes** and **premium requests** are consumed: * **{% data variables.product.prodname_actions %} minutes** come from your account’s monthly allowance of free minutes for {% data variables.product.github %}-hosted runners. This allowance is shared with all {% data variables.product.prodname_actions %} workflows. See [AUTOTITLE](/billing/managing-billing-for-github-actions/about-billing-for-github-actions#included-storage-and-minutes). * **Premium requests** come from the monthly allowance associated with your {% data variables.product.prodname_copilot_short %} license. This allowance is shared with other features, such as {% data variables.copilot.copilot_chat_short %}. @@ -68,9 +68,9 @@ Each cloud agent **session** consumes one premium request. A session begins when If you run out of free minutes or premium requests, and you have _not_ set up billing, a message is displayed explaining why {% data variables.product.prodname_copilot_short %} cannot work on the task. -{% data variables.copilot.copilot_coding_agent %} uses a dedicated {% data variables.copilot.copilot_coding_agent %} premium request SKU. This SKU still pulls from your monthly allowance of premium requests, but allows for more granular budget control and monitoring. +{% data variables.copilot.copilot_cloud_agent %} uses a dedicated {% data variables.copilot.copilot_cloud_agent %} premium request SKU. This SKU still pulls from your monthly allowance of premium requests, but allows for more granular budget control and monitoring. -For more information about {% data variables.copilot.copilot_coding_agent %} and {% data variables.copilot.copilot_custom_agents %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent) and [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents). +For more information about {% data variables.copilot.copilot_cloud_agent %} and {% data variables.copilot.copilot_custom_agents %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent) and [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-custom-agents). ## Using more than your included premium requests @@ -83,7 +83,7 @@ If you exceed your allowance, set a budget for additional premium requests or up ### Organizations and enterprises * Admins can control whether members are allowed to exceed their premium request allowance across AI features using the **Premium request paid usage** policy. -* Separate policy options are available for {% data variables.product.prodname_copilot_short %}, {% data variables.product.prodname_spark_short %}, and {% data variables.copilot.copilot_coding_agent %}. See [AUTOTITLE](/copilot/how-tos/manage-and-track-spending/manage-request-allowances). +* Separate policy options are available for {% data variables.product.prodname_copilot_short %}, {% data variables.product.prodname_spark_short %}, and {% data variables.copilot.copilot_cloud_agent %}. See [AUTOTITLE](/copilot/how-tos/manage-and-track-spending/manage-request-allowances). * Premium request budgets can be set to either monitor or block overages, with options for bundled or individual SKU management. * Enterprises can also upgrade frequent users to {% data variables.copilot.copilot_enterprise_short %} for higher included allowances. @@ -102,7 +102,7 @@ To help manage your budget for premium requests, consider the following strategi You can set a budget in your personal billing settings to receive alerts when you reach 75%, 90%, or 100% of your budget. Setting a premium request budget depends on the level of granularity you need: * **Bundled premium request budget** - Combines all premium requests into a single budget (Recommended for most users) -* **Individual SKU budgets** - Set separate budgets for each AI product (Copilot, {% data variables.product.prodname_spark_short %}, {% data variables.copilot.copilot_coding_agent %}) +* **Individual SKU budgets** - Set separate budgets for each AI product (Copilot, {% data variables.product.prodname_spark_short %}, {% data variables.copilot.copilot_cloud_agent %}) ### Budget options for organizations and enterprises diff --git a/content/billing/how-tos/set-up-budgets.md b/content/billing/how-tos/set-up-budgets.md index add61492854c..29c4a65e7a2c 100644 --- a/content/billing/how-tos/set-up-budgets.md +++ b/content/billing/how-tos/set-up-budgets.md @@ -51,7 +51,7 @@ You can set budgets and receive alerts when your usage of a product reaches 75%, * To limit spending at a Product-level, in "Product-level budget" choose a product from the dropdown, for example: {% data variables.product.prodname_codespaces %}. * To limit spending at a SKU-level, in "SKU-level budget" choose a Product and then a SKU, for example: {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_codespaces %} storage. - * To limit spending on premium requests across all features, enable "Bundled premium requests budget" or to limit spending for a specific feature, set a SKU-level budget for the feature (such as {% data variables.product.prodname_copilot_short %} premium requests, {% data variables.product.prodname_spark_short %} premium requests, or {% data variables.copilot.copilot_coding_agent %} premium requests). + * To limit spending on premium requests across all features, enable "Bundled premium requests budget" or to limit spending for a specific feature, set a SKU-level budget for the feature (such as {% data variables.product.prodname_copilot_short %} premium requests, {% data variables.product.prodname_spark_short %} premium requests, or {% data variables.copilot.copilot_cloud_agent %} premium requests). 1. Under "Budget scope", set the scope of spending for this budget. 1. Under "Budget", set a budget amount. @@ -106,7 +106,7 @@ As the owner of an enterprise or organization account, or as a billing manager, * To limit spending at a Product-level, in "Product-level budget" choose a product from the dropdown, for example: {% data variables.product.prodname_codespaces %}. * To limit spending at a SKU-level, in "SKU-level budget" choose a Product and then a SKU, for example: {% data variables.product.prodname_copilot_short %} and {% data variables.product.prodname_copilot_short %} Premium Request. -To limit spending on premium requests across all features, enable "Bundled premium requests budget" or to limit spending for a specific feature, set a SKU-level budget for the feature (such as {% data variables.product.prodname_copilot_short %} premium requests, {% data variables.product.prodname_spark_short %} premium requests, or {% data variables.copilot.copilot_coding_agent %} premium requests). +To limit spending on premium requests across all features, enable "Bundled premium requests budget" or to limit spending for a specific feature, set a SKU-level budget for the feature (such as {% data variables.product.prodname_copilot_short %} premium requests, {% data variables.product.prodname_spark_short %} premium requests, or {% data variables.copilot.copilot_cloud_agent %} premium requests). 1. Under "Budget scope", set the scope of spending for this budget. 1. Under "Budget", set a budget amount. diff --git a/content/code-security/concepts/about-code-quality.md b/content/code-security/concepts/about-code-quality.md index bfbf996954ed..b0eb4649bfc4 100644 --- a/content/code-security/concepts/about-code-quality.md +++ b/content/code-security/concepts/about-code-quality.md @@ -30,7 +30,7 @@ With {% data variables.product.prodname_code_quality_short %}, you can: * Use **repository dashboards** to track reliability and maintainability scores, identify areas needing attention, and prioritize remediation. * Monitor **organization dashboards** to understand the code health of your repositories at a glance and determine which repositories to investigate further. * Set up **rulesets** for pull requests to enforce code quality standards and block changes that do not meet your criteria. -* Easily assign remediation work to **{% data variables.copilot.copilot_coding_agent %}**, if you have a {% data variables.product.prodname_copilot_short %} license. +* Easily assign remediation work to **{% data variables.copilot.copilot_cloud_agent %}**, if you have a {% data variables.product.prodname_copilot_short %} license. ## Availability and usage costs diff --git a/content/code-security/concepts/security-at-scale/about-security-campaigns.md b/content/code-security/concepts/security-at-scale/about-security-campaigns.md index 9e7392b785bd..20eb4a9bc4d0 100644 --- a/content/code-security/concepts/security-at-scale/about-security-campaigns.md +++ b/content/code-security/concepts/security-at-scale/about-security-campaigns.md @@ -36,7 +36,7 @@ A security campaign has many benefits over other ways of encouraging developers * Each campaign has a named point of contact for questions, reviews, and collaboration. {% ifversion security-campaigns-autofix %} * For {% data variables.product.prodname_code_scanning %} alerts, {% data variables.copilot.copilot_autofix %} is automatically triggered to suggest a resolution. {% endif %} {%- ifversion code-secret-alert-assignees %} -* For both {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, you can assign alerts in a campaign to users with write access{% ifversion copilot %} or to {% data variables.copilot.copilot_coding_agent %} to automatically generate pull requests with fixes{% endif %}. +* For both {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_secret_scanning %}, you can assign alerts in a campaign to users with write access{% ifversion copilot %} or to {% data variables.copilot.copilot_cloud_agent %} to automatically generate pull requests with fixes{% endif %}. {%- endif %} You can use one of the templates to select a group of closely related alerts for a campaign. This allows developers to build on the knowledge gained by resolving one alert and use it to fix several more, providing them with an incentive to fix multiple alerts. @@ -69,7 +69,7 @@ The creation workflow is the same for all campaigns, but you will notice a few d {% ifversion code-secret-alert-assignees %} -## About assigning alerts{% ifversion security-campaigns-assign-to-cca %} to users and {% data variables.copilot.copilot_coding_agent %}{% endif %} +## About assigning alerts{% ifversion security-campaigns-assign-to-cca %} to users and {% data variables.copilot.copilot_cloud_agent %}{% endif %} {% ifversion code-secret-alert-assignees-ga %}{% elsif ghes = 3.20 %} @@ -95,7 +95,7 @@ For {% data variables.product.prodname_code_scanning %}, you can also perform so {% ifversion security-campaigns-assign-to-cca %} -If an autofix has been generated for alerts in a security campaign, you can select those alerts and assign them to {% data variables.copilot.copilot_coding_agent %}. {% data variables.product.prodname_copilot_short %} will create a pull request and add you as a requested reviewer. See [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign#assigning-alerts-to-copilot-coding-agent). +If an autofix has been generated for alerts in a security campaign, you can select those alerts and assign them to {% data variables.copilot.copilot_cloud_agent %}. {% data variables.product.prodname_copilot_short %} will create a pull request and add you as a requested reviewer. See [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign#assigning-alerts-to-copilot-cloud-agent). {% endif %} diff --git a/content/code-security/how-tos/maintain-quality-code/unblock-your-pr.md b/content/code-security/how-tos/maintain-quality-code/unblock-your-pr.md index a32671ec1641..d9e67f8ea40b 100644 --- a/content/code-security/how-tos/maintain-quality-code/unblock-your-pr.md +++ b/content/code-security/how-tos/maintain-quality-code/unblock-your-pr.md @@ -46,15 +46,15 @@ The merge block banner may specify the minimum severity level. All findings at t In order to unblock your pull request, you need to resolve each required finding by deciding whether to **fix** the issue in your code or **dismiss** the comment. -### Leveraging {% data variables.copilot.copilot_autofix_short %} and {% data variables.copilot.copilot_coding_agent %} to fix findings +### Leveraging {% data variables.copilot.copilot_autofix_short %} and {% data variables.copilot.copilot_cloud_agent %} to fix findings #### {% data variables.copilot.copilot_autofix_short %} {% data reusables.code-quality.fix-findings-with-copilot-autofix %} -#### {% data variables.copilot.copilot_coding_agent %} +#### {% data variables.copilot.copilot_cloud_agent %} -{% data reusables.code-quality.fix-findings-with-coding-agent %} +{% data reusables.code-quality.fix-findings-with-cloud-agent %} ### Dismissing the finding diff --git a/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/resolving-code-scanning-alerts.md b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/resolving-code-scanning-alerts.md index 89357d4e8e5c..e1978895d946 100644 --- a/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/resolving-code-scanning-alerts.md +++ b/content/code-security/how-tos/manage-security-alerts/manage-code-scanning-alerts/resolving-code-scanning-alerts.md @@ -58,9 +58,9 @@ You can also use the Autofix API for historical alerts endpoints to generate, ge {% ifversion security-campaigns-assign-to-cca %} -## Assigning alerts to {% data variables.copilot.copilot_coding_agent %} +## Assigning alerts to {% data variables.copilot.copilot_cloud_agent %} ->[!NOTE] This option is currently in public preview and is subject to change. {% data variables.copilot.copilot_coding_agent %} must be available in the repository. +>[!NOTE] This option is currently in public preview and is subject to change. {% data variables.copilot.copilot_cloud_agent %} must be available in the repository. You can assign {% data variables.product.prodname_copilot_short %} to apply an autofix. {% data variables.product.prodname_copilot_short %} analyzes the code scanning alert, creates a remediation plan, and implements the necessary code changes in a pull request. diff --git a/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/fixing-alerts-in-security-campaign.md b/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/fixing-alerts-in-security-campaign.md index 9028ac5bc600..102d8ee6493e 100644 --- a/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/fixing-alerts-in-security-campaign.md +++ b/content/code-security/how-tos/manage-security-alerts/remediate-alerts-at-scale/fixing-alerts-in-security-campaign.md @@ -46,13 +46,13 @@ If you want to see the code that triggered the security alert and the suggested {% ifversion security-campaigns-assign-to-cca %} -## Assigning alerts to {% data variables.copilot.copilot_coding_agent %} +## Assigning alerts to {% data variables.copilot.copilot_cloud_agent %} ->[!NOTE] This option is currently in public preview and is subject to change. {% data variables.copilot.copilot_coding_agent %} must be available in the repository. +>[!NOTE] This option is currently in public preview and is subject to change. {% data variables.copilot.copilot_cloud_agent %} must be available in the repository. If an autofix has been generated, you can assign one or more alerts to {% data variables.product.prodname_copilot_short %}. {% data variables.product.prodname_copilot_short %} will create pull requests, apply the autofixes, and add you as a requested reviewer. -By assigning multiple alerts, {% data variables.copilot.copilot_coding_agent %} will apply the fixes and iterate on the code to validate the changes, check for any new security issues, and ensure there are no merge conflicts. +By assigning multiple alerts, {% data variables.copilot.copilot_cloud_agent %} will apply the fixes and iterate on the code to validate the changes, check for any new security issues, and ensure there are no merge conflicts. 1. In the campaign view for the repository, select the alerts that you want to assign. 1. Above the list of alerts, click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} Assign to Copilot**. diff --git a/content/code-security/tutorials/improve-code-quality/fix-findings-in-prs.md b/content/code-security/tutorials/improve-code-quality/fix-findings-in-prs.md index bd77e49e2f3f..a7b01048cc8b 100644 --- a/content/code-security/tutorials/improve-code-quality/fix-findings-in-prs.md +++ b/content/code-security/tutorials/improve-code-quality/fix-findings-in-prs.md @@ -1,7 +1,7 @@ --- title: Fixing code quality findings before merging your pull request shortTitle: Fix findings in PRs -intro: Catch quality issues before they reach your default branch and fix them with {% data variables.copilot.copilot_autofix_short %} and {% data variables.copilot.copilot_coding_agent %}. +intro: Catch quality issues before they reach your default branch and fix them with {% data variables.copilot.copilot_autofix_short %} and {% data variables.copilot.copilot_cloud_agent %}. versions: feature: code-quality product: '{% data reusables.gated-features.code-quality-availability %}' @@ -17,7 +17,7 @@ category: ## Introduction -This tutorial shows you how to work with {% data variables.product.prodname_code_quality %} on pull requests to identify code quality issues that your changes may otherwise inadvertently introduce, and how to address and resolve code quality findings with {% data variables.copilot.copilot_autofix_short %} and {% data variables.copilot.copilot_coding_agent %}. +This tutorial shows you how to work with {% data variables.product.prodname_code_quality %} on pull requests to identify code quality issues that your changes may otherwise inadvertently introduce, and how to address and resolve code quality findings with {% data variables.copilot.copilot_autofix_short %} and {% data variables.copilot.copilot_cloud_agent %}. ### Benefits of catching issues early @@ -45,15 +45,15 @@ High severity findings indicate more serious code quality issues that are more l > [!NOTE] > A repository administrator may have set a code quality gate that **blocks** merging on your pull request, if the pull request contains {% data variables.product.prodname_code_quality_short %} findings of a particular severity level or above. See [AUTOTITLE](/code-security/code-quality/how-tos/unblock-your-pr). -## 3. Leverage {% data variables.copilot.copilot_autofix_short %} or {% data variables.copilot.copilot_coding_agent %} to fix findings +## 3. Leverage {% data variables.copilot.copilot_autofix_short %} or {% data variables.copilot.copilot_cloud_agent %} to fix findings ### {% data variables.copilot.copilot_autofix_short %} {% data reusables.code-quality.fix-findings-with-copilot-autofix %} -### {% data variables.copilot.copilot_coding_agent %} +### {% data variables.copilot.copilot_cloud_agent %} -{% data reusables.code-quality.fix-findings-with-coding-agent %} +{% data reusables.code-quality.fix-findings-with-cloud-agent %} ## 4. Dismiss irrelevant findings diff --git a/content/code-security/tutorials/improve-code-quality/improve-recent-merges.md b/content/code-security/tutorials/improve-code-quality/improve-recent-merges.md index 810037c5c63f..52218d0e0647 100644 --- a/content/code-security/tutorials/improve-code-quality/improve-recent-merges.md +++ b/content/code-security/tutorials/improve-code-quality/improve-recent-merges.md @@ -1,7 +1,7 @@ --- title: Improving the quality of recently merged code with AI shortTitle: Improve recent merges -intro: Explore {% data variables.product.prodname_code_quality %} findings for recently merged code and fix with {% data variables.copilot.copilot_autofix_short %} or delegate remediation work to {% data variables.copilot.copilot_coding_agent %}. +intro: Explore {% data variables.product.prodname_code_quality %} findings for recently merged code and fix with {% data variables.copilot.copilot_autofix_short %} or delegate remediation work to {% data variables.copilot.copilot_cloud_agent %}. versions: feature: code-quality product: '{% data reusables.gated-features.code-quality-availability %}' @@ -55,34 +55,34 @@ On the **{% data variables.code-quality.recent_suggestions %}** page, each file ## 3. Delegate remediation work or open pull requests yourself -You can open a pull request to apply the suggested autofixes to a file or delegate the remediation work to {% data variables.copilot.copilot_coding_agent %}. You need a {% data variables.product.prodname_copilot_short %} license to assign work to {% data variables.copilot.copilot_coding_agent %}. +You can open a pull request to apply the suggested autofixes to a file or delegate the remediation work to {% data variables.copilot.copilot_cloud_agent %}. You need a {% data variables.product.prodname_copilot_short %} license to assign work to {% data variables.copilot.copilot_cloud_agent %}.
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 aria-label="link-external" %} -### Delegate work to {% data variables.copilot.copilot_coding_agent %} +### Delegate work to {% data variables.copilot.copilot_cloud_agent %} -You can ask {% data variables.copilot.copilot_coding_agent_short %} to open pull requests to make improvements to files using the suggested changes as a prompt. This is the best option if the suggested changes look good to you and you want to open a pull request that applies fixes to more than one file. +You can ask {% data variables.copilot.copilot_cloud_agent_short %} to open pull requests to make improvements to files using the suggested changes as a prompt. This is the best option if the suggested changes look good to you and you want to open a pull request that applies fixes to more than one file. To delegate pull request creation: * **Multiple files:** Select the files you want to include, then click **Assign selected to {% data variables.product.prodname_copilot_short %}** in the header for the list of files. * **One file:** Click **Assign to {% data variables.product.prodname_copilot_short %}** for the file. -There is a delay while the {% data variables.copilot.copilot_coding_agent_short %} sets up the work. When the pull request is open and work is in progress, a banner is displayed with a link to the pull request. +There is a delay while the {% data variables.copilot.copilot_cloud_agent_short %} sets up the work. When the pull request is open and work is in progress, a banner is displayed with a link to the pull request. -You can track {% data variables.copilot.copilot_coding_agent %}'s work: +You can track {% data variables.copilot.copilot_cloud_agent %}'s work: * In the pull request, the summary is updated as work progresses. -* Using the [agents page](https://github.com/copilot/agents?ref_product=copilot&ref_type=engagement&ref_style=text) or session logs. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions). +* Using the [agents page](https://github.com/copilot/agents?ref_product=copilot&ref_type=engagement&ref_style=text) or session logs. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions). ### Open your own pull requests You can open pull requests yourself to apply autofix suggestions. This is the best option if: * You want to work on the changes locally or in {% data variables.product.prodname_desktop %} before opening a pull request -* You do not have access to {% data variables.copilot.copilot_coding_agent %} +* You do not have access to {% data variables.copilot.copilot_cloud_agent %} > [!NOTE] -> When you open a pull request yourself, you can only commit fixes to one file at a time. To fix multiple files at once, you must use {% data variables.copilot.copilot_coding_agent %}. +> When you open a pull request yourself, you can only commit fixes to one file at a time. To fix multiple files at once, you must use {% data variables.copilot.copilot_cloud_agent %}. #### Opening a pull request @@ -97,7 +97,7 @@ You can open pull requests yourself to apply autofix suggestions. This is the be ## 4. Provide pull request reviewers with context -Providing context on why you are proposing changes to code is the best way to encourage team members to review your pull request. If you used {% data variables.copilot.copilot_coding_agent %}, the pull request summary already includes full details of the problems fixed by the pull request. +Providing context on why you are proposing changes to code is the best way to encourage team members to review your pull request. If you used {% data variables.copilot.copilot_cloud_agent %}, the pull request summary already includes full details of the problems fixed by the pull request. If you opened the pull request directly from the {% data variables.product.prodname_code_quality %} view, the pull request summary links to the "{% data variables.code-quality.recent_suggestions %}" view. You may want to copy some of the explanations from the {% data variables.code-quality.recent_suggestions %} view into the pull request summary. @@ -109,5 +109,5 @@ When you return to the "{% data variables.code-quality.recent_suggestions %}" vi ## Next steps -* Learn more about how {% data variables.copilot.copilot_coding_agent %} can help expedite development tasks. See [AUTOTITLE](/copilot/tutorials/coding-agent/get-the-best-results). +* Learn more about how {% data variables.copilot.copilot_cloud_agent %} can help expedite development tasks. See [AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results). * Provide feedback on {% data variables.product.prodname_code_quality %} in the [community discussion](https://github.com/orgs/community/discussions/177488). diff --git a/content/code-security/tutorials/manage-security-alerts/best-practices-for-participating-in-a-security-campaign.md b/content/code-security/tutorials/manage-security-alerts/best-practices-for-participating-in-a-security-campaign.md index 331b6de69d47..65086004dfd6 100644 --- a/content/code-security/tutorials/manage-security-alerts/best-practices-for-participating-in-a-security-campaign.md +++ b/content/code-security/tutorials/manage-security-alerts/best-practices-for-participating-in-a-security-campaign.md @@ -100,9 +100,9 @@ You can leverage {% data variables.product.prodname_copilot_short %} to help res {% ifversion security-campaigns-assign-to-cca %} -If {% data variables.copilot.copilot_coding_agent %} is enabled in the repository, you can also assign alerts to {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign#assigning-alerts-to-copilot-coding-agent). +If {% data variables.copilot.copilot_cloud_agent %} is enabled in the repository, you can also assign alerts to {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign#assigning-alerts-to-copilot-cloud-agent). -By assigning multiple alerts, {% data variables.copilot.copilot_coding_agent %} will apply the fixes and iterate on the code to validate the changes, check for any new security issues, and ensure there are no merge conflicts. +By assigning multiple alerts, {% data variables.copilot.copilot_cloud_agent %} will apply the fixes and iterate on the code to validate the changes, check for any new security issues, and ensure there are no merge conflicts. {% endif %} diff --git a/content/copilot/concepts/agents/about-agent-skills.md b/content/copilot/concepts/agents/about-agent-skills.md index 9f757fb2f110..7dc1137803f6 100644 --- a/content/copilot/concepts/agents/about-agent-skills.md +++ b/content/copilot/concepts/agents/about-agent-skills.md @@ -2,7 +2,7 @@ title: About agent skills shortTitle: Agent skills intro: Skills allow {% data variables.product.prodname_copilot_short %} to perform specialized tasks. -product: '{% data reusables.gated-features.copilot-coding-agent %}

{% data reusables.gated-features.copilot-cli %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +product: '{% data reusables.gated-features.copilot-cloud-agent %}

{% data reusables.gated-features.copilot-cli %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot category: @@ -12,7 +12,7 @@ contentType: concepts --- > [!NOTE] -> Agent skills work with {% data variables.copilot.copilot_coding_agent %}, the {% data variables.copilot.copilot_cli %}, and agent mode in {% data variables.product.prodname_vscode %}. +> Agent skills work with {% data variables.copilot.copilot_cloud_agent %}, the {% data variables.copilot.copilot_cli %}, and agent mode in {% data variables.product.prodname_vscode %}. ## About agent skills @@ -31,6 +31,6 @@ Support for organization-level and enterprise-level skills is coming soon. To create an agent skill, see: -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-skills) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-skills) * [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/create-skills) * [AUTOTITLE](/copilot/reference/customization-cheat-sheet) diff --git a/content/copilot/concepts/agents/about-third-party-agents.md b/content/copilot/concepts/agents/about-third-party-agents.md index 46f08f94a05c..fd30292f4191 100644 --- a/content/copilot/concepts/agents/about-third-party-agents.md +++ b/content/copilot/concepts/agents/about-third-party-agents.md @@ -12,9 +12,9 @@ contentType: concepts ## Introduction -You can use third-party coding agents alongside {% data variables.copilot.copilot_coding_agent %} to work asynchronously on your development tasks. You can assign an existing issue or give a prompt to an agent, which will work on the required changes and create a pull request. When the agent finishes, it will request a review from you, and you can leave pull request comments to ask the agent to iterate. +You can use third-party coding agents alongside {% data variables.copilot.copilot_cloud_agent %} to work asynchronously on your development tasks. You can assign an existing issue or give a prompt to an agent, which will work on the required changes and create a pull request. When the agent finishes, it will request a review from you, and you can leave pull request comments to ask the agent to iterate. -Coding agents are subject to the same security protections, mitigations, and limitations as {% data variables.copilot.copilot_coding_agent %}. To learn more about how you can use coding agents, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-coding-agent). +Coding agents are subject to the same security protections, mitigations, and limitations as {% data variables.copilot.copilot_cloud_agent %}. To learn more about how you can use coding agents, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). ### Where you can use coding agents diff --git a/content/copilot/concepts/agents/cloud-agent/about-cloud-agent.md b/content/copilot/concepts/agents/cloud-agent/about-cloud-agent.md new file mode 100644 index 000000000000..33ff981c73f5 --- /dev/null +++ b/content/copilot/concepts/agents/cloud-agent/about-cloud-agent.md @@ -0,0 +1,167 @@ +--- +title: About GitHub Copilot cloud agent +shortTitle: About cloud agent +allowTitleToDifferFromFilename: true +intro: '{% data variables.product.prodname_copilot_short %} can research a repository, create an implementation plan, and make code changes on a branch. You can review the diff, iterate, and create a pull request when you''re ready.' +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +versions: + feature: copilot +redirect_from: + - /copilot/concepts/agents/coding-agent/about-coding-agent + - /copilot/concepts/about-assigning-tasks-to-copilot + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/about-assigning-issues-to-copilot + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/about-assigning-tasks-to-copilot + - /copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot + - /copilot/concepts/about-copilot-coding-agent + - /copilot/concepts/coding-agent/about-copilot-coding-agent + - /copilot/concepts/coding-agent/coding-agent +contentType: concepts +category: + - Learn about Copilot +--- + + +## Overview of {% data variables.copilot.copilot_cloud_agent_tmp %} + +With {% data variables.copilot.copilot_cloud_agent %}, {% data variables.product.prodname_copilot %} can work independently in the background to complete tasks, just like a human developer. + +{% data variables.copilot.copilot_cloud_agent %} can: + +* Research a repository +* Create implementation plans +* Fix bugs +* Implement incremental new features +* Improve test coverage +* Update documentation +* Address technical debt +* Resolve merge conflicts + +When you delegate tasks to {% data variables.copilot.copilot_cloud_agent %}, you can: + +* Use the agents panel or other agents entry points on {% data variables.product.prodname_dotcom_the_website %} to have {% data variables.product.prodname_copilot_short %} research, plan, and make code changes on a branch, then iterate before creating a pull request. You can also specify in your prompt that you want a pull request created right away. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/research-plan-iterate). +* Ask {% data variables.product.prodname_copilot_short %} to open a new pull request from other entry points, including {% data variables.product.prodname_github_issues %} and {% data variables.product.prodname_vscode %}. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). +* Mention `@copilot` in a comment on an existing pull request to ask it to make changes. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/make-changes-to-an-existing-pr). +{% ifversion security-campaigns-assign-to-cca %}* Assign security alerts to {% data variables.product.prodname_copilot_short %} from security campaigns. See [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign#assigning-alerts-to-copilot-cloud-agent).{% endif %} + +{% data variables.copilot.copilot_cloud_agent %} will evaluate the task it has been assigned based on the prompt you give it. + +While working on a coding task, {% data variables.copilot.copilot_cloud_agent %} has access to its own ephemeral development environment, powered by {% data variables.product.prodname_actions %}, where it can explore your code, make changes, execute automated tests and linters and more. + +> [!NOTE] Deep research, planning, and iterating on code changes before creating a pull request are only available with {% data variables.copilot.copilot_cloud_agent %} on {% data variables.product.prodname_dotcom_the_website %}. {% data variables.copilot.copilot_cloud_agent_short_cap_c %} integrations (such as Azure Boards, JIRA, Linear, Slack, or Teams) only support creating a pull request directly. + +### Benefits over traditional AI workflows + +When used effectively, {% data variables.copilot.copilot_cloud_agent %} offers productivity benefits over traditional AI assistants in IDEs: + +* With **AI assistants in IDEs**, coding happens **locally**. Individual developers pair in **synchronous** sessions with the AI assistant. Decisions made during the session are **untracked** and lost to time unless committed. Although the assistant helps write code, the developer still has a lot of **manual steps** to do: create the branch, write commit messages, push the changes, open the PR, write the PR description, get a review, iterate in the IDE, and repeat. These steps take time and effort that may be hard to justify for simple or routine issues. + +* With **{% data variables.copilot.copilot_cloud_agent %}**, all coding and iterating happens **on {% data variables.product.github %}**. You can ask {% data variables.product.prodname_copilot_short %} to **research** a repository, **create a plan**, and **make code changes** on a branch—all before opening a pull request. You can create multiple {% data variables.copilot.custom_agents_short %} that specialize in different types of tasks. {% data variables.product.prodname_copilot_short %} **automates** branch creation, commit message writing, and pushing. Developers let the agents **work in the background** and then chooses to **create a pull request** when ready. Working on {% data variables.product.github %} adds **transparency**, with every step happening in a commit and being viewable in logs, and opens up **collaboration** opportunities for the entire team. + +## {% data variables.copilot.copilot_cloud_agent %} versus agent mode + +{% data variables.copilot.copilot_cloud_agent %} is distinct from the "agent mode" feature available in your IDE. {% data variables.copilot.copilot_cloud_agent %} works autonomously in a {% data variables.product.prodname_actions %}-powered environment to complete development tasks assigned through {% data variables.product.github %} issues or {% data variables.copilot.copilot_chat %} prompts. It can research a repository, create a plan, make code changes on a branch, and optionally open a pull request. In contrast, agent mode in your IDE makes autonomous edits directly in your local development environment. For more information about agent mode, see [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-your-ide). + +## Streamlining software development with {% data variables.copilot.copilot_cloud_agent %} + +Assigning tasks to {% data variables.copilot.copilot_cloud_agent %} can enhance your software development workflow. + +For example, you can assign {% data variables.copilot.copilot_cloud_agent %} to straightforward issues on your backlog by selecting "{% data variables.product.prodname_copilot_short %}" as the assignee. This allows you to spend less time on these issues and more time on more complex or interesting work, or work that requires a high degree of creative thinking. {% data variables.copilot.copilot_cloud_agent %} can work on "nice to have" issues that improve the quality of your codebase or product, but often remain on the backlog while you focus on more urgent work. + +Having {% data variables.copilot.copilot_cloud_agent %} as an additional coding resource also allows you to start tasks that you might not have otherwise started due to lack of resources. For example, you might create issues to refactor code or add more logging, and then immediately assign these to {% data variables.product.prodname_copilot_short %}. + +You can also use {% data variables.copilot.copilot_cloud_agent %} to research a repository and create a plan before any code is written, helping you understand how a codebase works or agree on an approach before committing to changes. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/research-plan-iterate). + +{% data variables.copilot.copilot_cloud_agent %} can start a task, which you then pick up and continue working on yourself. By assigning the initial work to {% data variables.product.prodname_copilot_short %}, you free up time that you would otherwise have spent doing repetitive tasks, such as setting up the scaffolding for a new project. + +You can create specialized {% data variables.copilot.custom_agents_short %} for different tasks. For example, you might create a {% data variables.copilot.copilot_custom_agent_short %} specialized for frontend development that focuses on React components and styling, a documentation agent that excels at writing and updating technical documentation, or a testing agent that specializes in generating comprehensive unit tests. Each {% data variables.copilot.copilot_custom_agent_short %} can be tailored with specific prompts and tools suited to its particular task. + +## Measuring pull request outcomes for {% data variables.copilot.copilot_cloud_agent %} + +Enterprise administrators and organization owners can use {% data variables.product.prodname_copilot_short %} usage metrics to analyze pull request outcomes for pull requests created by {% data variables.copilot.copilot_cloud_agent %}. + +The {% data variables.product.prodname_copilot_short %} usage metrics APIs include pull request lifecycle metrics such as: + +* The total number of pull requests created and merged +* The number of pull requests created by {% data variables.copilot.copilot_cloud_agent %} that have been merged +* Median time to merge for merged pull requests, including pull requests created by {% data variables.copilot.copilot_cloud_agent %} + +These metrics can help you track adoption of {% data variables.copilot.copilot_cloud_agent %} and monitor changes in pull request throughput and time to merge over time. See [AUTOTITLE](/copilot/concepts/copilot-usage-metrics/copilot-metrics). + +## Integrating {% data variables.copilot.copilot_cloud_agent %} with third-party tools + +You can also invoke {% data variables.copilot.copilot_cloud_agent %} from external tools, allowing you to assign tasks to {% data variables.product.prodname_copilot_short %}, provide context, and open pull requests without leaving your workflow. See [AUTOTITLE](/copilot/concepts/tools/about-copilot-integrations) + +## Making {% data variables.copilot.copilot_cloud_agent %} available + +Before you can assign tasks to {% data variables.copilot.copilot_cloud_agent %}, it must be enabled. + +{% data variables.copilot.copilot_cloud_agent %} is available with the {% data variables.copilot.copilot_pro %}, {% data variables.copilot.copilot_pro_plus %}, {% data variables.copilot.copilot_for_business %} and {% data variables.copilot.copilot_enterprise %} plans. + +If you are a {% data variables.copilot.copilot_for_business %} or {% data variables.copilot.copilot_enterprise %} subscriber, an administrator must enable the relevant policy before you can use the agent. + +Repository owners can choose to opt out some or all repositories from {% data variables.copilot.copilot_cloud_agent %}. + +For more information, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/access-management). + +## AI models for {% data variables.copilot.copilot_cloud_agent %} + +Depending on how you start your {% data variables.copilot.copilot_cloud_agent %} task, you may be able to select the model used by {% data variables.copilot.copilot_cloud_agent %}. You may find that different models perform better, or provide more useful responses, depending on the type of tasks you give {% data variables.product.prodname_copilot_short %}. + +For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/changing-the-ai-model). + +## Enhancing {% data variables.copilot.copilot_cloud_agent %}'s knowledge of a repository + +The more {% data variables.copilot.copilot_cloud_agent %} knows about the code in your repository, the tools you use, and your coding standards and practices, the more effective it will become. There are two ways you can enhance {% data variables.copilot.copilot_cloud_agent %}'s knowledge of a repository. + +* **Custom instructions** + + These are short, natural‑language statements that you write and store as one or more files in a repository. If you are the owner of an organization on {% data variables.product.github %} you can also define custom instructions in the settings for your organization. For more information, see [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=webui#about-repository-custom-instructions). + +* **{% data variables.copilot.copilot_memory %}** ({% data variables.release-phases.public_preview %}) + + If you have a {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plan, you can enable {% data variables.copilot.copilot_memory %}. This allows {% data variables.product.prodname_copilot_short %} to store useful details it has worked out for itself about a repository. {% data variables.copilot.copilot_cloud_agent %} can then use this information when it is working in that repository. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-memory). + +## {% data variables.copilot.copilot_cloud_agent %} usage costs + +{% data variables.copilot.copilot_cloud_agent %} uses {% data variables.product.prodname_actions %} minutes and {% data variables.product.prodname_copilot_short %} premium requests. + +Within your monthly usage allowance for {% data variables.product.prodname_actions %} and premium requests, you can ask {% data variables.copilot.copilot_cloud_agent %} to work on coding tasks without incurring any additional costs. + +For more information, see [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-copilot/about-billing-for-github-copilot#allowance-usage-for-copilot-cloud-agent). + +## Customizing {% data variables.copilot.copilot_cloud_agent %} + +You can customize {% data variables.copilot.copilot_cloud_agent %} in a number of ways: + +* **Custom instructions**: Custom instructions allow you to give {% data variables.product.prodname_copilot_short %} additional context on your project and how to build, test and validate its changes. For more information, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions). +* **Model Context Protocol (MCP) servers**: MCP servers allow you to give {% data variables.product.prodname_copilot_short %} access to different data sources and tools. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp). +* **{% data variables.copilot.custom_agents_caps_short %}**: {% data variables.copilot.custom_agents_caps_short %} allow you to create different specialized versions of {% data variables.product.prodname_copilot_short %} for different tasks. For example, you could customize {% data variables.product.prodname_copilot_short %} to be an expert frontend engineer following your team's guidelines. For more information, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-custom-agents). +* **Hooks**: Hooks allow you to execute custom shell commands at key points during agent execution, enabling you to add validation, logging, security scanning, or workflow automation. For more information, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-hooks). +* **Skills**: Skills allow you to enhance the ability of {% data variables.product.prodname_copilot_short %} to perform specialized tasks with instructions, scripts, and resources. For more information, see [AUTOTITLE](/copilot/concepts/agents/about-agent-skills). + +## Limitations of {% data variables.copilot.copilot_cloud_agent %} + +{% data variables.copilot.copilot_cloud_agent %} has certain limitations in its software development workflow and compatibility with other features. + +### Limitations in {% data variables.copilot.copilot_cloud_agent %}'s software development workflow + +* **{% data variables.product.prodname_copilot_short %} can only make changes in the repository specified when you start a task**. {% data variables.product.prodname_copilot_short %} cannot make changes across multiple repositories in one run. +* **By default, {% data variables.product.prodname_copilot_short %} can only access context in the repository specified when you start a task**. The {% data variables.product.prodname_copilot_short %} MCP server is configured by default to allow {% data variables.product.prodname_copilot_short %} to access context (for example issues and historic pull requests) in the repository where it is working. You can, however, configure broader access. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp). +* **{% data variables.product.prodname_copilot_short %} can only work on one branch at a time** and can open exactly one pull request to address each task it is assigned. + +### Limitations in {% data variables.copilot.copilot_cloud_agent %}'s compatibility with other features + +* **{% data variables.product.prodname_copilot_short %} isn't able to comply with certain rules that may be configured for your repository**. If you have configured a ruleset or branch protection rule that isn't compatible with {% data variables.copilot.copilot_cloud_agent %}, access to the agent will be blocked. For example, a rule that only allows specific commit authors can prevent {% data variables.copilot.copilot_cloud_agent %} from creating or updating pull requests. If the rule is configured using rulesets, you can add {% data variables.product.prodname_copilot_short %} as a bypass actor to enable access. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository#granting-bypass-permissions-for-your-branch-or-tag-ruleset). +* **{% data variables.copilot.copilot_cloud_agent %} doesn't account for content exclusions**. Content exclusions allow administrators to configure {% data variables.product.prodname_copilot_short %} to ignore certain files. When using {% data variables.copilot.copilot_cloud_agent %}, {% data variables.product.prodname_copilot_short %} will not ignore these files, and will be able to see and update them. See [AUTOTITLE](/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot). +* **{% data variables.copilot.copilot_cloud_agent %} only works with repositories hosted on {% data variables.product.github %}**. If your repository is stored using a different code hosting platform, {% data variables.product.prodname_copilot_short %} won't be able to work on it. + +## Hands-on practice + +Try the [Expand your team with {% data variables.copilot.copilot_cloud_agent %}](https://github.com/skills/expand-your-team-with-copilot/?ref_product=copilot&ref_type=engagement&ref_style=text) Skills exercise for practical experience with {% data variables.copilot.copilot_cloud_agent %}. + +## Further reading + +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent) how-to articles +* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-custom-agents) +* [AUTOTITLE](/copilot/responsible-use/copilot-cloud-agent) diff --git a/content/copilot/concepts/agents/coding-agent/about-custom-agents.md b/content/copilot/concepts/agents/cloud-agent/about-custom-agents.md similarity index 75% rename from content/copilot/concepts/agents/coding-agent/about-custom-agents.md rename to content/copilot/concepts/agents/cloud-agent/about-custom-agents.md index c3dbdfb69f62..5a2cf30f7b88 100644 --- a/content/copilot/concepts/agents/coding-agent/about-custom-agents.md +++ b/content/copilot/concepts/agents/cloud-agent/about-custom-agents.md @@ -7,6 +7,8 @@ versions: category: - Learn about Copilot contentType: concepts +redirect_from: + - /copilot/concepts/agents/coding-agent/about-custom-agents --- {% data reusables.copilot.copilot-cli.custom-agents-about-intro %} @@ -19,8 +21,8 @@ contentType: concepts Once you create {% data variables.copilot.custom_agents_short %}, they become available to: -* **{% data variables.copilot.copilot_coding_agent %} on {% data variables.product.prodname_dotcom_the_website %}**: The agents tab and panel, issue assignment, and pull requests -* **{% data variables.copilot.copilot_coding_agent %} in IDEs**: {% data variables.product.prodname_vscode %}, JetBrains IDEs, Eclipse, and Xcode +* **{% data variables.copilot.copilot_cloud_agent %} on {% data variables.product.prodname_dotcom_the_website %}**: The agents tab and panel, issue assignment, and pull requests +* **{% data variables.copilot.copilot_cloud_agent %} in IDEs**: {% data variables.product.prodname_vscode %}, JetBrains IDEs, Eclipse, and Xcode * **{% data variables.copilot.copilot_cli %}** You can use {% data variables.copilot.agent_profiles %} directly in {% data variables.product.prodname_vscode %}, JetBrains IDEs, Eclipse, and Xcode. Some properties may function differently or be ignored between environments. @@ -31,6 +33,6 @@ For more information on using {% data variables.copilot.custom_agents_short %} i To create your own {% data variables.copilot.custom_agents_short %}, see: -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents) * [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/create-custom-agents-for-cli) * [AUTOTITLE](/copilot/reference/customization-cheat-sheet) diff --git a/content/copilot/concepts/agents/coding-agent/about-hooks.md b/content/copilot/concepts/agents/cloud-agent/about-hooks.md similarity index 92% rename from content/copilot/concepts/agents/coding-agent/about-hooks.md rename to content/copilot/concepts/agents/cloud-agent/about-hooks.md index 5df60ebc0c62..3fb93d93bcdf 100644 --- a/content/copilot/concepts/agents/coding-agent/about-hooks.md +++ b/content/copilot/concepts/agents/cloud-agent/about-hooks.md @@ -2,12 +2,14 @@ title: About hooks shortTitle: Hooks intro: 'Extend and customize {% data variables.product.prodname_copilot %} agent behavior by executing custom shell commands at key points during agent execution.' -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot contentType: concepts category: - Configure Copilot +redirect_from: + - /copilot/concepts/agents/coding-agent/about-hooks --- ## About hooks @@ -24,7 +26,7 @@ Hooks receive detailed information about agent actions via JSON input, enabling Hooks are available for use with: -* {% data variables.copilot.copilot_coding_agent %} on {% data variables.product.github %} +* {% data variables.copilot.copilot_cloud_agent %} on {% data variables.product.github %} * {% data variables.copilot.copilot_cli %} in the terminal ## Types of hooks @@ -160,4 +162,4 @@ To ensure security is maintained when using hooks, keep the following considerat ## Next steps -To start creating hooks, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/use-hooks). +To start creating hooks, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/use-hooks). diff --git a/content/copilot/concepts/agents/cloud-agent/access-management.md b/content/copilot/concepts/agents/cloud-agent/access-management.md new file mode 100644 index 000000000000..27f8ed2ab4b4 --- /dev/null +++ b/content/copilot/concepts/agents/cloud-agent/access-management.md @@ -0,0 +1,61 @@ +--- +title: Managing access to GitHub Copilot cloud agent +shortTitle: Access management +allowTitleToDifferFromFilename: true +intro: Find out about {% data variables.copilot.copilot_cloud_agent %} policies available for {% data variables.copilot.copilot_enterprise %} and {% data variables.copilot.copilot_for_business %}, and about disabling the agent for specific repositories. +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +versions: + feature: copilot +redirect_from: + - /copilot/concepts/agents/coding-agent/access-management + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/enabling-copilot-coding-agent-for-your-personal-repositories + - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent-for-your-personal-repositories + - /copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent + - /copilot/concepts/coding-agent/about-enabling-coding-agent + - /copilot/concepts/coding-agent/enable-coding-agent + - /copilot/concepts/agents/coding-agent/enable-coding-agent + - /copilot/how-tos/agents/copilot-coding-agent/enabling-copilot-coding-agent + - /copilot/concepts/agents/coding-agent/coding-agent-for-business-and-enterprise + - /copilot/concepts/agents/coding-agent/managing-access +contentType: concepts +category: + - Manage Copilot for a team +--- + +> [!NOTE] +> For an introduction to {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). + +## Overview + +{% data reusables.copilot.cloud-agent.what-is %} + +If you are a {% data variables.copilot.copilot_enterprise %} or {% data variables.copilot.copilot_for_business %} subscriber, {% data variables.copilot.copilot_cloud_agent %} is disabled by default and must be enabled by an administrator before it is available for use. + +If you are a {% data variables.copilot.copilot_pro %} or Pro+ subscriber, {% data variables.copilot.copilot_cloud_agent %} is enabled by default. + +Once enabled, you can use {% data variables.copilot.copilot_cloud_agent %} in any repository, provided that an administrator hasn't opted the repository out. + +## {% data variables.copilot.copilot_cloud_agent %} policies for {% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} + +{% data reusables.copilot.cloud-agent.enabling-for-orgs-and-enterprises %} + +## Opting repositories out of {% data variables.copilot.copilot_cloud_agent %} + +By default, users with {% data variables.copilot.copilot_cloud_agent %} enabled can use it in all repositories. + +Enterprise administrators and organization owners (for organization-owned repositories) and users (for user-owned repositories) can opt out repositories and prevent {% data variables.copilot.copilot_cloud_agent %} from being used in those repositories. + +For information on disabling {% data variables.copilot.copilot_cloud_agent %} in some or all repositories owned by an organization, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-cloud-agent). + +For information on disabling {% data variables.copilot.copilot_cloud_agent %} in all repositories owned by an enterprise, see [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/manage-copilot-cloud-agent). + +For information on disabling {% data variables.copilot.copilot_cloud_agent %} in repositories owned by your personal user account, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-copilot-cloud-agent). + +## Further reading + +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp) +* [AUTOTITLE](/copilot/tutorials/cloud-agent/pilot-cloud-agent) diff --git a/content/copilot/concepts/agents/coding-agent/agent-management.md b/content/copilot/concepts/agents/cloud-agent/agent-management.md similarity index 75% rename from content/copilot/concepts/agents/coding-agent/agent-management.md rename to content/copilot/concepts/agents/cloud-agent/agent-management.md index e76be0e66744..ebfe2aeb88ad 100644 --- a/content/copilot/concepts/agents/coding-agent/agent-management.md +++ b/content/copilot/concepts/agents/cloud-agent/agent-management.md @@ -2,10 +2,11 @@ title: About agent management shortTitle: Agent management intro: 'Use one centralized control page to jump between agent sessions, check progress, and stay in control without losing your place.' -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot redirect_from: + - /copilot/concepts/agents/coding-agent/agent-management - /copilot/concepts/agents/coding-agent/managing-agents contentType: concepts category: @@ -21,25 +22,25 @@ Agents bring automation and assistance to every stage of the software developmen Alongside {% data variables.product.prodname_copilot_short %}, you can use {% data variables.product.prodname_anthropic_claude %} and {% data variables.product.prodname_openai_codex %}, giving you more flexibility and choice to find the right agent for a task. See [AUTOTITLE](/copilot/concepts/agents/about-third-party-agents). -Utilizing {% data variables.copilot.custom_agents_short %} you can build out a team of task-specific agents with customized system prompts to handle simpler tasks like writing tests and refactoring, giving you bandwidth to prioritize problem-solving and collaboration. See [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents). +Utilizing {% data variables.copilot.custom_agents_short %} you can build out a team of task-specific agents with customized system prompts to handle simpler tasks like writing tests and refactoring, giving you bandwidth to prioritize problem-solving and collaboration. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-custom-agents). Model choice allows you to choose from a selection of AI models to use with your agents, each with its own particular strengths. See [AUTOTITLE](/copilot/reference/ai-models/supported-models). -To learn more about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-coding-agent). +To learn more about {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). ## Managing agents -{% data reusables.copilot.coding-agent.agent-management-intro %} +{% data reusables.copilot.cloud-agent.agent-management-intro %} From the Agents tab, you can: -* **Kick off new agent tasks**: Select an AI model of your choice, and optionally choose from third-party agents or {% data variables.copilot.custom_agents_short %} best suited for the task. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr). +* **Kick off new agent tasks**: Select an AI model of your choice, and optionally choose from third-party agents or {% data variables.copilot.custom_agents_short %} best suited for the task. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). * **Monitor live session logs**: Once the agent starts working, you can click any agent session to open the session log and follow its progress and thought process in real time. * **Track active sessions**: You can view all active agent sessions that have been started in the repository. -* **Steer agents mid-session**: If you realize you didn't scope a request correctly, or want the agent to use a specific tool or service, you can step in and provide **steering input** without stopping the run. Steering uses **one premium request** per message. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions#steering-a-copilot-session-from-the-agents-tab). +* **Steer agents mid-session**: If you realize you didn't scope a request correctly, or want the agent to use a specific tool or service, you can step in and provide **steering input** without stopping the run. Steering uses **one premium request** per message. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions#steering-a-copilot-session-from-the-agents-tab). * **Open a session in {% data variables.product.prodname_vscode_shortname %} or {% data variables.copilot.copilot_cli %}**: When you want to start working on changes to an agent session in your local development environment, click **{% octicon "vscode" aria-label="VS Code" %} Open in {% data variables.product.prodname_vscode_shortname %}** or **{% octicon "agent" aria-label="Agent" %} Continue in {% data variables.copilot.copilot_cli %}** to bring the session to your local machine. - {% data reusables.copilot.coding-agent.use-latest-vscode %} -* **Review and merge agent code**: Once the agent completes a session, you can jump to the pull request to review the changes, request further improvements, or approve and merge. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs). + {% data reusables.copilot.cloud-agent.use-latest-vscode %} +* **Review and merge agent code**: Once the agent completes a session, you can jump to the pull request to review the changes, request further improvements, or approve and merge. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs). ## Next steps diff --git a/content/copilot/concepts/agents/cloud-agent/index.md b/content/copilot/concepts/agents/cloud-agent/index.md new file mode 100644 index 000000000000..db4f3f1ddbd2 --- /dev/null +++ b/content/copilot/concepts/agents/cloud-agent/index.md @@ -0,0 +1,22 @@ +--- +title: Concepts for GitHub Copilot cloud agent +shortTitle: '{% data variables.copilot.copilot_cloud_agent_short_cap_c %}' +allowTitleToDifferFromFilename: true +intro: Learn how {% data variables.copilot.copilot_cloud_agent %} can carry out research, planning and coding tasks for you, working independently in the same workflow you use yourself. +versions: + feature: copilot +children: + - /about-cloud-agent + - /agent-management + - /about-custom-agents + - /about-hooks + - /access-management + - /mcp-and-cloud-agent + - /risks-and-mitigations +contentType: concepts +redirect_from: + - /copilot/concepts/agents/coding-agent + - /copilot/concepts/coding-agent +--- + +These articles provide an overview of {% data variables.copilot.copilot_cloud_agent %}. For instructions on configuring and using {% data variables.copilot.copilot_cloud_agent %}, see the how-to articles under [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent). diff --git a/content/copilot/concepts/agents/coding-agent/mcp-and-coding-agent.md b/content/copilot/concepts/agents/cloud-agent/mcp-and-cloud-agent.md similarity index 77% rename from content/copilot/concepts/agents/coding-agent/mcp-and-coding-agent.md rename to content/copilot/concepts/agents/cloud-agent/mcp-and-cloud-agent.md index e360f06599af..d2d07d206d6f 100644 --- a/content/copilot/concepts/agents/coding-agent/mcp-and-coding-agent.md +++ b/content/copilot/concepts/agents/cloud-agent/mcp-and-cloud-agent.md @@ -1,12 +1,13 @@ --- title: Model Context Protocol (MCP) and GitHub Copilot cloud agent -shortTitle: MCP and {% data variables.copilot.copilot_coding_agent_short %} +shortTitle: MCP and {% data variables.copilot.copilot_cloud_agent_short %} allowTitleToDifferFromFilename: true -intro: Find out about using the Model Context Protocol (MCP) with {% data variables.copilot.copilot_coding_agent %}. +intro: Find out about using the Model Context Protocol (MCP) with {% data variables.copilot.copilot_cloud_agent %}. versions: feature: copilot contentType: concepts redirect_from: + - /copilot/concepts/agents/coding-agent/mcp-and-coding-agent - /copilot/concepts/coding-agent/mcp-and-coding-agent category: - Integrate Copilot with your tools @@ -14,33 +15,33 @@ category: ## Overview -{% data reusables.copilot.coding-agent.mcp-brief-intro %} +{% data reusables.copilot.cloud-agent.mcp-brief-intro %} The agent can use tools provided by local and remote MCP servers. Some MCP servers are configured by default to provide the best experience for getting started. For more information on MCP, see [the official MCP documentation](https://modelcontextprotocol.io/introduction). For information on some of the currently available MCP servers, see [the MCP servers repository](https://github.com/modelcontextprotocol/servers/tree/main). -{% data reusables.copilot.mcp.coding-agent-limitations %} +{% data reusables.copilot.mcp.cloud-agent-limitations %} ## Default MCP servers -The following MCP servers are configured automatically for {% data variables.copilot.copilot_coding_agent %}: +The following MCP servers are configured automatically for {% data variables.copilot.copilot_cloud_agent %}: * **{% data variables.product.github %}**: The {% data variables.product.github %} MCP server gives {% data variables.product.prodname_copilot_short %} access to {% data variables.product.github %} data like issues and pull requests. To learn more, see [AUTOTITLE](/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server). - * By default, the {% data variables.product.github %} MCP server connects to {% data variables.product.github %} using a specially scoped token that only has read-only access to the current repository. You can customize it to use a different token with broader access. For more details, see [AUTOTITLE](/copilot/how-tos/agents/copilot-coding-agent/extending-copilot-coding-agent-with-mcp#customizing-the-built-in-github-mcp-server). + * By default, the {% data variables.product.github %} MCP server connects to {% data variables.product.github %} using a specially scoped token that only has read-only access to the current repository. You can customize it to use a different token with broader access. For more details, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp#customizing-the-built-in-github-mcp-server). * **Playwright**: The [Playwright MCP server](https://github.com/microsoft/playwright-mcp) gives {% data variables.product.prodname_copilot_short %} access to web pages, including the ability to read, interact and take screenshots. * By default, the Playwright MCP server is only able to access web resources hosted within {% data variables.product.prodname_copilot_short %}'s own environment, accessible on `localhost` or `127.0.0.1`. ## Setting up MCP servers in a repository -Repository administrators can configure MCP servers for use within that repository. This is done via a JSON-formatted configuration that specifies the details of the MCP servers that {% data variables.copilot.copilot_coding_agent %} can use. +Repository administrators can configure MCP servers for use within that repository. This is done via a JSON-formatted configuration that specifies the details of the MCP servers that {% data variables.copilot.copilot_cloud_agent %} can use. -Once MCP servers are configured for use within a repository, the tools specified in the configuration will be available to {% data variables.copilot.copilot_coding_agent %} during each assigned task. +Once MCP servers are configured for use within a repository, the tools specified in the configuration will be available to {% data variables.copilot.copilot_cloud_agent %} during each assigned task. {% data variables.product.prodname_copilot_short %} will use available tools autonomously, and will not ask for approval before use. -For details of how to set up MCP servers for {% data variables.copilot.copilot_coding_agent %} in a repository, see [AUTOTITLE](/copilot/how-tos/agents/copilot-coding-agent/extending-copilot-coding-agent-with-mcp). +For details of how to set up MCP servers for {% data variables.copilot.copilot_cloud_agent %} in a repository, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp). ## MCP servers for {% data variables.copilot.custom_agents_short %} @@ -54,6 +55,6 @@ For more information on configuring MCP servers for {% data variables.copilot.cu * Enabling third-party MCP servers for use may impact the performance of the agent and the quality of the outputs. Review the third-party MCP server thoroughly and ensure that it meets your organization’s requirements. -* By default, {% data variables.copilot.copilot_coding_agent %} does not have access to write MCP server tools. However, some MCP servers do contain such tools. Be sure to review the tools available in the MCP server you want to use. Update the `tools` field in the MCP configuration with only the necessary tooling. +* By default, {% data variables.copilot.copilot_cloud_agent %} does not have access to write MCP server tools. However, some MCP servers do contain such tools. Be sure to review the tools available in the MCP server you want to use. Update the `tools` field in the MCP configuration with only the necessary tooling. * Carefully review the configured MCP servers prior to saving the configuration to ensure the correct servers are configured for use. diff --git a/content/copilot/concepts/agents/cloud-agent/risks-and-mitigations.md b/content/copilot/concepts/agents/cloud-agent/risks-and-mitigations.md new file mode 100644 index 000000000000..26acd416bbb7 --- /dev/null +++ b/content/copilot/concepts/agents/cloud-agent/risks-and-mitigations.md @@ -0,0 +1,61 @@ +--- +title: Risks and mitigations for GitHub Copilot cloud agent +shortTitle: Risks and mitigations +intro: 'How do {% data variables.copilot.copilot_cloud_agent %}''s built-in security protections mitigate known risks?' +versions: + feature: copilot +contentType: concepts +category: + - Learn about Copilot + - Manage Copilot for a team + - Roll Copilot out at scale +redirect_from: + - /copilot/concepts/agents/coding-agent/risks-and-mitigations +--- + +{% data variables.copilot.copilot_cloud_agent %} is an autonomous agent that has access to your code and can push changes to your repository. This entails certain risks. + +Where possible, {% data variables.product.github %} has applied appropriate mitigations. This gives {% data variables.copilot.copilot_cloud_agent %} a strong base of built-in security protections that you can supplement by following best practice guidance. + +## Unvalidated code can introduce vulnerabilities + +{% data reusables.copilot.cloud-agent-validation-tools-intro %} {% data variables.copilot.copilot_cloud_agent %}'s security validation **does not require** a {% data variables.product.prodname_GHAS_cs_or_sp %} license. + +* **{% data variables.product.prodname_codeql %}** is used to identify code security issues. +* Newly introduced dependencies are checked against the **{% data variables.product.prodname_advisory_database %}** for malware advisories, and for any CVSS-rated High or Critical vulnerabilities. +* **{% data variables.product.prodname_secret_scanning_caps %}** is used to detect sensitive information such as API keys, tokens, and other secrets. +* Details about the analysis performed and the actions taken by {% data variables.copilot.copilot_cloud_agent %} can be reviewed in the session log. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions). + +Optionally, you can disable one or more of the code quality and security validation tools used by {% data variables.copilot.copilot_cloud_agent %}. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/configuring-agent-settings). + +## {% data variables.copilot.copilot_cloud_agent %} can push code changes to your repository + +To mitigate this risk, {% data variables.product.github %}: + +* **Limits who can trigger the agent.** Only users with write access to the repository can trigger {% data variables.copilot.copilot_cloud_agent %} to work. Comments from users without write access are never presented to the agent. +* **Limits the branch the agent can push to.** {% data variables.copilot.copilot_cloud_agent %} only has the ability to push to a single branch. When the agent is triggered by mentioning `@copilot` on an existing pull request, {% data variables.product.prodname_copilot_short %} has write access to the pull request's branch. In other cases, a new `copilot/` branch is created for {% data variables.product.prodname_copilot_short %}, and the agent can only push to that branch. The agent is also subject to any branch protections and required checks for the working repository. +* **Limits the agent's credentials.** {% data variables.copilot.copilot_cloud_agent %} can only perform simple push operations. It cannot directly run `git push` or other Git commands. +* **Requires human review before merging.** Draft pull requests created by {% data variables.copilot.copilot_cloud_agent %} must be reviewed and merged by a human. {% data variables.copilot.copilot_cloud_agent %} cannot mark its pull requests as "Ready for review" and cannot approve or merge a pull request. +* **Restricts {% data variables.product.prodname_actions %} workflow runs.** By default, workflows are not triggered until {% data variables.copilot.copilot_cloud_agent %}'s code is reviewed and a user with write access to the repository clicks the **Approve and run workflows** button. Optionally, you can configure {% data variables.product.prodname_copilot_short %} to allow workflows to run automatically. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs#managing-github-actions-workflow-runs). +* **Prevents the user who asked {% data variables.copilot.copilot_cloud_agent %} to create a pull request from approving it.** This maintains the expected controls in the "Required approvals" rule and branch protection. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets). + +## {% data variables.copilot.copilot_cloud_agent %} has access to sensitive information + +{% data variables.copilot.copilot_cloud_agent %} has access to code and other sensitive information, and could leak it, either accidentally or due to malicious user input. + +To mitigate this risk, {% data variables.product.github %} **restricts {% data variables.copilot.copilot_cloud_agent %}'s access to the internet**. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall). + +## AI prompts can be vulnerable to injection + +Users can include hidden messages in issues assigned to {% data variables.copilot.copilot_cloud_agent %} or comments left for {% data variables.copilot.copilot_cloud_agent %} as a form of [prompt injection](https://genai.owasp.org/llmrisk/llm01-prompt-injection/). + +To mitigate this risk, {% data variables.product.github %} **filters hidden characters before passing user input to {% data variables.copilot.copilot_cloud_agent %}**: For example, text entered as an HTML comment in an issue or pull request comment is not passed to {% data variables.copilot.copilot_cloud_agent %}. + +## Administrators can lose sight of agents' work + +To mitigate this risk, {% data variables.copilot.copilot_cloud_agent %} is designed to be auditable and traceable. + +* {% data variables.copilot.copilot_cloud_agent %}'s commits are authored by {% data variables.product.prodname_copilot_short %}, with the developer who assigned the issue or requested the change to the pull request marked as the co-author. This makes it easier to identify code generated by {% data variables.copilot.copilot_cloud_agent %} and who started the task. +* {% data variables.copilot.copilot_cloud_agent %}'s commits are signed, so they appear as "Verified" on {% data variables.product.github %}. This provides confidence that the commits were made by {% data variables.copilot.copilot_cloud_agent %} and have not been altered. +* Session logs and audit log events are available to administrators. +* The commit message for each agent-authored commit includes a link to the agent session logs, for code review and auditing. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions). diff --git a/content/copilot/concepts/agents/code-review.md b/content/copilot/concepts/agents/code-review.md index 3ac72df94e2a..3e254ac94e3b 100644 --- a/content/copilot/concepts/agents/code-review.md +++ b/content/copilot/concepts/agents/code-review.md @@ -89,7 +89,7 @@ For more information, see [AUTOTITLE](/copilot/reference/review-excluded-files). {% data variables.copilot.copilot_code-review_short %} utilizes agentic capabilities to extend its functionality. * **Full project context gathering**. This provides more specific, accurate, and contextually aware code reviews. This capability analyzes your entire repository to better understand the context of code changes. Full project context gathering is generally available. -* **The ability to pass suggestions to {% data variables.copilot.copilot_coding_agent %}**. This automates creating a new pull request against your branch with the suggested fixes applied. Passing suggestions to {% data variables.copilot.copilot_coding_agent %} is in public preview and subject to change. +* **The ability to pass suggestions to {% data variables.copilot.copilot_cloud_agent %}**. This automates creating a new pull request against your branch with the suggested fixes applied. Passing suggestions to {% data variables.copilot.copilot_cloud_agent %} is in public preview and subject to change. These capabilities are enabled automatically for {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plans. diff --git a/content/copilot/concepts/agents/coding-agent/about-coding-agent.md b/content/copilot/concepts/agents/coding-agent/about-coding-agent.md deleted file mode 100644 index b0ef38de3882..000000000000 --- a/content/copilot/concepts/agents/coding-agent/about-coding-agent.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -title: About GitHub Copilot cloud agent -shortTitle: About cloud agent -allowTitleToDifferFromFilename: true -intro: '{% data variables.product.prodname_copilot_short %} can research a repository, create an implementation plan, and make code changes on a branch. You can review the diff, iterate, and create a pull request when you''re ready.' -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' -versions: - feature: copilot -redirect_from: - - /copilot/concepts/about-assigning-tasks-to-copilot - - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/about-assigning-tasks-to-copilot - - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/about-assigning-issues-to-copilot - - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/about-assigning-tasks-to-copilot - - /copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot - - /copilot/concepts/about-copilot-coding-agent - - /copilot/concepts/coding-agent/about-copilot-coding-agent - - /copilot/concepts/coding-agent/coding-agent -contentType: concepts -category: - - Learn about Copilot ---- - - -## Overview of {% data variables.copilot.copilot_cloud_agent_tmp %} - -With {% data variables.copilot.copilot_coding_agent %}, {% data variables.product.prodname_copilot %} can work independently in the background to complete tasks, just like a human developer. - -{% data variables.copilot.copilot_coding_agent %} can: - -* Research a repository -* Create implementation plans -* Fix bugs -* Implement incremental new features -* Improve test coverage -* Update documentation -* Address technical debt -* Resolve merge conflicts - -When you delegate tasks to {% data variables.copilot.copilot_coding_agent %}, you can: - -* Use the agents panel or other agents entry points on {% data variables.product.prodname_dotcom_the_website %} to have {% data variables.product.prodname_copilot_short %} research, plan, and make code changes on a branch, then iterate before creating a pull request. You can also specify in your prompt that you want a pull request created right away. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/research-plan-iterate). -* Ask {% data variables.product.prodname_copilot_short %} to open a new pull request from other entry points, including {% data variables.product.prodname_github_issues %} and {% data variables.product.prodname_vscode %}. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr). -* Mention `@copilot` in a comment on an existing pull request to ask it to make changes. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/make-changes-to-an-existing-pr). -{% ifversion security-campaigns-assign-to-cca %}* Assign security alerts to {% data variables.product.prodname_copilot_short %} from security campaigns. See [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign#assigning-alerts-to-copilot-coding-agent).{% endif %} - -{% data variables.copilot.copilot_coding_agent %} will evaluate the task it has been assigned based on the prompt you give it. - -While working on a coding task, {% data variables.copilot.copilot_coding_agent %} has access to its own ephemeral development environment, powered by {% data variables.product.prodname_actions %}, where it can explore your code, make changes, execute automated tests and linters and more. - -> [!NOTE] Deep research, planning, and iterating on code changes before creating a pull request are only available with {% data variables.copilot.copilot_coding_agent %} on {% data variables.product.prodname_dotcom_the_website %}. {% data variables.copilot.copilot_coding_agent_short_cap_c %} integrations (such as Azure Boards, JIRA, Linear, Slack, or Teams) only support creating a pull request directly. - -### Benefits over traditional AI workflows - -When used effectively, {% data variables.copilot.copilot_coding_agent %} offers productivity benefits over traditional AI assistants in IDEs: - -* With **AI assistants in IDEs**, coding happens **locally**. Individual developers pair in **synchronous** sessions with the AI assistant. Decisions made during the session are **untracked** and lost to time unless committed. Although the assistant helps write code, the developer still has a lot of **manual steps** to do: create the branch, write commit messages, push the changes, open the PR, write the PR description, get a review, iterate in the IDE, and repeat. These steps take time and effort that may be hard to justify for simple or routine issues. - -* With **{% data variables.copilot.copilot_coding_agent %}**, all coding and iterating happens **on {% data variables.product.github %}**. You can ask {% data variables.product.prodname_copilot_short %} to **research** a repository, **create a plan**, and **make code changes** on a branch—all before opening a pull request. You can create multiple {% data variables.copilot.custom_agents_short %} that specialize in different types of tasks. {% data variables.product.prodname_copilot_short %} **automates** branch creation, commit message writing, and pushing. Developers let the agents **work in the background** and then chooses to **create a pull request** when ready. Working on {% data variables.product.github %} adds **transparency**, with every step happening in a commit and being viewable in logs, and opens up **collaboration** opportunities for the entire team. - -## {% data variables.copilot.copilot_coding_agent %} versus agent mode - -{% data variables.copilot.copilot_coding_agent %} is distinct from the "agent mode" feature available in your IDE. {% data variables.copilot.copilot_coding_agent %} works autonomously in a {% data variables.product.prodname_actions %}-powered environment to complete development tasks assigned through {% data variables.product.github %} issues or {% data variables.copilot.copilot_chat %} prompts. It can research a repository, create a plan, make code changes on a branch, and optionally open a pull request. In contrast, agent mode in your IDE makes autonomous edits directly in your local development environment. For more information about agent mode, see [AUTOTITLE](/copilot/using-github-copilot/copilot-chat/asking-github-copilot-questions-in-your-ide). - -## Streamlining software development with {% data variables.copilot.copilot_coding_agent %} - -Assigning tasks to {% data variables.copilot.copilot_coding_agent %} can enhance your software development workflow. - -For example, you can assign {% data variables.copilot.copilot_coding_agent %} to straightforward issues on your backlog by selecting "{% data variables.product.prodname_copilot_short %}" as the assignee. This allows you to spend less time on these issues and more time on more complex or interesting work, or work that requires a high degree of creative thinking. {% data variables.copilot.copilot_coding_agent %} can work on "nice to have" issues that improve the quality of your codebase or product, but often remain on the backlog while you focus on more urgent work. - -Having {% data variables.copilot.copilot_coding_agent %} as an additional coding resource also allows you to start tasks that you might not have otherwise started due to lack of resources. For example, you might create issues to refactor code or add more logging, and then immediately assign these to {% data variables.product.prodname_copilot_short %}. - -You can also use {% data variables.copilot.copilot_coding_agent %} to research a repository and create a plan before any code is written, helping you understand how a codebase works or agree on an approach before committing to changes. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/research-plan-iterate). - -{% data variables.copilot.copilot_coding_agent %} can start a task, which you then pick up and continue working on yourself. By assigning the initial work to {% data variables.product.prodname_copilot_short %}, you free up time that you would otherwise have spent doing repetitive tasks, such as setting up the scaffolding for a new project. - -You can create specialized {% data variables.copilot.custom_agents_short %} for different tasks. For example, you might create a {% data variables.copilot.copilot_custom_agent_short %} specialized for frontend development that focuses on React components and styling, a documentation agent that excels at writing and updating technical documentation, or a testing agent that specializes in generating comprehensive unit tests. Each {% data variables.copilot.copilot_custom_agent_short %} can be tailored with specific prompts and tools suited to its particular task. - -## Measuring pull request outcomes for {% data variables.copilot.copilot_coding_agent %} - -Enterprise administrators and organization owners can use {% data variables.product.prodname_copilot_short %} usage metrics to analyze pull request outcomes for pull requests created by {% data variables.copilot.copilot_coding_agent %}. - -The {% data variables.product.prodname_copilot_short %} usage metrics APIs include pull request lifecycle metrics such as: - -* The total number of pull requests created and merged -* The number of pull requests created by {% data variables.copilot.copilot_coding_agent %} that have been merged -* Median time to merge for merged pull requests, including pull requests created by {% data variables.copilot.copilot_coding_agent %} - -These metrics can help you track adoption of {% data variables.copilot.copilot_coding_agent %} and monitor changes in pull request throughput and time to merge over time. See [AUTOTITLE](/copilot/concepts/copilot-usage-metrics/copilot-metrics). - -## Integrating {% data variables.copilot.copilot_coding_agent %} with third-party tools - -You can also invoke {% data variables.copilot.copilot_coding_agent %} from external tools, allowing you to assign tasks to {% data variables.product.prodname_copilot_short %}, provide context, and open pull requests without leaving your workflow. See [AUTOTITLE](/copilot/concepts/tools/about-copilot-integrations) - -## Making {% data variables.copilot.copilot_coding_agent %} available - -Before you can assign tasks to {% data variables.copilot.copilot_coding_agent %}, it must be enabled. - -{% data variables.copilot.copilot_coding_agent %} is available with the {% data variables.copilot.copilot_pro %}, {% data variables.copilot.copilot_pro_plus %}, {% data variables.copilot.copilot_for_business %} and {% data variables.copilot.copilot_enterprise %} plans. - -If you are a {% data variables.copilot.copilot_for_business %} or {% data variables.copilot.copilot_enterprise %} subscriber, an administrator must enable the relevant policy before you can use the agent. - -Repository owners can choose to opt out some or all repositories from {% data variables.copilot.copilot_coding_agent %}. - -For more information, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/managing-access). - -## AI models for {% data variables.copilot.copilot_coding_agent %} - -Depending on how you start your {% data variables.copilot.copilot_coding_agent %} task, you may be able to select the model used by {% data variables.copilot.copilot_coding_agent %}. You may find that different models perform better, or provide more useful responses, depending on the type of tasks you give {% data variables.product.prodname_copilot_short %}. - -For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/changing-the-ai-model). - -## Enhancing {% data variables.copilot.copilot_coding_agent %}'s knowledge of a repository - -The more {% data variables.copilot.copilot_coding_agent %} knows about the code in your repository, the tools you use, and your coding standards and practices, the more effective it will become. There are two ways you can enhance {% data variables.copilot.copilot_coding_agent %}'s knowledge of a repository. - -* **Custom instructions** - - These are short, natural‑language statements that you write and store as one or more files in a repository. If you are the owner of an organization on {% data variables.product.github %} you can also define custom instructions in the settings for your organization. For more information, see [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=webui#about-repository-custom-instructions). - -* **{% data variables.copilot.copilot_memory %}** ({% data variables.release-phases.public_preview %}) - - If you have a {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plan, you can enable {% data variables.copilot.copilot_memory %}. This allows {% data variables.product.prodname_copilot_short %} to store useful details it has worked out for itself about a repository. {% data variables.copilot.copilot_coding_agent %} can then use this information when it is working in that repository. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-memory). - -## {% data variables.copilot.copilot_coding_agent %} usage costs - -{% data variables.copilot.copilot_coding_agent %} uses {% data variables.product.prodname_actions %} minutes and {% data variables.product.prodname_copilot_short %} premium requests. - -Within your monthly usage allowance for {% data variables.product.prodname_actions %} and premium requests, you can ask {% data variables.copilot.copilot_coding_agent %} to work on coding tasks without incurring any additional costs. - -For more information, see [AUTOTITLE](/billing/managing-billing-for-your-products/managing-billing-for-github-copilot/about-billing-for-github-copilot#allowance-usage-for-copilot-coding-agent). - -## Customizing {% data variables.copilot.copilot_coding_agent %} - -You can customize {% data variables.copilot.copilot_coding_agent %} in a number of ways: - -* **Custom instructions**: Custom instructions allow you to give {% data variables.product.prodname_copilot_short %} additional context on your project and how to build, test and validate its changes. For more information, see [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions). -* **Model Context Protocol (MCP) servers**: MCP servers allow you to give {% data variables.product.prodname_copilot_short %} access to different data sources and tools. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp). -* **{% data variables.copilot.custom_agents_caps_short %}**: {% data variables.copilot.custom_agents_caps_short %} allow you to create different specialized versions of {% data variables.product.prodname_copilot_short %} for different tasks. For example, you could customize {% data variables.product.prodname_copilot_short %} to be an expert frontend engineer following your team's guidelines. For more information, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents). -* **Hooks**: Hooks allow you to execute custom shell commands at key points during agent execution, enabling you to add validation, logging, security scanning, or workflow automation. For more information, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-hooks). -* **Skills**: Skills allow you to enhance the ability of {% data variables.product.prodname_copilot_short %} to perform specialized tasks with instructions, scripts, and resources. For more information, see [AUTOTITLE](/copilot/concepts/agents/about-agent-skills). - -## Limitations of {% data variables.copilot.copilot_coding_agent %} - -{% data variables.copilot.copilot_coding_agent %} has certain limitations in its software development workflow and compatibility with other features. - -### Limitations in {% data variables.copilot.copilot_coding_agent %}'s software development workflow - -* **{% data variables.product.prodname_copilot_short %} can only make changes in the repository specified when you start a task**. {% data variables.product.prodname_copilot_short %} cannot make changes across multiple repositories in one run. -* **By default, {% data variables.product.prodname_copilot_short %} can only access context in the repository specified when you start a task**. The {% data variables.product.prodname_copilot_short %} MCP server is configured by default to allow {% data variables.product.prodname_copilot_short %} to access context (for example issues and historic pull requests) in the repository where it is working. You can, however, configure broader access. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/extending-copilot-coding-agent-with-mcp). -* **{% data variables.product.prodname_copilot_short %} can only work on one branch at a time** and can open exactly one pull request to address each task it is assigned. - -### Limitations in {% data variables.copilot.copilot_coding_agent %}'s compatibility with other features - -* **{% data variables.product.prodname_copilot_short %} isn't able to comply with certain rules that may be configured for your repository**. If you have configured a ruleset or branch protection rule that isn't compatible with {% data variables.copilot.copilot_coding_agent %}, access to the agent will be blocked. For example, a rule that only allows specific commit authors can prevent {% data variables.copilot.copilot_coding_agent %} from creating or updating pull requests. If the rule is configured using rulesets, you can add {% data variables.product.prodname_copilot_short %} as a bypass actor to enable access. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository#granting-bypass-permissions-for-your-branch-or-tag-ruleset). -* **{% data variables.copilot.copilot_coding_agent %} doesn't account for content exclusions**. Content exclusions allow administrators to configure {% data variables.product.prodname_copilot_short %} to ignore certain files. When using {% data variables.copilot.copilot_coding_agent %}, {% data variables.product.prodname_copilot_short %} will not ignore these files, and will be able to see and update them. See [AUTOTITLE](/copilot/managing-copilot/configuring-and-auditing-content-exclusion/excluding-content-from-github-copilot). -* **{% data variables.copilot.copilot_coding_agent %} only works with repositories hosted on {% data variables.product.github %}**. If your repository is stored using a different code hosting platform, {% data variables.product.prodname_copilot_short %} won't be able to work on it. - -## Hands-on practice - -Try the [Expand your team with {% data variables.copilot.copilot_coding_agent %}](https://github.com/skills/expand-your-team-with-copilot/?ref_product=copilot&ref_type=engagement&ref_style=text) Skills exercise for practical experience with {% data variables.copilot.copilot_coding_agent %}. - -## Further reading - -* [AUTOTITLE](/copilot/using-github-copilot/coding-agent) how-to articles -* [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents) -* [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-copilot-coding-agent-on-githubcom) diff --git a/content/copilot/concepts/agents/coding-agent/access-management.md b/content/copilot/concepts/agents/coding-agent/access-management.md deleted file mode 100644 index 2fd0a7cb6e4b..000000000000 --- a/content/copilot/concepts/agents/coding-agent/access-management.md +++ /dev/null @@ -1,60 +0,0 @@ ---- -title: Managing access to GitHub Copilot cloud agent -shortTitle: Access management -allowTitleToDifferFromFilename: true -intro: Find out about {% data variables.copilot.copilot_coding_agent %} policies available for {% data variables.copilot.copilot_enterprise %} and {% data variables.copilot.copilot_for_business %}, and about disabling the agent for specific repositories. -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' -versions: - feature: copilot -redirect_from: - - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent - - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/enabling-copilot-coding-agent-for-your-personal-repositories - - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent-for-your-personal-repositories - - /copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent - - /copilot/concepts/coding-agent/about-enabling-coding-agent - - /copilot/concepts/coding-agent/enable-coding-agent - - /copilot/concepts/agents/coding-agent/enable-coding-agent - - /copilot/how-tos/agents/copilot-coding-agent/enabling-copilot-coding-agent - - /copilot/concepts/agents/coding-agent/coding-agent-for-business-and-enterprise - - /copilot/concepts/agents/coding-agent/managing-access -contentType: concepts -category: - - Manage Copilot for a team ---- - -> [!NOTE] -> For an introduction to {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent). - -## Overview - -{% data reusables.copilot.coding-agent.what-is %} - -If you are a {% data variables.copilot.copilot_enterprise %} or {% data variables.copilot.copilot_for_business %} subscriber, {% data variables.copilot.copilot_coding_agent %} is disabled by default and must be enabled by an administrator before it is available for use. - -If you are a {% data variables.copilot.copilot_pro %} or Pro+ subscriber, {% data variables.copilot.copilot_coding_agent %} is enabled by default. - -Once enabled, you can use {% data variables.copilot.copilot_coding_agent %} in any repository, provided that an administrator hasn't opted the repository out. - -## {% data variables.copilot.copilot_coding_agent %} policies for {% data variables.copilot.copilot_business_short %} and {% data variables.copilot.copilot_enterprise_short %} - -{% data reusables.copilot.coding-agent.enabling-for-orgs-and-enterprises %} - -## Opting repositories out of {% data variables.copilot.copilot_coding_agent %} - -By default, users with {% data variables.copilot.copilot_coding_agent %} enabled can use it in all repositories. - -Enterprise administrators and organization owners (for organization-owned repositories) and users (for user-owned repositories) can opt out repositories and prevent {% data variables.copilot.copilot_coding_agent %} from being used in those repositories. - -For information on disabling {% data variables.copilot.copilot_coding_agent %} in some or all repositories owned by an organization, see [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/adding-copilot-coding-agent-to-organization). - -For information on disabling {% data variables.copilot.copilot_coding_agent %} in all repositories owned by an enterprise, see [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-copilot-coding-agent-in-your-enterprise). - -For information on disabling {% data variables.copilot.copilot_coding_agent %} in repositories owned by your personal user account, see [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-copilot-coding-agent). - -## Further reading - -* [AUTOTITLE](/copilot/using-github-copilot/coding-agent) -* [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent) -* [AUTOTITLE](/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent) -* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/extending-copilot-coding-agent-with-mcp) -* [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org) diff --git a/content/copilot/concepts/agents/coding-agent/index.md b/content/copilot/concepts/agents/coding-agent/index.md deleted file mode 100644 index 86b48eef94e9..000000000000 --- a/content/copilot/concepts/agents/coding-agent/index.md +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: Concepts for GitHub Copilot cloud agent -shortTitle: '{% data variables.copilot.copilot_coding_agent_short_cap_c %}' -allowTitleToDifferFromFilename: true -intro: Learn how {% data variables.copilot.copilot_coding_agent %} can carry out research, planning and coding tasks for you, working independently in the same workflow you use yourself. -versions: - feature: copilot -children: - - /about-coding-agent - - /agent-management - - /about-custom-agents - - /about-hooks - - /access-management - - /mcp-and-coding-agent - - /risks-and-mitigations -contentType: concepts -redirect_from: - - /copilot/concepts/coding-agent ---- - -These articles provide an overview of {% data variables.copilot.copilot_coding_agent %}. For instructions on configuring and using {% data variables.copilot.copilot_coding_agent %}, see the how-to articles under [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent). diff --git a/content/copilot/concepts/agents/coding-agent/risks-and-mitigations.md b/content/copilot/concepts/agents/coding-agent/risks-and-mitigations.md deleted file mode 100644 index 5c8296182521..000000000000 --- a/content/copilot/concepts/agents/coding-agent/risks-and-mitigations.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Risks and mitigations for GitHub Copilot cloud agent -shortTitle: Risks and mitigations -intro: 'How do {% data variables.copilot.copilot_coding_agent %}''s built-in security protections mitigate known risks?' -versions: - feature: copilot -contentType: concepts -category: - - Learn about Copilot - - Manage Copilot for a team - - Roll Copilot out at scale ---- - -{% data variables.copilot.copilot_coding_agent %} is an autonomous agent that has access to your code and can push changes to your repository. This entails certain risks. - -Where possible, {% data variables.product.github %} has applied appropriate mitigations. This gives {% data variables.copilot.copilot_coding_agent %} a strong base of built-in security protections that you can supplement by following best practice guidance. - -## Unvalidated code can introduce vulnerabilities - -{% data reusables.copilot.coding-agent-validation-tools-intro %} {% data variables.copilot.copilot_coding_agent %}'s security validation **does not require** a {% data variables.product.prodname_GHAS_cs_or_sp %} license. - -* **{% data variables.product.prodname_codeql %}** is used to identify code security issues. -* Newly introduced dependencies are checked against the **{% data variables.product.prodname_advisory_database %}** for malware advisories, and for any CVSS-rated High or Critical vulnerabilities. -* **{% data variables.product.prodname_secret_scanning_caps %}** is used to detect sensitive information such as API keys, tokens, and other secrets. -* Details about the analysis performed and the actions taken by {% data variables.copilot.copilot_coding_agent %} can be reviewed in the session log. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions). - -Optionally, you can disable one or more of the code quality and security validation tools used by {% data variables.copilot.copilot_coding_agent %}. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/configuring-agent-settings). - -## {% data variables.copilot.copilot_coding_agent %} can push code changes to your repository - -To mitigate this risk, {% data variables.product.github %}: - -* **Limits who can trigger the agent.** Only users with write access to the repository can trigger {% data variables.copilot.copilot_coding_agent %} to work. Comments from users without write access are never presented to the agent. -* **Limits the branch the agent can push to.** {% data variables.copilot.copilot_coding_agent %} only has the ability to push to a single branch. When the agent is triggered by mentioning `@copilot` on an existing pull request, {% data variables.product.prodname_copilot_short %} has write access to the pull request's branch. In other cases, a new `copilot/` branch is created for {% data variables.product.prodname_copilot_short %}, and the agent can only push to that branch. The agent is also subject to any branch protections and required checks for the working repository. -* **Limits the agent's credentials.** {% data variables.copilot.copilot_coding_agent %} can only perform simple push operations. It cannot directly run `git push` or other Git commands. -* **Requires human review before merging.** Draft pull requests created by {% data variables.copilot.copilot_coding_agent %} must be reviewed and merged by a human. {% data variables.copilot.copilot_coding_agent %} cannot mark its pull requests as "Ready for review" and cannot approve or merge a pull request. -* **Restricts {% data variables.product.prodname_actions %} workflow runs.** By default, workflows are not triggered until {% data variables.copilot.copilot_coding_agent %}'s code is reviewed and a user with write access to the repository clicks the **Approve and run workflows** button. Optionally, you can configure {% data variables.product.prodname_copilot_short %} to allow workflows to run automatically. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs#managing-github-actions-workflow-runs). -* **Prevents the user who asked {% data variables.copilot.copilot_coding_agent %} to create a pull request from approving it.** This maintains the expected controls in the "Required approvals" rule and branch protection. See [AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets). - -## {% data variables.copilot.copilot_coding_agent %} has access to sensitive information - -{% data variables.copilot.copilot_coding_agent %} has access to code and other sensitive information, and could leak it, either accidentally or due to malicious user input. - -To mitigate this risk, {% data variables.product.github %} **restricts {% data variables.copilot.copilot_coding_agent %}'s access to the internet**. See [AUTOTITLE](/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent). - -## AI prompts can be vulnerable to injection - -Users can include hidden messages in issues assigned to {% data variables.copilot.copilot_coding_agent %} or comments left for {% data variables.copilot.copilot_coding_agent %} as a form of [prompt injection](https://genai.owasp.org/llmrisk/llm01-prompt-injection/). - -To mitigate this risk, {% data variables.product.github %} **filters hidden characters before passing user input to {% data variables.copilot.copilot_coding_agent %}**: For example, text entered as an HTML comment in an issue or pull request comment is not passed to {% data variables.copilot.copilot_coding_agent %}. - -## Administrators can lose sight of agents' work - -To mitigate this risk, {% data variables.copilot.copilot_coding_agent %} is designed to be auditable and traceable. - -* {% data variables.copilot.copilot_coding_agent %}'s commits are authored by {% data variables.product.prodname_copilot_short %}, with the developer who assigned the issue or requested the change to the pull request marked as the co-author. This makes it easier to identify code generated by {% data variables.copilot.copilot_coding_agent %} and who started the task. -* Session logs and audit log events are available to administrators. -* The commit message for each agent-authored commit includes a link to the agent session logs, for code review and auditing. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions). -* {% data variables.copilot.copilot_coding_agent %}'s commits are signed, so they appear as "Verified" on {% data variables.product.github %}. This provides confidence that the commits were made by {% data variables.copilot.copilot_coding_agent %} and have not been altered. diff --git a/content/copilot/concepts/agents/copilot-cli/about-copilot-cli.md b/content/copilot/concepts/agents/copilot-cli/about-copilot-cli.md index edff9d8c0931..30968d22d31d 100644 --- a/content/copilot/concepts/agents/copilot-cli/about-copilot-cli.md +++ b/content/copilot/concepts/agents/copilot-cli/about-copilot-cli.md @@ -172,7 +172,7 @@ You can customize {% data variables.copilot.copilot_cli %} in a number of ways: * **Custom instructions**: Custom instructions allow you to give {% data variables.product.prodname_copilot_short %} additional context on your project and how to build, test and validate its changes. All custom instruction files now combine instead of using priority-based fallbacks. For more information, see [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-custom-instructions). * **Model Context Protocol (MCP) servers**: MCP servers allow you to give {% data variables.product.prodname_copilot_short %} access to different data sources and tools. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli#add-an-mcp-server). * **{% data variables.copilot.custom_agents_caps_short %}**: {% data variables.copilot.custom_agents_caps_short %} allow you to create different specialized versions of {% data variables.product.prodname_copilot_short %} for different tasks. For example, you could customize {% data variables.product.prodname_copilot_short %} to be an expert frontend engineer following your team's guidelines. {% data variables.copilot.copilot_cli %} includes specialized {% data variables.copilot.custom_agents_short %} that it automatically delegates common tasks to. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents). -* **Hooks**: Hooks allow you to execute custom shell commands at key points during agent execution, enabling you to add validation, logging, security scanning, or workflow automation. See [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-hooks). +* **Hooks**: Hooks allow you to execute custom shell commands at key points during agent execution, enabling you to add validation, logging, security scanning, or workflow automation. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-hooks). * **Skills**: Skills allow you to enhance the ability of {% data variables.product.prodname_copilot_short %} to perform specialized tasks with instructions, scripts, and resources. For more information, see [AUTOTITLE](/copilot/concepts/agents/about-agent-skills). * **{% data variables.copilot.copilot_memory %}**: {% data variables.copilot.copilot_memory %} allows {% data variables.product.prodname_copilot_short %} to build a persistent understanding of your repository by storing "memories", which are pieces of information about coding conventions, patterns, and preferences that {% data variables.product.prodname_copilot_short %} deduces as it works. This reduces the need to repeatedly explain context in your prompts and makes future sessions more productive. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-memory). diff --git a/content/copilot/concepts/agents/copilot-memory.md b/content/copilot/concepts/agents/copilot-memory.md index 5c8f156d9150..57cc0af4369f 100644 --- a/content/copilot/concepts/agents/copilot-memory.md +++ b/content/copilot/concepts/agents/copilot-memory.md @@ -25,7 +25,7 @@ Memories are tightly scoped pieces of information about a repository, that are d * Repository-specific. * Only created in response to {% data variables.product.prodname_copilot_short %} activity initiated by users who have had {% data variables.copilot.copilot_memory %} enabled. -Memories created by one part of {% data variables.product.prodname_copilot_short %} can be used by another part of {% data variables.product.prodname_copilot_short %}. So, for example, if {% data variables.copilot.copilot_coding_agent %} discovers how your repository handles database connections, {% data variables.copilot.copilot_code-review_short %} can later apply that knowledge to spot inconsistent patterns in a pull request it is reviewing. Similarly, if {% data variables.copilot.copilot_code-review_short %} learns about settings that must stay synchronized in two separate files, then {% data variables.copilot.copilot_coding_agent %} will know that if it alters the settings in one of those files it must update the other file accordingly. +Memories created by one part of {% data variables.product.prodname_copilot_short %} can be used by another part of {% data variables.product.prodname_copilot_short %}. So, for example, if {% data variables.copilot.copilot_cloud_agent %} discovers how your repository handles database connections, {% data variables.copilot.copilot_code-review_short %} can later apply that knowledge to spot inconsistent patterns in a pull request it is reviewing. Similarly, if {% data variables.copilot.copilot_code-review_short %} learns about settings that must stay synchronized in two separate files, then {% data variables.copilot.copilot_cloud_agent %} will know that if it alters the settings in one of those files it must update the other file accordingly. ## Benefits of using {% data variables.copilot.copilot_memory %} @@ -40,7 +40,7 @@ By building and maintaining a persistent, repository-level memory, {% data varia ## Where is {% data variables.copilot.copilot_memory %} used? -Currently {% data variables.copilot.copilot_memory %} is used by {% data variables.copilot.copilot_coding_agent %} and {% data variables.copilot.copilot_code-review_short %} when these features are working on pull requests on the {% data variables.product.github %} website, and by {% data variables.copilot.copilot_cli_short %}. Memories are only created and used by {% data variables.product.prodname_copilot_short %} when {% data variables.copilot.copilot_memory %} has been enabled for the user initiating the {% data variables.product.prodname_copilot_short %} operation. +Currently {% data variables.copilot.copilot_memory %} is used by {% data variables.copilot.copilot_cloud_agent %} and {% data variables.copilot.copilot_code-review_short %} when these features are working on pull requests on the {% data variables.product.github %} website, and by {% data variables.copilot.copilot_cli_short %}. Memories are only created and used by {% data variables.product.prodname_copilot_short %} when {% data variables.copilot.copilot_memory %} has been enabled for the user initiating the {% data variables.product.prodname_copilot_short %} operation. Agentic memory will be extended to other parts of {% data variables.product.prodname_copilot_short %}, and for personal and organizational scopes, in future releases. diff --git a/content/copilot/concepts/agents/enterprise-management.md b/content/copilot/concepts/agents/enterprise-management.md index fd3a63b66038..2e84292d0d8d 100644 --- a/content/copilot/concepts/agents/enterprise-management.md +++ b/content/copilot/concepts/agents/enterprise-management.md @@ -12,29 +12,29 @@ category: ## Overview The AI Controls view provides a centralized platform where you can manage and monitor AI policies and agents across your enterprise. From the "Agents" page, you can: -* Manage the enterprise-level availability of agents like {% data variables.copilot.copilot_coding_agent %}, {% data variables.copilot.copilot_code-review_short %}, and {% data variables.copilot.copilot_custom_agents %} +* Manage the enterprise-level availability of agents like {% data variables.copilot.copilot_cloud_agent %}, {% data variables.copilot.copilot_code-review_short %}, and {% data variables.copilot.copilot_custom_agents %} * Control who can manage your enterprise-level {% data variables.copilot.custom_agents_short %} * View and filter a list of agent sessions in your enterprise over the last 24 hours * Find a detailed record of agentic audit log events ## {% data variables.copilot.copilot_custom_agents %} -{% data variables.copilot.copilot_custom_agents %} are specialized versions of {% data variables.copilot.copilot_coding_agent %} that you can configure with tailored prompts, tools, and context, making them excel at specific tasks. {% data variables.copilot.custom_agents_caps_short %} can be defined and managed at the enterprise level for greater control and compliance, or at the organization and repository levels to allow teams the flexibility to build for their specific needs. +{% data variables.copilot.copilot_custom_agents %} are specialized versions of {% data variables.copilot.copilot_cloud_agent %} that you can configure with tailored prompts, tools, and context, making them excel at specific tasks. {% data variables.copilot.custom_agents_caps_short %} can be defined and managed at the enterprise level for greater control and compliance, or at the organization and repository levels to allow teams the flexibility to build for their specific needs. You can manage your enterprise-level {% data variables.copilot.custom_agents_short %}: * From the AI Controls view * Using the REST API. See [AUTOTITLE](/rest/copilot/copilot-custom-agents). -For more detailed information on {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents). +For more detailed information on {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-custom-agents). ## Agent sessions -An agent session encompasses an entire interaction with {% data variables.copilot.copilot_coding_agent %}, or any individual {% data variables.copilot.copilot_custom_agent_short %}, on a specific task. These tasks include: +An agent session encompasses an entire interaction with {% data variables.copilot.copilot_cloud_agent %}, or any individual {% data variables.copilot.copilot_custom_agent_short %}, on a specific task. These tasks include: * Prompting the agent to create or edit a pull request * Assigning the agent to an issue -For billing information on agent sessions, see [AUTOTITLE](/billing/concepts/product-billing/github-copilot-premium-requests#usage-by-copilot-coding-agent). +For billing information on agent sessions, see [AUTOTITLE](/billing/concepts/product-billing/github-copilot-premium-requests#usage-by-copilot-cloud-agent). ## Agent mode in the IDE diff --git a/content/copilot/concepts/agents/index.md b/content/copilot/concepts/agents/index.md index 60bf4c11bca0..5676dbda0475 100644 --- a/content/copilot/concepts/agents/index.md +++ b/content/copilot/concepts/agents/index.md @@ -6,7 +6,7 @@ intro: Learn how {% data variables.product.prodname_copilot %} can independently versions: feature: copilot children: - - /coding-agent + - /cloud-agent - /copilot-cli - /code-review - /copilot-memory diff --git a/content/copilot/concepts/auto-model-selection.md b/content/copilot/concepts/auto-model-selection.md index 6dd5e5d522ef..617f91e92240 100644 --- a/content/copilot/concepts/auto-model-selection.md +++ b/content/copilot/concepts/auto-model-selection.md @@ -2,8 +2,8 @@ title: 'About {% data variables.product.prodname_copilot_short %} auto model selection' allowTitleToDifferFromFilename: true shortTitle: 'Auto model selection' -intro: 'Automatically select models for {% data variables.copilot.copilot_chat_short %} and {% data variables.copilot.copilot_coding_agent %}.' -product: '{% data variables.copilot.copilot_auto_model_selection_short_cap_a %} for {% data variables.copilot.copilot_chat_short %} is available with all {% data variables.product.prodname_copilot %} plans.
{% data variables.copilot.copilot_auto_model_selection_short_cap_a %} for {% data variables.copilot.copilot_coding_agent %} is available for {% data variables.copilot.copilot_pro %} and {% data variables.copilot.copilot_pro_plus %} plans.' +intro: 'Automatically select models for {% data variables.copilot.copilot_chat_short %} and {% data variables.copilot.copilot_cloud_agent %}.' +product: '{% data variables.copilot.copilot_auto_model_selection_short_cap_a %} for {% data variables.copilot.copilot_chat_short %} is available with all {% data variables.product.prodname_copilot %} plans.
{% data variables.copilot.copilot_auto_model_selection_short_cap_a %} for {% data variables.copilot.copilot_cloud_agent %} is available for {% data variables.copilot.copilot_pro %} and {% data variables.copilot.copilot_pro_plus %} plans.' versions: feature: copilot contentType: concepts @@ -60,9 +60,9 @@ When you select **Auto** in {% data variables.copilot.copilot_chat_short %}, {% During the {% data variables.release-phases.public_preview %}, if you're using a {% data variables.copilot.copilot_business_short %} or {% data variables.copilot.copilot_enterprise_short %} plan, the organization or enterprise that provides your plan must have the **Editor preview features** policy enabled. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization) or [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#copilot-in-githubcom). -## {% data variables.copilot.copilot_auto_model_selection_short_cap_a %} in {% data variables.copilot.copilot_coding_agent %} +## {% data variables.copilot.copilot_auto_model_selection_short_cap_a %} in {% data variables.copilot.copilot_cloud_agent %} -When you select **Auto** in {% data variables.copilot.copilot_coding_agent %}, {% data variables.copilot.copilot_auto_model_selection_short_cap_a %} currently chooses from the following list of models, subject to your policies and subscription type: - {% data reusables.copilot.copilot-coding-agent-auto-models %} +When you select **Auto** in {% data variables.copilot.copilot_cloud_agent %}, {% data variables.copilot.copilot_auto_model_selection_short_cap_a %} currently chooses from the following list of models, subject to your policies and subscription type: + {% data reusables.copilot.copilot-cloud-agent-auto-models %} -{% data reusables.copilot.change-the-ai-model-copilot-coding-agent %} +{% data reusables.copilot.change-the-ai-model-copilot-cloud-agent %} diff --git a/content/copilot/concepts/billing/copilot-requests.md b/content/copilot/concepts/billing/copilot-requests.md index 92e10761cce4..c8caa0f5f4f9 100644 --- a/content/copilot/concepts/billing/copilot-requests.md +++ b/content/copilot/concepts/billing/copilot-requests.md @@ -42,7 +42,7 @@ The following {% data variables.product.prodname_copilot_short %} features can u | [{% data variables.copilot.copilot_chat_short %}](/copilot/using-github-copilot/copilot-chat) | {% data variables.copilot.copilot_chat_short %} uses **one premium request** per user prompt, multiplied by the model's rate. This includes ask, edit, agent, and plan modes in {% data variables.copilot.copilot_chat_short %} in an IDE. | {% data variables.product.prodname_copilot_short %} premium requests | | [{% data variables.copilot.copilot_cli_short %}](/copilot/concepts/agents/about-copilot-cli) | Each prompt to {% data variables.copilot.copilot_cli_short %} uses **one premium request** with the default model. For other models, this is multiplied by the model's rate. | {% data variables.product.prodname_copilot_short %} premium requests | | [{% data variables.product.prodname_copilot_short %} code review](/copilot/using-github-copilot/code-review/using-copilot-code-review) | Each time {% data variables.product.prodname_copilot_short %} reviews a pull request (when assigned as a reviewer) or reviews code in your IDE, **one premium request** is consumed. | {% data variables.product.prodname_copilot_short %} premium requests | -| [{% data variables.copilot.copilot_coding_agent %}](/copilot/concepts/about-copilot-coding-agent) | {% data variables.copilot.copilot_coding_agent %} uses **one premium request** per session, multiplied by the model's rate. A session begins when you prompt {% data variables.product.prodname_copilot_short %} to undertake a task. In addition, each real-time steering comment made during an active session uses **one premium request** per session, multiplied by the model's rate. | {% data variables.copilot.copilot_coding_agent %} premium requests | +| [{% data variables.copilot.copilot_cloud_agent %}](/copilot/concepts/about-copilot-cloud-agent) | {% data variables.copilot.copilot_cloud_agent %} uses **one premium request** per session, multiplied by the model's rate. A session begins when you prompt {% data variables.product.prodname_copilot_short %} to undertake a task. In addition, each real-time steering comment made during an active session uses **one premium request** per session, multiplied by the model's rate. | {% data variables.copilot.copilot_cloud_agent %} premium requests | | [{% data variables.copilot.copilot_spaces %}](/copilot/using-github-copilot/copilot-spaces/about-organizing-and-sharing-context-with-copilot-spaces) | {% data variables.copilot.copilot_spaces %} uses **one premium request** per user prompt, multiplied by the model's rate. | {% data variables.product.prodname_copilot_short %} premium requests | | [{% data variables.product.prodname_spark_short %}](/copilot/tutorials/building-ai-app-prototypes) | Each prompt to {% data variables.product.prodname_spark_short %} uses a fixed rate of **four premium requests**. | {% data variables.product.prodname_spark_short %} premium requests | | [{% data variables.product.prodname_openai_codex %} {% data variables.product.prodname_vscode %} integration](/copilot/concepts/agents/openai-codex) | While in preview, each prompt to {% data variables.product.prodname_openai_codex %} uses **one premium request** multiplied by the model multiplier rates. | {% data variables.product.prodname_copilot_short %} premium requests | diff --git a/content/copilot/concepts/completions/code-referencing.md b/content/copilot/concepts/completions/code-referencing.md index 17129b3a7110..a1fbd203334e 100644 --- a/content/copilot/concepts/completions/code-referencing.md +++ b/content/copilot/concepts/completions/code-referencing.md @@ -54,9 +54,9 @@ If you, or your organization, have allowed suggestions that match public code, t > [!NOTE] > Typically, matches to public code occur infrequently, so you should not expect to see code references in many {% data variables.copilot.copilot_chat_short %} responses. -### Code referencing for {% data variables.copilot.copilot_coding_agent %} +### Code referencing for {% data variables.copilot.copilot_cloud_agent %} -When {% data variables.product.prodname_copilot_short %} generates code that matches code in a public {% data variables.product.github %} repository, this is indicated in the agent session logs with a link to display details of the matched code. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions). +When {% data variables.product.prodname_copilot_short %} generates code that matches code in a public {% data variables.product.github %} repository, this is indicated in the agent session logs with a link to display details of the matched code. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions). {% endwebui %} @@ -86,7 +86,7 @@ Code in private {% data variables.product.prodname_dotcom %} repositories, or co The search index is refreshed every few months. As a result, newly committed code, and code from public repositories deleted before the index was created, may not be included in the search. For the same reason, the search may return matches to code that has been deleted or moved since the index was created. -References to matching code are currently available in JetBrains IDEs, {% data variables.product.prodname_vs %}, {% data variables.product.prodname_vscode %}, {% data variables.copilot.copilot_coding_agent %}, and on the {% data variables.product.github %} website. +References to matching code are currently available in JetBrains IDEs, {% data variables.product.prodname_vs %}, {% data variables.product.prodname_vscode %}, {% data variables.copilot.copilot_cloud_agent %}, and on the {% data variables.product.github %} website. ## Further reading diff --git a/content/copilot/concepts/context/mcp.md b/content/copilot/concepts/context/mcp.md index 027c6298b5f3..7e1f5252bf39 100644 --- a/content/copilot/concepts/context/mcp.md +++ b/content/copilot/concepts/context/mcp.md @@ -36,7 +36,7 @@ category: The Model Context Protocol (MCP) is an open standard that defines how applications share context with large language models (LLMs). MCP provides a standardized way to connect AI models to different data sources and tools, enabling them to work together more effectively. -You can use MCP to extend the capabilities of {% data variables.product.prodname_copilot %} by integrating it with a wide range of existing tools and services. MCP works across all major {% data variables.product.prodname_copilot_short %} surfaces—whether you're working in an IDE, using {% data variables.copilot.copilot_cli %}, or delegating tasks to the coding agent on {% data variables.product.prodname_dotcom_the_website %}. You can also use MCP to create new tools and services that work with {% data variables.product.prodname_copilot_short %}, allowing you to customize and enhance your experience. +You can use MCP to extend the capabilities of {% data variables.product.prodname_copilot %} by integrating it with a wide range of existing tools and services. MCP works across all major {% data variables.product.prodname_copilot_short %} surfaces—whether you're working in an IDE, using {% data variables.copilot.copilot_cli %}, or delegating tasks to an agent on {% data variables.product.prodname_dotcom_the_website %}. You can also use MCP to create new tools and services that work with {% data variables.product.prodname_copilot_short %}, allowing you to customize and enhance your experience. For more information on MCP, see [the official MCP documentation](https://modelcontextprotocol.io/introduction). For a curated list of MCP servers from partners and the community, see the [{% data variables.product.github %} MCP Registry](https://github.com/mcp). @@ -44,7 +44,7 @@ To learn how to configure and use MCP servers, see: * [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp) for {% data variables.copilot.copilot_chat_short %} in your IDE * [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers) for {% data variables.copilot.copilot_cli_short %} -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp) for {% data variables.copilot.copilot_coding_agent %} +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp) for {% data variables.copilot.copilot_cloud_agent %} {% data reusables.copilot.mcp.mcp-policy %} @@ -54,7 +54,7 @@ MCP is supported across the following clients: * **IDEs**: There is broad support for local MCP servers in clients such as {% data variables.product.prodname_vscode %}, JetBrains IDEs, Xcode, and others. Support for remote MCP servers is growing, with editors like {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, JetBrains IDEs, Xcode, Eclipse, Cursor, and Windsurf providing this functionality with OAuth or PAT. To find out if your preferred editor supports remote MCP servers, check the documentation for your specific editor. * **{% data variables.copilot.copilot_cli_short %}**: {% data variables.copilot.copilot_cli %} supports both local and remote MCP servers. The {% data variables.product.github %} MCP server is built in and available without additional configuration. -* **{% data variables.copilot.copilot_coding_agent %}**: {% data variables.copilot.copilot_coding_agent %} supports MCP servers configured at the repository level. The {% data variables.product.github %} MCP server and the Playwright MCP server are configured by default. +* **{% data variables.copilot.copilot_cloud_agent %}**: {% data variables.copilot.copilot_cloud_agent %} supports MCP servers configured at the repository level. The {% data variables.product.github %} MCP server and the Playwright MCP server are configured by default. ## About the {% data variables.product.github %} MCP server @@ -65,7 +65,7 @@ The {% data variables.product.github %} MCP server is a Model Context Protocol ( * Automate and streamline code-related tasks. * Connect third-party tools (like Cursor, Windsurf, or future integrations) to leverage {% data variables.product.github %}’s context and AI capabilities. * Enable cloud-based workflows that work from any device, without local setup. -* Invoke {% data variables.product.github %} tools, such as {% data variables.copilot.copilot_coding_agent %} (requires {% data variables.product.prodname_copilot %} subscription) and {% data variables.product.prodname_code_scanning %} (requires {% data variables.product.prodname_GHAS %} subscription), to assist with code generation and security analysis. +* Invoke {% data variables.product.github %} tools, such as {% data variables.copilot.copilot_cloud_agent %} (requires {% data variables.product.prodname_copilot %} subscription) and {% data variables.product.prodname_code_scanning %} (requires {% data variables.product.prodname_GHAS %} subscription), to assist with code generation and security analysis. To learn how to set up and use the {% data variables.product.github %} MCP server, see [AUTOTITLE](/copilot/how-tos/context/model-context-protocol/using-the-github-mcp-server). @@ -103,7 +103,7 @@ The {% data variables.product.github %} MCP Registry is a curated list of MCP se * [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp)—Add MCP servers to {% data variables.copilot.copilot_chat_short %} in your IDE * [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers)—Add MCP servers to {% data variables.copilot.copilot_cli_short %} -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp)—Add MCP servers to {% data variables.copilot.copilot_coding_agent %} +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp)—Add MCP servers to {% data variables.copilot.copilot_cloud_agent %} * [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/set-up-the-github-mcp-server)—Set up the {% data variables.product.github %} MCP server * [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server)—Use the {% data variables.product.github %} MCP server * [AUTOTITLE](/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp) diff --git a/content/copilot/concepts/context/repository-indexing.md b/content/copilot/concepts/context/repository-indexing.md index 809ac3a18587..9b37f4946565 100644 --- a/content/copilot/concepts/context/repository-indexing.md +++ b/content/copilot/concepts/context/repository-indexing.md @@ -30,11 +30,11 @@ When you start a conversation with {% data variables.copilot.copilot_chat_short For more information on how to ask questions, see [AUTOTITLE](/copilot/using-github-copilot/asking-github-copilot-questions-in-github). -## Semantic code search in {% data variables.copilot.copilot_coding_agent %} +## Semantic code search in {% data variables.copilot.copilot_cloud_agent %} -{% data variables.copilot.copilot_coding_agent %} uses semantic code search to find relevant code based on meaning, rather than relying solely on exact text matches with tools like `grep`. When the agent doesn't know the precise names or patterns to search for, semantic code search helps it locate the right code faster. No configuration is required—the agent automatically uses semantic code search when appropriate. +{% data variables.copilot.copilot_cloud_agent %} uses semantic code search to find relevant code based on meaning, rather than relying solely on exact text matches with tools like `grep`. When the agent doesn't know the precise names or patterns to search for, semantic code search helps it locate the right code faster. No configuration is required—the agent automatically uses semantic code search when appropriate. -For more information about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-coding-agent). +For more information about {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). ## About index creation and use @@ -43,7 +43,7 @@ Indexing runs in the background and initial indexing can take up to 60 seconds f Once an index has been created for a repository, it can be used by: * {% data variables.copilot.copilot_chat_short %} in {% data variables.product.github %} and {% data variables.product.prodname_vscode %} -* {% data variables.copilot.copilot_coding_agent %} +* {% data variables.copilot.copilot_cloud_agent %} > [!TIP] There is no limit to how many repositories you can index. diff --git a/content/copilot/concepts/mcp-management.md b/content/copilot/concepts/mcp-management.md index 0851d996cbea..ae2f28af8684 100644 --- a/content/copilot/concepts/mcp-management.md +++ b/content/copilot/concepts/mcp-management.md @@ -36,7 +36,7 @@ MCP management features are supported as follows: | Surface | Registry display | Allowlist enforcement | |---|:---:|:---:| | {% data variables.copilot.copilot_cli_short %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | -| {% data variables.copilot.copilot_coding_agent %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | +| {% data variables.copilot.copilot_cloud_agent %} | {% octicon "x" aria-label="Not supported" %} | {% octicon "x" aria-label="Not supported" %} | | Eclipse | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | | JetBrains | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | | {% data variables.product.prodname_vs %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | diff --git a/content/copilot/concepts/spark.md b/content/copilot/concepts/spark.md index 7224c8e77c00..44b5c850672a 100644 --- a/content/copilot/concepts/spark.md +++ b/content/copilot/concepts/spark.md @@ -107,13 +107,13 @@ Agent mode is useful when you have a specific task in mind and want to enable {% See [{% data variables.product.prodname_copilot_short %} agent mode](/copilot/how-tos/chat-with-copilot/chat-in-ide#agent-mode). -### {% data variables.copilot.copilot_coding_agent %} +### {% data variables.copilot.copilot_cloud_agent %} -Once your spark is connected to a {% data variables.product.github %} repository, you can use {% data variables.copilot.copilot_coding_agent %} to help you to continue to build and maintain your app, while you focus on other things. +Once your spark is connected to a {% data variables.product.github %} repository, you can use {% data variables.copilot.copilot_cloud_agent %} to help you to continue to build and maintain your app, while you focus on other things. -With the cloud agent, you delegate specific tasks to {% data variables.product.prodname_copilot_short %} (either by assigning an issue to {% data variables.product.prodname_copilot_short %}, or prompting {% data variables.product.prodname_copilot_short %} to create a pull request), and {% data variables.product.prodname_copilot_short %} will autonomously work in the background to complete the task. {% data variables.copilot.copilot_coding_agent %} can fix bugs, refactor code, improve test coverage and more. +With the cloud agent, you delegate specific tasks to {% data variables.product.prodname_copilot_short %} (either by assigning an issue to {% data variables.product.prodname_copilot_short %}, or prompting {% data variables.product.prodname_copilot_short %} to create a pull request), and {% data variables.product.prodname_copilot_short %} will autonomously work in the background to complete the task. {% data variables.copilot.copilot_cloud_agent %} can fix bugs, refactor code, improve test coverage and more. -See [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-coding-agent). +See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). ## Sharing your spark diff --git a/content/copilot/concepts/tools/about-copilot-integrations.md b/content/copilot/concepts/tools/about-copilot-integrations.md index 925a07d1aa77..60f4d945ab26 100644 --- a/content/copilot/concepts/tools/about-copilot-integrations.md +++ b/content/copilot/concepts/tools/about-copilot-integrations.md @@ -13,28 +13,28 @@ category: ## Overview -{% data variables.copilot.copilot_coding_agent %} can be integrated with various tools and platforms to enhance its functionality and streamline your development workflow. With integrations, you can trigger {% data variables.copilot.copilot_coding_agent %} from within your existing tools, providing the cloud agent with the context it needs to assist you effectively. +{% data variables.copilot.copilot_cloud_agent %} can be integrated with various tools and platforms to enhance its functionality and streamline your development workflow. With integrations, you can trigger {% data variables.copilot.copilot_cloud_agent %} from within your existing tools, providing the cloud agent with the context it needs to assist you effectively. -For more information about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-coding-agent). +For more information about {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). ## Supported integrations -Currently, {% data variables.copilot.copilot_coding_agent %} supports integrations with the following tools: +Currently, {% data variables.copilot.copilot_cloud_agent %} supports integrations with the following tools: -* **Microsoft Teams**: [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-teams) - Learn how to set up the Microsoft Teams integration to trigger {% data variables.copilot.copilot_coding_agent %} directly from your Teams channels. -* **Slack**: [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-slack) - Learn how to set up the Slack integration to trigger {% data variables.copilot.copilot_coding_agent %} directly from your Slack workspace. -* **Linear**: [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-linear) - Learn how to set up the Linear integration to trigger {% data variables.copilot.copilot_coding_agent %} directly from your Linear issues. -* **Azure Boards**: [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-azure-boards) - Learn how to set up the Azure Boards integration to trigger {% data variables.copilot.copilot_coding_agent %} directly from your Azure Boards work items. -* **Jira**: [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-jira) - Learn how to set up the Jira integration to trigger {% data variables.copilot.copilot_coding_agent %} directly from your Jira workspace. +* **Microsoft Teams**: [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-teams) - Learn how to set up the Microsoft Teams integration to trigger {% data variables.copilot.copilot_cloud_agent %} directly from your Teams channels. +* **Slack**: [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-slack) - Learn how to set up the Slack integration to trigger {% data variables.copilot.copilot_cloud_agent %} directly from your Slack workspace. +* **Linear**: [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-linear) - Learn how to set up the Linear integration to trigger {% data variables.copilot.copilot_cloud_agent %} directly from your Linear issues. +* **Azure Boards**: [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-azure-boards) - Learn how to set up the Azure Boards integration to trigger {% data variables.copilot.copilot_cloud_agent %} directly from your Azure Boards work items. +* **Jira**: [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-jira) - Learn how to set up the Jira integration to trigger {% data variables.copilot.copilot_cloud_agent %} directly from your Jira workspace. ## Benefits of integrations -Integrating {% data variables.copilot.copilot_coding_agent %} with your existing tools offers several benefits: +Integrating {% data variables.copilot.copilot_cloud_agent %} with your existing tools offers several benefits: -* **Seamless workflow**: Trigger {% data variables.copilot.copilot_coding_agent %} directly from the tools you already use, reducing context switching and improving productivity. -* **Context-aware assistance**: Provide {% data variables.copilot.copilot_coding_agent %} with the necessary context from your tools, enabling it to generate more relevant and accurate code suggestions. -* **Collaboration**: Facilitate collaboration among team members by allowing them to trigger {% data variables.copilot.copilot_coding_agent %} from shared platforms, ensuring everyone benefits from the agent's capabilities. +* **Seamless workflow**: Trigger {% data variables.copilot.copilot_cloud_agent %} directly from the tools you already use, reducing context switching and improving productivity. +* **Context-aware assistance**: Provide {% data variables.copilot.copilot_cloud_agent %} with the necessary context from your tools, enabling it to generate more relevant and accurate code suggestions. +* **Collaboration**: Facilitate collaboration among team members by allowing them to trigger {% data variables.copilot.copilot_cloud_agent %} from shared platforms, ensuring everyone benefits from the agent's capabilities. ## Data usage -When you trigger {% data variables.copilot.copilot_coding_agent %} through an integration, the agent will capture the entire thread or issue to understand the context in order to assist you effectively. This context is stored in the pull request created by the agent. +When you trigger {% data variables.copilot.copilot_cloud_agent %} through an integration, the agent will capture the entire thread or issue to understand the context in order to assist you effectively. This context is stored in the pull request created by the agent. diff --git a/content/copilot/concepts/tools/ai-tools.md b/content/copilot/concepts/tools/ai-tools.md index e5b01ea26787..9f7a8fdb8013 100644 --- a/content/copilot/concepts/tools/ai-tools.md +++ b/content/copilot/concepts/tools/ai-tools.md @@ -23,12 +23,12 @@ The use of AI tools is increasingly becoming a standard part of a software devel * **Planning**: * **{% data variables.copilot.copilot_chat_short %}** can help you brainstorm and identify the best technologies for your project. * **{% data variables.copilot.copilot_chat_short %}** can create issues to help track your ideas. - * **{% data variables.copilot.copilot_coding_agent %}** can help you research a repository and create a detailed implementation plan for your task. + * **{% data variables.copilot.copilot_cloud_agent %}** can help you research a repository and create a detailed implementation plan for your task. * **Code creation**: * **{% data variables.product.prodname_copilot_short %} inline suggestions** help add code as you type. * **{% data variables.copilot.next_edit_suggestions_caps %}** ({% data variables.release-phases.public_preview %}) predicts the next edit you are likely to make and suggests a completion for it. * **{% data variables.copilot.copilot_chat_short %}** can answer questions and offer suggestions in a conversational environment. - * You can assign **{% data variables.copilot.copilot_coding_agent %}** to an open issue and it will automatically raise a pull request to address the necessary changes. Alternatively, {% data variables.copilot.copilot_coding_agent %} can open a branch and iterate on code changes before opening a pull request. + * You can assign **{% data variables.copilot.copilot_cloud_agent %}** to an open issue and it will automatically raise a pull request to address the necessary changes. Alternatively, {% data variables.copilot.copilot_cloud_agent %} can open a branch and iterate on code changes before opening a pull request. * **Reviews**: * **{% data variables.copilot.copilot_code-review_short %}** gives you feedback in your favorite IDE, or as a pull request review on {% data variables.product.github %}. * **Testing**: @@ -36,7 +36,7 @@ The use of AI tools is increasingly becoming a standard part of a software devel * **Deployment**: * **{% data variables.copilot.copilot_chat_short %}** can help you configure continuous integration and continuous deployment (CI/CD) pipelines. * **Operation**: - * **{% data variables.copilot.copilot_coding_agent %}** can raise pull requests for open issues. + * **{% data variables.copilot.copilot_cloud_agent %}** can raise pull requests for open issues. * **{% data variables.copilot.copilot_chat_short %}** can help with tasks you're working on yourself. ## Planning @@ -124,7 +124,7 @@ The deployment phase involves preparing your code for production and ensuring a During the operation phase, the focus is on maintaining and monitoring your application in production to ensure it runs smoothly and meets user expectations. This phase often involves tasks like debugging production issues, optimizing performance, and ensuring system reliability. -You can use the **{% data variables.copilot.copilot_coding_agent %}** as an autonomous agent that can help maintain and improve your application in production. Assign a {% data variables.product.github %} issue to {% data variables.product.prodname_copilot_short %}, and it will autonomously explore the repository, identify potential fixes, and create a pull request with the proposed changes. Then it will automatically request a review from you. +You can use the **{% data variables.copilot.copilot_cloud_agent %}** as an autonomous agent that can help maintain and improve your application in production. Assign a {% data variables.product.github %} issue to {% data variables.product.prodname_copilot_short %}, and it will autonomously explore the repository, identify potential fixes, and create a pull request with the proposed changes. Then it will automatically request a review from you. For issues you're tackling yourself, use **{% data variables.copilot.copilot_chat_short %}** for help analyzing logs, debugging issues, and suggesting optimizations. For example: diff --git a/content/copilot/get-started/choose-enterprise-plan.md b/content/copilot/get-started/choose-enterprise-plan.md index 1b3155add889..7ba9eb70f45c 100644 --- a/content/copilot/get-started/choose-enterprise-plan.md +++ b/content/copilot/get-started/choose-enterprise-plan.md @@ -49,13 +49,13 @@ The following table shows examples of goals your company might set for a {% data | Goal | Problem to solve | How {% data variables.copilot.copilot_enterprise_short %} helps | | ---- | ---------------- | --------------------------------------------------------------- | -| **Reduce your backlog** | Teams may not have capacity to work on backlog issues or non-essential issues that come up during development. This can lead to a gradual degradation in feature quality. | With more premium requests, users can assign more issues to **{% data variables.copilot.copilot_coding_agent %}**, which can complete tasks like fixing bugs or adding feature enhancements in the background. | +| **Reduce your backlog** | Teams may not have capacity to work on backlog issues or non-essential issues that come up during development. This can lead to a gradual degradation in feature quality. | With more premium requests, users can assign more issues to **{% data variables.copilot.copilot_cloud_agent %}**, which can complete tasks like fixing bugs or adding feature enhancements in the background. | | **Accelerate pull requests** | Teams often experience delays in merging pull requests due to lengthy review cycles. This can lead to bottlenecks in the development process and slow down the delivery and improvement of features. | With more premium requests, users can receive more reviews on pull requests from **{% data variables.copilot.copilot_code-review_short %}**, often flagging bugs or possible improvements before a human reviewer is available. | | **Reduce technical debt** | Inefficient or hard-to-read code can accumulate over time, making it harder for team members to onboard and understand new areas of the code. | With more premium requests and access to the latest models, users can use agent mode in their IDE to refactor code, choosing models with **greater contextual awareness** that are more suited to tasks like complex refactoring. | ## Is {% data variables.copilot.copilot_enterprise_short %} the most cost effective choice? -We recommend considering the number of premium requests in the {% data variables.copilot.copilot_business_short %} plan as a baseline, not a limit. Developers using agentic workflows including features like agent mode, {% data variables.copilot.copilot_coding_agent %}, and {% data variables.copilot.copilot_code-review_short %} are likely to surpass this allowance. +We recommend considering the number of premium requests in the {% data variables.copilot.copilot_business_short %} plan as a baseline, not a limit. Developers using agentic workflows including features like agent mode, {% data variables.copilot.copilot_cloud_agent %}, and {% data variables.copilot.copilot_code-review_short %} are likely to surpass this allowance. If your company is gaining value from agentic workflows, you will likely want to make more requests available to developers. Depending on how many requests people are using, the most cost effective way to do that is either to upgrade users to {% data variables.copilot.copilot_enterprise_short %} or to enable paid usage for requests beyond your plan's allowance. diff --git a/content/copilot/get-started/features.md b/content/copilot/get-started/features.md index 6064679ce1f0..0cd59904a476 100644 --- a/content/copilot/get-started/features.md +++ b/content/copilot/get-started/features.md @@ -23,11 +23,11 @@ A chat interface that lets you ask coding-related questions. {% data variables.c ### {% data variables.copilot.copilot_cloud_agent_tmp %} -An autonomous AI agent that can research a repository, create an implementation plan, and make code changes on a branch. You can review the diff, iterate, and create a pull request when you're ready. You can also assign a {% data variables.product.github %} issue to {% data variables.product.prodname_copilot_short %} or ask it to open a pull request directly to complete a task. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent). +An autonomous AI agent that can research a repository, create an implementation plan, and make code changes on a branch. You can review the diff, iterate, and create a pull request when you're ready. You can also assign a {% data variables.product.github %} issue to {% data variables.product.prodname_copilot_short %} or ask it to open a pull request directly to complete a task. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent). ### Third-party coding agents ({% data variables.release-phases.public_preview %}) -You can use third-party coding agents alongside {% data variables.copilot.copilot_coding_agent %}. See [AUTOTITLE](/free-pro-team@latest/copilot/concepts/agents/about-third-party-agents). +You can use third-party coding agents alongside {% data variables.copilot.copilot_cloud_agent %}. See [AUTOTITLE](/free-pro-team@latest/copilot/concepts/agents/about-third-party-agents). ### {% data variables.copilot.copilot_cli_short %} @@ -59,7 +59,7 @@ Enhance {% data variables.copilot.copilot_chat_short %} responses by providing c ### {% data variables.copilot.copilot_memory %} ({% data variables.release-phases.public_preview %}) -{% data variables.product.prodname_copilot_short %} can deduce and store useful information about a repository, which {% data variables.copilot.copilot_coding_agent %} and {% data variables.copilot.copilot_code-review_short %} can use to improve the quality of their output when working in that repository. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-memory). +{% data variables.product.prodname_copilot_short %} can deduce and store useful information about a repository, which {% data variables.copilot.copilot_cloud_agent %} and {% data variables.copilot.copilot_code-review_short %} can use to improve the quality of their output when working in that repository. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-memory). ### {% data variables.copilot.copilot_desktop_short %} diff --git a/content/copilot/get-started/plans.md b/content/copilot/get-started/plans.md index 5aa5218208ab..29874fbc9beb 100644 --- a/content/copilot/get-started/plans.md +++ b/content/copilot/get-started/plans.md @@ -17,13 +17,13 @@ category: * **{% data variables.copilot.copilot_free %}** is available to individual developers who don't have access to {% data variables.product.prodname_copilot_short %} through an organization or enterprise. This free plan includes limited access to select {% data variables.product.prodname_copilot_short %} features, allowing you to try AI-powered coding assistance at no cost. -* **{% data variables.copilot.copilot_student %}** is available to verified students. The plan includes unlimited completions, access to premium models in {% data variables.copilot.copilot_chat_short %}, access to {% data variables.copilot.copilot_coding_agent %}, and a monthly allowance of premium requests. +* **{% data variables.copilot.copilot_student %}** is available to verified students. The plan includes unlimited completions, access to premium models in {% data variables.copilot.copilot_chat_short %}, access to {% data variables.copilot.copilot_cloud_agent %}, and a monthly allowance of premium requests. -* **{% data variables.copilot.copilot_pro %}** is designed for individuals who want more flexibility. This paid plan includes unlimited completions, access to premium models in {% data variables.copilot.copilot_chat_short %}, access to {% data variables.copilot.copilot_coding_agent %}, and a monthly allowance of premium requests. Verified teachers, and maintainers of popular open source projects may be eligible for free access. +* **{% data variables.copilot.copilot_pro %}** is designed for individuals who want more flexibility. This paid plan includes unlimited completions, access to premium models in {% data variables.copilot.copilot_chat_short %}, access to {% data variables.copilot.copilot_cloud_agent %}, and a monthly allowance of premium requests. Verified teachers, and maintainers of popular open source projects may be eligible for free access. * **{% data variables.copilot.copilot_pro_plus %}** offers the highest level of access for individual developers. In addition to everything in {% data variables.copilot.copilot_pro_short %}, this plan includes a larger allowance of premium requests, and full access to all available models in {% data variables.copilot.copilot_chat_short %}. Ideal for AI power users who want access to the most advanced capabilities. -* **{% data variables.copilot.copilot_for_business %}** is for organizations on {% data variables.product.prodname_free_team %} or {% data variables.product.prodname_team %} plan, or enterprises on {% data variables.product.prodname_ghe_cloud %}. This plan includes {% data variables.copilot.copilot_coding_agent %} and enables centralized management and {% data variables.product.prodname_copilot_short %} policy control for organization members. +* **{% data variables.copilot.copilot_for_business %}** is for organizations on {% data variables.product.prodname_free_team %} or {% data variables.product.prodname_team %} plan, or enterprises on {% data variables.product.prodname_ghe_cloud %}. This plan includes {% data variables.copilot.copilot_cloud_agent %} and enables centralized management and {% data variables.product.prodname_copilot_short %} policy control for organization members. * **{% data variables.copilot.copilot_enterprise %}** is for enterprises using {% data variables.product.prodname_ghe_cloud %}. It includes all the features of {% data variables.copilot.copilot_business_short %}, plus additional enterprise-grade capabilities. Enterprise owners can assign {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} to individual organizations, or assign {% data variables.copilot.copilot_business_short %} directly to users and teams. diff --git a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/index.md b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/index.md index 5bdbb7fb39e9..f7258b0c23b9 100644 --- a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/index.md +++ b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/index.md @@ -7,7 +7,7 @@ versions: children: - /prepare-for-custom-agents - /monitor-agentic-activity - - /manage-copilot-coding-agent + - /manage-copilot-cloud-agent - /manage-copilot-code-review contentType: how-tos --- diff --git a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/manage-copilot-cloud-agent.md b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/manage-copilot-cloud-agent.md new file mode 100644 index 000000000000..0d518c658744 --- /dev/null +++ b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/manage-copilot-cloud-agent.md @@ -0,0 +1,60 @@ +--- +title: Managing GitHub Copilot cloud agent in your enterprise +intro: 'Enable members of your enterprise to use {% data variables.copilot.copilot_cloud_agent %} and control the repositories where it is available.' +allowTitleToDifferFromFilename: true +permissions: Enterprise owners +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +versions: + feature: copilot +shortTitle: 'Manage {% data variables.copilot.copilot_cloud_agent %}' +redirect_from: + - /copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/manage-copilot-coding-agent + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/adding-copilot-coding-agent-to-enterprise + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/making-copilot-coding-agent-available-to-enterprise + - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-copilot-coding-agent-in-your-enterprise + - /copilot/how-tos/administer/enterprises/managing-copilot-coding-agent-in-your-enterprise + - /copilot/how-tos/administer/enterprises/manage-copilot-coding-agent + - /copilot/how-tos/administer/manage-for-enterprise/manage-copilot-coding-agent + - /copilot/how-tos/administer-copilot/manage-for-enterprise/manage-copilot-coding-agent +contentType: how-tos +category: + - Manage Copilot for a team +--- + +> [!NOTE] +> For an introduction to {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). + +## Prerequisites + +* For general information, see [AUTOTITLE](/copilot/tutorials/cloud-agent/pilot-cloud-agent). +* For information on premium requests and Actions minutes, see [Allowance usage for {% data variables.copilot.copilot_cloud_agent %}](/billing/managing-billing-for-your-products/managing-billing-for-github-copilot/about-billing-for-github-copilot#allowance-usage-for-copilot-cloud-agent). +* For information on MCP servers, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp). + +## Enabling {% data variables.copilot.copilot_cloud_agent %} for your {% data variables.product.prodname_copilot_short %} subscribers + +{% data variables.copilot.copilot_cloud_agent %} and use of third-party MCP servers are blocked by default for users to whom you have assigned a {% data variables.product.prodname_copilot_short %} license. You can allow members to use these features from the AI Controls tab for your enterprise. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#configuring-policies-for-github-copilot). + +* On the "Agents" page, click **{% data variables.copilot.copilot_cloud_agent %}**, then select **Enabled everywhere** or **Let organizations decide**. +* On the "MCP" page, for the "MCP servers in {% data variables.product.prodname_copilot_short %}" policy, select **Enabled everywhere** or **Let organizations decide**. + +### Next steps + +* If you selected **Enabled everywhere**, tell organization owners that {% data variables.copilot.copilot_cloud_agent %} is enabled for all members. By default, the agent will be available in all repositories, but it is possible to opt out some or all repositories. +* If you selected **Let organizations decide**, discuss member enablement with organization owners. + +For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-cloud-agent). + +## Disabling {% data variables.copilot.copilot_cloud_agent %} in your repositories + +{% data variables.product.prodname_copilot_short %} policies, like the "{% data variables.copilot.copilot_cloud_agent %}" and "MCP servers on {% data variables.product.prodname_dotcom_the_website %}" policies described above, affect only the users you assign a {% data variables.product.prodname_copilot_short %} license to. + +If there are {% data variables.copilot.copilot_pro_plus %} users with access to your enterprise's repositories, they will be able to use {% data variables.copilot.copilot_cloud_agent %} and will not be restricted by your policies. + +You can choose to stop anyone using the agent in some or all of your repositories using organization-level settings. For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-cloud-agent). + +Alternatively, you can disable the agent for all repositories owned by your enterprise. + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.ai-controls-tab %} +1. In the "Installed Agents" section, click **{% data variables.copilot.copilot_cloud_agent %}**. +1. In the "{% data variables.copilot.copilot_cloud_agent %}" section, next to "Block {% data variables.copilot.copilot_cloud_agent %} in all repositories owned by ENTERPRISE-NAME", click the toggle. diff --git a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/manage-copilot-coding-agent.md b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/manage-copilot-coding-agent.md deleted file mode 100644 index b731998ca6d1..000000000000 --- a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/manage-copilot-coding-agent.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: Managing GitHub Copilot cloud agent in your enterprise -intro: 'Enable members of your enterprise to use {% data variables.copilot.copilot_coding_agent %} and control the repositories where it is available.' -allowTitleToDifferFromFilename: true -permissions: Enterprise owners -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' -versions: - feature: copilot -shortTitle: 'Manage {% data variables.copilot.copilot_coding_agent %}' -redirect_from: - - /copilot/managing-copilot/managing-copilot-for-your-enterprise/adding-copilot-coding-agent-to-enterprise - - /copilot/managing-copilot/managing-copilot-for-your-enterprise/making-copilot-coding-agent-available-to-enterprise - - /copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-copilot-coding-agent-in-your-enterprise - - /copilot/how-tos/administer/enterprises/managing-copilot-coding-agent-in-your-enterprise - - /copilot/how-tos/administer/enterprises/manage-copilot-coding-agent - - /copilot/how-tos/administer/manage-for-enterprise/manage-copilot-coding-agent - - /copilot/how-tos/administer-copilot/manage-for-enterprise/manage-copilot-coding-agent -contentType: how-tos -category: - - Manage Copilot for a team ---- - -> [!NOTE] -> For an introduction to {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent). - -## Prerequisites - -* For general information, see [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org). -* For information on premium requests and Actions minutes, see [Allowance usage for {% data variables.copilot.copilot_coding_agent %}](/billing/managing-billing-for-your-products/managing-billing-for-github-copilot/about-billing-for-github-copilot#allowance-usage-for-copilot-coding-agent). -* For information on MCP servers, see [AUTOTITLE](/copilot/using-github-copilot/coding-agent/extending-copilot-coding-agent-with-mcp). - -## Enabling {% data variables.copilot.copilot_coding_agent %} for your {% data variables.product.prodname_copilot_short %} subscribers - -{% data variables.copilot.copilot_coding_agent %} and use of third-party MCP servers are blocked by default for users to whom you have assigned a {% data variables.product.prodname_copilot_short %} license. You can allow members to use these features from the AI Controls tab for your enterprise. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-for-your-enterprise/managing-policies-and-features-for-copilot-in-your-enterprise#configuring-policies-for-github-copilot). - -* On the "Agents" page, click **{% data variables.copilot.copilot_coding_agent %}**, then select **Enabled everywhere** or **Let organizations decide**. -* On the "MCP" page, for the "MCP servers in {% data variables.product.prodname_copilot_short %}" policy, select **Enabled everywhere** or **Let organizations decide**. - -### Next steps - -* If you selected **Enabled everywhere**, tell organization owners that {% data variables.copilot.copilot_coding_agent %} is enabled for all members. By default, the agent will be available in all repositories, but it is possible to opt out some or all repositories. -* If you selected **Let organizations decide**, discuss member enablement with organization owners. - -For more information, see [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/adding-copilot-coding-agent-to-organization). - -## Disabling {% data variables.copilot.copilot_coding_agent %} in your repositories - -{% data variables.product.prodname_copilot_short %} policies, like the "{% data variables.copilot.copilot_coding_agent %}" and "MCP servers on {% data variables.product.prodname_dotcom_the_website %}" policies described above, affect only the users you assign a {% data variables.product.prodname_copilot_short %} license to. - -If there are {% data variables.copilot.copilot_pro_plus %} users with access to your enterprise's repositories, they will be able to use {% data variables.copilot.copilot_coding_agent %} and will not be restricted by your policies. - -You can choose to stop anyone using the agent in some or all of your repositories using organization-level settings. For more information, see [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/adding-copilot-coding-agent-to-organization). - -Alternatively, you can disable the agent for all repositories owned by your enterprise. - -{% data reusables.enterprise-accounts.access-enterprise %} -{% data reusables.enterprise-accounts.ai-controls-tab %} -1. In the "Installed Agents" section, click **{% data variables.copilot.copilot_coding_agent %}**. -1. In the "{% data variables.copilot.copilot_coding_agent %}" section, next to "Block {% data variables.copilot.copilot_coding_agent %} in all repositories owned by ENTERPRISE-NAME", click the toggle. diff --git a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents.md b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents.md index 02e918975e6d..f9427b9420e6 100644 --- a/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents.md +++ b/content/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents.md @@ -36,4 +36,4 @@ Enterprise-level {% data variables.copilot.custom_agents_short %} are defined in To reduce your administrative burden and empower your SMEs, you can delegate the creation and management of {% data variables.copilot.custom_agents_short %} in your enterprise by creating a team of AI managers. See [AUTOTITLE](/copilot/tutorials/roll-out-at-scale/establish-ai-managers). -If you prefer to maintain full control over your enterprise's tooling to ensure security and compliance, you can create and manage {% data variables.copilot.custom_agents_short %} yourself. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/test-custom-agents). +If you prefer to maintain full control over your enterprise's tooling to ensure security and compliance, you can create and manage {% data variables.copilot.custom_agents_short %} yourself. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/test-custom-agents). diff --git a/content/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-cloud-agent.md b/content/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-cloud-agent.md new file mode 100644 index 000000000000..c5b77a3fa01f --- /dev/null +++ b/content/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-cloud-agent.md @@ -0,0 +1,66 @@ +--- +title: Adding GitHub Copilot cloud agent to your organization +intro: 'Enable {% data variables.copilot.copilot_cloud_agent %} for your members and control the repositories where it is available.' +allowTitleToDifferFromFilename: true +permissions: Organization owners +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +versions: + feature: copilot +shortTitle: 'Add {% data variables.copilot.copilot_cloud_agent %}' +redirect_from: + - /copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-coding-agent + - /copilot/managing-copilot/managing-github-copilot-in-your-organization/adding-copilot-coding-agent-to-organization + - /copilot/how-tos/administer/organizations/adding-copilot-coding-agent-to-organization + - /copilot/how-tos/administer/organizations/add-copilot-coding-agent + - /copilot/how-tos/administer/manage-for-organization/add-copilot-coding-agent +contentType: how-tos +category: + - Manage Copilot for a team +--- + +> [!NOTE] +> For an introduction to {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). + +## Prerequisites + +* For general information, see [AUTOTITLE](/copilot/tutorials/cloud-agent/pilot-cloud-agent). +* For information on premium requests and Actions minutes, see [Allowance usage for {% data variables.copilot.copilot_cloud_agent %}](/billing/managing-billing-for-your-products/managing-billing-for-github-copilot/about-billing-for-github-copilot#allowance-usage-for-copilot-cloud-agent). +* For information on MCP servers, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp). + +## Enabling {% data variables.copilot.copilot_cloud_agent %} for your members + +> [!NOTE] +> {% data reusables.organizations.copilot-policy-ent-overrides-org %} + +{% data variables.copilot.copilot_cloud_agent %} and use of third-party MCP servers are disabled by default for organization members assigned a {% data variables.copilot.copilot_enterprise %} or {% data variables.copilot.copilot_business_short %} license by your organization. + +Organizations with {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} can enable these features for members on the {% data variables.product.prodname_copilot_short %} policies page for their organization. See [Enabling {% data variables.product.prodname_copilot_short %} features in your organization](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization). + +* For the "{% data variables.copilot.copilot_cloud_agent %}" policy, select "Enabled". +* For the "MCP servers on {% data variables.product.prodname_dotcom_the_website %}" policy, select "Enabled". + +## Disabling or enabling {% data variables.copilot.copilot_cloud_agent %} in your repositories + +By default, {% data variables.copilot.copilot_cloud_agent %} is available in all repositories for users who have access to the agent, but you can block it from being used in some or all repositories owned by your organization. You can manage repository availability using the following instructions, or programmatically using the [REST API](/rest/copilot/copilot-cloud-agent-management). + +{% data reusables.profile.access_org %} +{% data reusables.profile.org_settings %} +{% data reusables.copilot.cloud-agent-settings %} +1. Use the "Repository access" control to define which repositories allow {% data variables.copilot.copilot_cloud_agent %}. +1. If you choose "Selected repositories", in the "Select repositories" dialog, select the repositories that allow {% data variables.copilot.copilot_cloud_agent %}, then click **Select**. + +Once {% data variables.copilot.copilot_cloud_agent %} is enabled for a repository, any user with access to {% data variables.copilot.copilot_cloud_agent %} and write permission for the repository can delegate work to {% data variables.product.prodname_copilot_short %}. + +## Managing the agent firewall for your organization + +Organization owners can configure the {% data variables.copilot.copilot_cloud_agent %} firewall for their organization, including whether it is enabled for the organization and which external hosts and URLs the agent can access. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall). + +## Next steps + +* Tell the members of repositories where {% data variables.copilot.copilot_cloud_agent %} is available that they can delegate work to the {% data variables.copilot.copilot_cloud_agent_short %}. +* Configure the default runner type for {% data variables.copilot.copilot_cloud_agent %} in your organization. For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/configure-runner-for-coding-agent). +* Encourage members to educate themselves about setting up their repository to get the most from {% data variables.copilot.copilot_cloud_agent %}. Useful resources: + + * [AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results) + * [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment) + * [Security best practices](/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-cloud-agent-in-org#security-best-practices) diff --git a/content/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-coding-agent.md b/content/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-coding-agent.md deleted file mode 100644 index e28b64f0201d..000000000000 --- a/content/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-coding-agent.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: Adding GitHub Copilot cloud agent to your organization -intro: 'Enable {% data variables.copilot.copilot_coding_agent %} for your members and control the repositories where it is available.' -allowTitleToDifferFromFilename: true -permissions: Organization owners -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' -versions: - feature: copilot -shortTitle: 'Add {% data variables.copilot.copilot_coding_agent %}' -redirect_from: - - /copilot/managing-copilot/managing-github-copilot-in-your-organization/adding-copilot-coding-agent-to-organization - - /copilot/how-tos/administer/organizations/adding-copilot-coding-agent-to-organization - - /copilot/how-tos/administer/organizations/add-copilot-coding-agent - - /copilot/how-tos/administer/manage-for-organization/add-copilot-coding-agent -contentType: how-tos -category: - - Manage Copilot for a team ---- - -> [!NOTE] -> For an introduction to {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent). - -## Prerequisites - -* For general information, see [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org). -* For information on premium requests and Actions minutes, see [Allowance usage for {% data variables.copilot.copilot_coding_agent %}](/billing/managing-billing-for-your-products/managing-billing-for-github-copilot/about-billing-for-github-copilot#allowance-usage-for-copilot-coding-agent). -* For information on MCP servers, see [AUTOTITLE](/copilot/using-github-copilot/coding-agent/extending-copilot-coding-agent-with-mcp). - -## Enabling {% data variables.copilot.copilot_coding_agent %} for your members - -> [!NOTE] -> {% data reusables.organizations.copilot-policy-ent-overrides-org %} - -{% data variables.copilot.copilot_coding_agent %} and use of third-party MCP servers are disabled by default for organization members assigned a {% data variables.copilot.copilot_enterprise %} or {% data variables.copilot.copilot_business_short %} license by your organization. - -Organizations with {% data variables.copilot.copilot_enterprise_short %} or {% data variables.copilot.copilot_business_short %} can enable these features for members on the {% data variables.product.prodname_copilot_short %} policies page for their organization. See [Enabling {% data variables.product.prodname_copilot_short %} features in your organization](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization). - -* For the "{% data variables.copilot.copilot_coding_agent %}" policy, select "Enabled". -* For the "MCP servers on {% data variables.product.prodname_dotcom_the_website %}" policy, select "Enabled". - -## Disabling or enabling {% data variables.copilot.copilot_coding_agent %} in your repositories - -By default, {% data variables.copilot.copilot_coding_agent %} is available in all repositories for users who have access to the agent, but you can block it from being used in some or all repositories owned by your organization. You can manage repository availability using the following instructions, or programmatically using the [REST API](/rest/copilot/copilot-coding-agent-management). - -{% data reusables.profile.access_org %} -{% data reusables.profile.org_settings %} -{% data reusables.copilot.coding-agent-settings %} -1. Use the "Repository access" control to define which repositories allow {% data variables.copilot.copilot_coding_agent %}. -1. If you choose "Selected repositories", in the "Select repositories" dialog, select the repositories that allow {% data variables.copilot.copilot_coding_agent %}, then click **Select**. - -Once {% data variables.copilot.copilot_coding_agent %} is enabled for a repository, any user with access to {% data variables.copilot.copilot_coding_agent %} and write permission for the repository can delegate work to {% data variables.product.prodname_copilot_short %}. - -## Managing the agent firewall for your organization - -Organization owners can configure the {% data variables.copilot.copilot_coding_agent %} firewall for their organization, including whether it is enabled for the organization and which external hosts and URLs the agent can access. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-firewall). - -## Next steps - -* Tell the members of repositories where {% data variables.copilot.copilot_coding_agent %} is available that they can delegate work to the {% data variables.copilot.copilot_coding_agent_short %}. -* Configure the default runner type for {% data variables.copilot.copilot_coding_agent %} in your organization. For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/configure-runner-for-coding-agent). -* Encourage members to educate themselves about setting up their repository to get the most from {% data variables.copilot.copilot_coding_agent %}. Useful resources: - - * [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices) - * [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent) - * [Security best practices](/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org#security-best-practices) diff --git a/content/copilot/how-tos/administer-copilot/manage-for-organization/configure-runner-for-coding-agent.md b/content/copilot/how-tos/administer-copilot/manage-for-organization/configure-runner-for-coding-agent.md index 1b6064c09c40..2fcd7cef72fd 100644 --- a/content/copilot/how-tos/administer-copilot/manage-for-organization/configure-runner-for-coding-agent.md +++ b/content/copilot/how-tos/administer-copilot/manage-for-organization/configure-runner-for-coding-agent.md @@ -2,9 +2,9 @@ title: Configuring runners for GitHub Copilot cloud agent in your organization shortTitle: Configure agent runners allowTitleToDifferFromFilename: true -intro: 'Configure the {% data variables.product.prodname_actions %} runners used by {% data variables.copilot.copilot_coding_agent %} and control whether repositories can customize the runner type.' +intro: 'Configure the {% data variables.product.prodname_actions %} runners used by {% data variables.copilot.copilot_cloud_agent %} and control whether repositories can customize the runner type.' permissions: Organization owners -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot contentType: how-tos @@ -14,9 +14,9 @@ category: ## About organization-level runner controls -By default, {% data variables.copilot.copilot_coding_agent %} runs on a standard {% data variables.product.prodname_dotcom %}-hosted {% data variables.product.prodname_actions %} runner (`ubuntu-latest`). As an organization owner, you can change the default runner type for all repositories in your organization, and choose whether individual repositories are allowed to override this default. +By default, {% data variables.copilot.copilot_cloud_agent %} runs on a standard {% data variables.product.prodname_dotcom %}-hosted {% data variables.product.prodname_actions %} runner (`ubuntu-latest`). As an organization owner, you can change the default runner type for all repositories in your organization, and choose whether individual repositories are allowed to override this default. -This is useful if your organization requires all {% data variables.copilot.copilot_coding_agent %} sessions to run on specific runners—for example, to use larger runners for better performance, or to use self-hosted runners that have access to internal resources. +This is useful if your organization requires all {% data variables.copilot.copilot_cloud_agent %} sessions to run on specific runners—for example, to use larger runners for better performance, or to use self-hosted runners that have access to internal resources. You can configure: @@ -27,11 +27,11 @@ You can configure: {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% data reusables.copilot.coding-agent-settings %} +{% data reusables.copilot.cloud-agent-settings %} 1. Next to "Runner type," click the pencil icon ({% octicon "pencil" aria-label="Edit" %}). -1. Select the runner type to use by default for {% data variables.copilot.copilot_coding_agent %} across your organization. - * **Standard {% data variables.product.prodname_dotcom %} runner**: {% data variables.copilot.copilot_coding_agent %} will use `ubuntu-latest`. - * **Labeled runner**: {% data variables.copilot.copilot_coding_agent %} will use a runner matching the group name and/or label you specify. Enter values in the **Runner group name** and/or **Runner label** fields. +1. Select the runner type to use by default for {% data variables.copilot.copilot_cloud_agent %} across your organization. + * **Standard {% data variables.product.prodname_dotcom %} runner**: {% data variables.copilot.copilot_cloud_agent %} will use `ubuntu-latest`. + * **Labeled runner**: {% data variables.copilot.copilot_cloud_agent %} will use a runner matching the group name and/or label you specify. Enter values in the **Runner group name** and/or **Runner label** fields. 1. Click **Save runner selection**. ## Preventing repositories from customizing the runner type @@ -40,13 +40,13 @@ By default, repositories can override the organization-level runner configuratio {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% data reusables.copilot.coding-agent-settings %} +{% data reusables.copilot.cloud-agent-settings %} 1. Under "Allow repositories to customize the runner type," toggle the setting to enable or disable repository-level customization. - * When enabled, repositories can override the default runner by setting the `runs-on` field in the `copilot-setup-steps` job of `copilot-setup-steps.yml`. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment#configure-the-runner). + * When enabled, repositories can override the default runner by setting the `runs-on` field in the `copilot-setup-steps` job of `copilot-setup-steps.yml`. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment#configure-the-runner). * When disabled, all repositories in your organization will use the organization-level runner type. 1. Click **Save**. ## Further reading -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment) -* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-coding-agent) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment) +* [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-cloud-agent) diff --git a/content/copilot/how-tos/administer-copilot/manage-for-organization/index.md b/content/copilot/how-tos/administer-copilot/manage-for-organization/index.md index 2e0502a63d59..7708ae5e9a22 100644 --- a/content/copilot/how-tos/administer-copilot/manage-for-organization/index.md +++ b/content/copilot/how-tos/administer-copilot/manage-for-organization/index.md @@ -14,7 +14,7 @@ children: - /manage-plan - /manage-access - /manage-policies - - /add-copilot-coding-agent + - /add-copilot-cloud-agent - /configure-runner-for-coding-agent - /prepare-for-custom-agents - /review-activity diff --git a/content/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies.md b/content/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies.md index b307dedeb89d..1290067ea836 100644 --- a/content/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies.md +++ b/content/copilot/how-tos/administer-copilot/manage-for-organization/manage-policies.md @@ -52,15 +52,15 @@ You can choose whether to allow the following coding agents to be enabled in you * {% data variables.product.prodname_anthropic_claude %} * {% data variables.product.prodname_openai_codex %} -Coding agents have access to the same repositories that {% data variables.copilot.copilot_coding_agent %} has been enabled in. +Coding agents have access to the same repositories that {% data variables.copilot.copilot_cloud_agent %} has been enabled in. To enable coding agents: {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% data reusables.copilot.coding-agent-settings %} +{% data reusables.copilot.cloud-agent-settings %} 1. In the sidebar, under **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}**, click **Cloud agent**. -1. On the {% data variables.copilot.copilot_coding_agent %} page, under "Partner agents", click the toggle to enable the third-party agent you want to use. +1. On the {% data variables.copilot.copilot_cloud_agent %} page, under "Partner agents", click the toggle to enable the third-party agent you want to use. ## Opting in to previews or feedback diff --git a/content/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents.md b/content/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents.md index 3ecf07ce40df..94f0622d5ec8 100644 --- a/content/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents.md +++ b/content/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents.md @@ -15,7 +15,7 @@ category: ## Prerequisites -You should understand what {% data variables.copilot.copilot_custom_agents %} are and how they work. See [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents). +You should understand what {% data variables.copilot.copilot_custom_agents %} are and how they work. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-custom-agents). > [!NOTE] > If your organization is part of an enterprise, enterprise owners can configure a ruleset that restricts {% data variables.copilot.custom_agents_short %}. Contact your enterprise owners to check whether you can create and manage organization-level {% data variables.copilot.custom_agents_short %}. @@ -33,4 +33,4 @@ You should understand what {% data variables.copilot.copilot_custom_agents %} ar ## Next steps -To trial {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/test-custom-agents). +To trial {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/test-custom-agents). diff --git a/content/copilot/how-tos/chat-with-copilot/chat-in-ide.md b/content/copilot/how-tos/chat-with-copilot/chat-in-ide.md index 7f1efdd3c3b9..db279b38a429 100644 --- a/content/copilot/how-tos/chat-with-copilot/chat-in-ide.md +++ b/content/copilot/how-tos/chat-with-copilot/chat-in-ide.md @@ -77,7 +77,7 @@ For more information, see [Chat overview](https://aka.ms/vscode-copilot-agent) i 1. In the {% data variables.copilot.copilot_chat_short %} window, click the tools icon. 1. Enable the `runSubagent` tool. -If you use custom prompt files or {% data variables.copilot.custom_agents_short %}, ensure you specify the `runSubagent` tool in the `tools` frontmatter property. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents#creating-a-custom-agent-profile-in-visual-studio-code), and [Use prompt files in VS Code](https://code.visualstudio.com/docs/copilot/customization/prompt-files) in the {% data variables.product.prodname_vscode %} documentation. +If you use custom prompt files or {% data variables.copilot.custom_agents_short %}, ensure you specify the `runSubagent` tool in the `tools` frontmatter property. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents#creating-a-custom-agent-profile-in-visual-studio-code), and [Use prompt files in VS Code](https://code.visualstudio.com/docs/copilot/customization/prompt-files) in the {% data variables.product.prodname_vscode %} documentation. #### Invoking {% data variables.copilot.subagents_short %} @@ -455,7 +455,7 @@ Use {% data variables.copilot.copilot_edits_short %} to make changes across mult {% data reusables.copilot.subagent-intro %} -To use {% data variables.copilot.subagents_short %}, you **must have {% data variables.copilot.custom_agents_short %} configured in your environment**. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents). +To use {% data variables.copilot.subagents_short %}, you **must have {% data variables.copilot.custom_agents_short %} configured in your environment**. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents). #### Enabling {% data variables.copilot.subagents_short %} @@ -594,7 +594,7 @@ To use plan mode: {% data reusables.copilot.subagent-intro %} -To use {% data variables.copilot.subagents_short %}, you **must have {% data variables.copilot.custom_agents_short %} configured in your environment**. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents). +To use {% data variables.copilot.subagents_short %}, you **must have {% data variables.copilot.custom_agents_short %} configured in your environment**. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents). #### Enabling {% data variables.copilot.subagents_short %} @@ -710,7 +710,7 @@ To use agent mode: {% data reusables.copilot.subagent-intro %} -To use {% data variables.copilot.subagents_short %}, you **must have {% data variables.copilot.custom_agents_short %} configured in your environment**. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents). +To use {% data variables.copilot.subagents_short %}, you **must have {% data variables.copilot.custom_agents_short %} configured in your environment**. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents). #### Enabling {% data variables.copilot.subagents_short %} diff --git a/content/copilot/how-tos/configure-content-exclusion/exclude-content-from-copilot.md b/content/copilot/how-tos/configure-content-exclusion/exclude-content-from-copilot.md index 844604b779b8..6c1d808c2f17 100644 --- a/content/copilot/how-tos/configure-content-exclusion/exclude-content-from-copilot.md +++ b/content/copilot/how-tos/configure-content-exclusion/exclude-content-from-copilot.md @@ -31,7 +31,7 @@ category: You can use your repository settings to specify content in your repository that {% data variables.product.prodname_copilot %} should ignore. > [!NOTE] -> {% data variables.copilot.copilot_cli %}, {% data variables.copilot.copilot_coding_agent %}, and Agent mode in {% data variables.copilot.copilot_chat_short %} in IDEs, do not support content exclusion. For more information about these {% data variables.product.prodname_copilot_short %} features, see [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli), [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-coding-agent), and [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide). +> {% data variables.copilot.copilot_cli %}, {% data variables.copilot.copilot_cloud_agent %}, and Agent mode in {% data variables.copilot.copilot_chat_short %} in IDEs, do not support content exclusion. For more information about these {% data variables.product.prodname_copilot_short %} features, see [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli), [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent), and [AUTOTITLE](/copilot/how-tos/chat-with-copilot/chat-in-ide). {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} diff --git a/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md b/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md index 16b72e02ac3c..61f202c0d9dd 100644 --- a/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md +++ b/content/copilot/how-tos/configure-custom-instructions/add-repository-instructions.md @@ -49,9 +49,9 @@ This version of this article is for using repository custom instructions on the ## Creating repository-wide custom instructions -You can create your own custom instructions file from scratch. See [Writing your own copilot-instructions.md file](#writing-your-own-copilot-instructionsmd-file). Alternatively, you can ask {% data variables.copilot.copilot_coding_agent %} to generate one for you. +You can create your own custom instructions file from scratch. See [Writing your own copilot-instructions.md file](#writing-your-own-copilot-instructionsmd-file). Alternatively, you can ask {% data variables.copilot.copilot_cloud_agent %} to generate one for you. -### Asking {% data variables.copilot.copilot_coding_agent %} to generate a `copilot-instructions.md` file +### Asking {% data variables.copilot.copilot_cloud_agent %} to generate a `copilot-instructions.md` file 1. Navigate to the agents tab at [github.com/copilot/agents](https://github.com/copilot/agents?ref_product=copilot&ref_type=engagement&ref_style=text). @@ -150,12 +150,12 @@ You can create your own custom instructions file from scratch. See [Writing your Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility. > [!TIP] -> The first time you create a pull request in a given repository with {% data variables.copilot.copilot_coding_agent %}, {% data variables.product.prodname_copilot_short %} will leave a comment with a link to automatically generate custom instructions for the repository. +> The first time you create a pull request in a given repository with {% data variables.copilot.copilot_cloud_agent %}, {% data variables.product.prodname_copilot_short %} will leave a comment with a link to automatically generate custom instructions for the repository. ## Creating path-specific custom instructions > [!NOTE] -> Currently, on {% data variables.product.prodname_dotcom_the_website %}, path-specific custom instructions are only supported for {% data variables.copilot.copilot_coding_agent %} and {% data variables.copilot.copilot_code-review_short %}. +> Currently, on {% data variables.product.prodname_dotcom_the_website %}, path-specific custom instructions are only supported for {% data variables.copilot.copilot_cloud_agent %} and {% data variables.copilot.copilot_code-review_short %}. {% data reusables.copilot.custom-instructions-path %} diff --git a/content/copilot/how-tos/copilot-cli/administer-copilot-cli-for-your-enterprise.md b/content/copilot/how-tos/copilot-cli/administer-copilot-cli-for-your-enterprise.md index 522f107d4850..29a94206e36e 100644 --- a/content/copilot/how-tos/copilot-cli/administer-copilot-cli-for-your-enterprise.md +++ b/content/copilot/how-tos/copilot-cli/administer-copilot-cli-for-your-enterprise.md @@ -36,9 +36,9 @@ Users can only access AI models that are enabled at the enterprise level. When y Enterprise-configured custom agents are available to use with {% data variables.copilot.copilot_cli_short %}. -### {% data variables.copilot.copilot_coding_agent %} enablement +### {% data variables.copilot.copilot_cloud_agent %} enablement -Both the {% data variables.copilot.copilot_cli_short %} policy and the {% data variables.copilot.copilot_coding_agent %} policy must be enabled for users to be able to use the `/delegate` command in {% data variables.copilot.copilot_cli_short %}. +Both the {% data variables.copilot.copilot_cli_short %} policy and the {% data variables.copilot.copilot_cloud_agent %} policy must be enabled for users to be able to use the `/delegate` command in {% data variables.copilot.copilot_cli_short %}. ### Audit logging diff --git a/content/copilot/how-tos/copilot-cli/cli-best-practices.md b/content/copilot/how-tos/copilot-cli/cli-best-practices.md index e8181c46b0df..e0e9b561e67d 100644 --- a/content/copilot/how-tos/copilot-cli/cli-best-practices.md +++ b/content/copilot/how-tos/copilot-cli/cli-best-practices.md @@ -284,7 +284,7 @@ Visualize your current context usage with `/context`. It shows a breakdown of: ### The `/delegate` command -**Offload work to run in the cloud using {% data variables.copilot.copilot_coding_agent %}.** This is particularly powerful for: +**Offload work to run in the cloud using {% data variables.copilot.copilot_cloud_agent %}.** This is particularly powerful for: * Tasks that can run asynchronously. * Changes to other repositories. @@ -298,7 +298,7 @@ Visualize your current context usage with `/context`. It shows a breakdown of: **What happens:** -* Your request is sent to {% data variables.copilot.copilot_coding_agent %}. +* Your request is sent to {% data variables.copilot.copilot_cloud_agent %}. * The agent creates a pull request with the changes. * You can continue working locally while the cloud agent works. diff --git a/content/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers.md b/content/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers.md index 325c3507a7f6..ecb286907d67 100644 --- a/content/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers.md +++ b/content/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers.md @@ -28,7 +28,7 @@ For installation instructions, available tools, and URLs for specific MCP server 1. Next to **Server Name**, enter a unique name for the MCP server. This is the name you will use to refer to the server. 1. Next to **Server Type**, select a type by pressing the corresponding number. The following types are available: - * **Local** or **STDIO**: starts a local process and communicates over standard input/output (`stdin`/`stdout`). Both options work the same way. **STDIO** is the standard MCP protocol type name, so choose this if you want your configuration to be compatible with {% data variables.product.prodname_vscode_shortname %}, the {% data variables.copilot.copilot_coding_agent %}, and other MCP clients. + * **Local** or **STDIO**: starts a local process and communicates over standard input/output (`stdin`/`stdout`). Both options work the same way. **STDIO** is the standard MCP protocol type name, so choose this if you want your configuration to be compatible with {% data variables.product.prodname_vscode_shortname %}, the {% data variables.copilot.copilot_cloud_agent %}, and other MCP clients. * **HTTP** or **SSE**: connects to a remote MCP server. **HTTP** uses the Streamable HTTP transport. **SSE** uses the legacy HTTP with Server-Sent Events transport, which is deprecated in the MCP specification but still supported for backwards compatibility. 1. The remaining fields depend on the server type you selected: @@ -74,7 +74,7 @@ The following example shows a configuration file with a local server and a remot } ``` -For more information on MCP server configuration, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp#writing-a-json-configuration-for-mcp-servers). +For more information on MCP server configuration, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp#writing-a-json-configuration-for-mcp-servers). ## Managing MCP servers @@ -100,4 +100,4 @@ Once you have added an MCP server, {% data variables.product.prodname_copilot_sh * [AUTOTITLE](/copilot/concepts/about-mcp) * [AUTOTITLE](/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp) diff --git a/content/copilot/how-tos/copilot-cli/customize-copilot/use-byok-models.md b/content/copilot/how-tos/copilot-cli/customize-copilot/use-byok-models.md index aa989e9f3214..5b780ea3071c 100644 --- a/content/copilot/how-tos/copilot-cli/customize-copilot/use-byok-models.md +++ b/content/copilot/how-tos/copilot-cli/customize-copilot/use-byok-models.md @@ -61,7 +61,7 @@ Use the following steps if you are connecting to OpenAI, Ollama, vLLM, Foundry L 1. For a remote OpenAI endpoint, also set your API key. ```shell - export COPILOT_PROVIDER_BASE_URL=https://api.openai.com + export COPILOT_PROVIDER_BASE_URL=https://api.openai.com/v1 export COPILOT_PROVIDER_API_KEY=YOUR-OPENAI-API-KEY export COPILOT_MODEL=YOUR-MODEL-NAME ``` @@ -95,6 +95,7 @@ Use the following steps if you are connecting to OpenAI, Ollama, vLLM, Foundry L ```shell export COPILOT_PROVIDER_TYPE=anthropic + export COPILOT_PROVIDER_BASE_URL=https://api.anthropic.com export COPILOT_PROVIDER_API_KEY=YOUR-ANTHROPIC-API-KEY export COPILOT_MODEL=YOUR-MODEL-NAME ``` diff --git a/content/copilot/how-tos/copilot-cli/customize-copilot/use-hooks.md b/content/copilot/how-tos/copilot-cli/customize-copilot/use-hooks.md index 16dbd35292c4..438f85f1d876 100644 --- a/content/copilot/how-tos/copilot-cli/customize-copilot/use-hooks.md +++ b/content/copilot/how-tos/copilot-cli/customize-copilot/use-hooks.md @@ -12,19 +12,19 @@ redirect_from: - /copilot/how-tos/copilot-cli/use-hooks --- -{% data reusables.copilot.coding-agent.hooks-intro %} +{% data reusables.copilot.cloud-agent.hooks-intro %} ## Creating a hook in a repository on {% data variables.product.github %} -{% data reusables.copilot.coding-agent.create-hooks-instructions %} +{% data reusables.copilot.cloud-agent.create-hooks-instructions %} ## Troubleshooting -{% data reusables.copilot.coding-agent.troubleshoot-hooks %} +{% data reusables.copilot.cloud-agent.troubleshoot-hooks %} ## Further reading * [AUTOTITLE](/copilot/reference/hooks-configuration) -* [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-coding-agent) +* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent) * [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment) diff --git a/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli.md b/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli.md index e053498ea024..892d136e0ae4 100644 --- a/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli.md +++ b/content/copilot/how-tos/copilot-cli/set-up-copilot-cli/authenticate-copilot-cli.md @@ -30,7 +30,7 @@ If you configure {% data variables.copilot.copilot_cli_short %} to use your own However, without {% data variables.product.github %} authentication, the following features are **not available**: -* `/delegate`: Requires {% data variables.copilot.copilot_coding_agent %}, which runs on {% data variables.product.github %}'s servers +* `/delegate`: Requires {% data variables.copilot.copilot_cloud_agent %}, which runs on {% data variables.product.github %}'s servers * {% data variables.product.github %} MCP server: Requires authentication to access {% data variables.product.github %} APIs * {% data variables.product.github %} Code Search: Requires authentication to query {% data variables.product.github %}'s search index diff --git a/content/copilot/how-tos/copilot-cli/use-copilot-cli-agents/delegate-tasks-to-cca.md b/content/copilot/how-tos/copilot-cli/use-copilot-cli-agents/delegate-tasks-to-cca.md index 8857cef4a648..462e58f231b5 100644 --- a/content/copilot/how-tos/copilot-cli/use-copilot-cli-agents/delegate-tasks-to-cca.md +++ b/content/copilot/how-tos/copilot-cli/use-copilot-cli-agents/delegate-tasks-to-cca.md @@ -22,9 +22,9 @@ There are two ways to use autopilot mode: For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-cli/autopilot). -## Delegate tasks to {% data variables.copilot.copilot_coding_agent %} +## Delegate tasks to {% data variables.copilot.copilot_cloud_agent %} -The delegate command lets you push your current session to {% data variables.copilot.copilot_coding_agent %} on {% data variables.product.github %}. This lets you hand off work while preserving all the context {% data variables.product.prodname_copilot_short %} needs to complete your task. +The delegate command lets you push your current session to {% data variables.copilot.copilot_cloud_agent %} on {% data variables.product.github %}. This lets you hand off work while preserving all the context {% data variables.product.prodname_copilot_short %} needs to complete your task. You can delegate a task using the slash command, followed by a prompt: @@ -38,7 +38,7 @@ Alternatively, prefix a prompt with `&` to delegate it: & complete the API integration tests and fix any failing edge cases ``` -{% data variables.product.prodname_copilot_short %} will ask to commit any of your unstaged changes as a checkpoint in a new branch it creates. {% data variables.copilot.copilot_coding_agent %} will open a draft pull request, make changes in the background, and request a review from you. +{% data variables.product.prodname_copilot_short %} will ask to commit any of your unstaged changes as a checkpoint in a new branch it creates. {% data variables.copilot.copilot_cloud_agent %} will open a draft pull request, make changes in the background, and request a review from you. {% data variables.product.prodname_copilot_short %} will provide a link to the pull request and agent session on {% data variables.product.github %} once the session begins. diff --git a/content/copilot/how-tos/copilot-cli/use-copilot-cli-agents/invoke-custom-agents.md b/content/copilot/how-tos/copilot-cli/use-copilot-cli-agents/invoke-custom-agents.md index 02965fd1f124..f326087c6242 100644 --- a/content/copilot/how-tos/copilot-cli/use-copilot-cli-agents/invoke-custom-agents.md +++ b/content/copilot/how-tos/copilot-cli/use-copilot-cli-agents/invoke-custom-agents.md @@ -79,7 +79,7 @@ In the case of naming conflicts, a system-level agent overrides a repository-lev copilot --agent=refactor-agent --prompt "Refactor this code block" ``` -For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents). +For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents). ## Use skills @@ -102,7 +102,7 @@ To extend the functionality available to you in {% data variables.copilot.copilo 1. Fill in the details for the MCP server you want to add, using the Tab key to move between fields. 1. Press Ctrl+S to save the details. -Details of your configured MCP servers are stored in the `mcp-config.json` file, which is located, by default, in the `~/.copilot` directory. This location can be changed by setting the `COPILOT_HOME` environment variable. For information about the JSON structure of a server definition, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp#writing-a-json-configuration-for-mcp-servers). +Details of your configured MCP servers are stored in the `mcp-config.json` file, which is located, by default, in the `~/.copilot` directory. This location can be changed by setting the `COPILOT_HOME` environment variable. For information about the JSON structure of a server definition, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp#writing-a-json-configuration-for-mcp-servers). For more detailed information on adding and managing MCP servers in {% data variables.copilot.copilot_cli_short %}, see [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers). diff --git a/content/copilot/how-tos/copilot-cli/use-copilot-cli-agents/overview.md b/content/copilot/how-tos/copilot-cli/use-copilot-cli-agents/overview.md index d26dfd61d1d9..42c753424a93 100644 --- a/content/copilot/how-tos/copilot-cli/use-copilot-cli-agents/overview.md +++ b/content/copilot/how-tos/copilot-cli/use-copilot-cli-agents/overview.md @@ -118,7 +118,7 @@ You can prepend your input with `!` to directly run shell commands, without maki ### Resume an interactive session -You can use the `--resume` command-line option or the `/resume` slash command to select and resume an interactive CLI session, allowing you to pick up right where you left off, with the saved context. You can kick off a {% data variables.copilot.copilot_coding_agent %} session on {% data variables.product.github %}, and then use {% data variables.copilot.copilot_cli %} to bring that session to your local environment. +You can use the `--resume` command-line option or the `/resume` slash command to select and resume an interactive CLI session, allowing you to pick up right where you left off, with the saved context. You can kick off a {% data variables.copilot.copilot_cloud_agent %} session on {% data variables.product.github %}, and then use {% data variables.copilot.copilot_cli %} to bring that session to your local environment. > [!TIP] > To quickly resume the most recently closed local session, enter this in your terminal: @@ -208,7 +208,7 @@ In the case of naming conflicts, a system-level agent overrides a repository-lev copilot --agent=refactor-agent --prompt "Refactor this code block" ``` -For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents). +For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents). ### Use skills @@ -231,7 +231,7 @@ To extend the functionality available to you in {% data variables.copilot.copilo 1. Fill in the details for the MCP server you want to add, using the Tab key to move between fields. 1. Press Ctrl+S to save the details. -Details of your configured MCP servers are stored in the `mcp-config.json` file, which is located, by default, in the `~/.copilot` directory. This location can be changed by setting the `COPILOT_HOME` environment variable. For information about the JSON structure of a server definition, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp#writing-a-json-configuration-for-mcp-servers). +Details of your configured MCP servers are stored in the `mcp-config.json` file, which is located, by default, in the `~/.copilot` directory. This location can be changed by setting the `COPILOT_HOME` environment variable. For information about the JSON structure of a server definition, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp#writing-a-json-configuration-for-mcp-servers). ### Context management diff --git a/content/copilot/how-tos/get-code-suggestions/find-matching-code.md b/content/copilot/how-tos/get-code-suggestions/find-matching-code.md index 30aa098eea44..f1ad102e215f 100644 --- a/content/copilot/how-tos/get-code-suggestions/find-matching-code.md +++ b/content/copilot/how-tos/get-code-suggestions/find-matching-code.md @@ -231,9 +231,9 @@ To see details of the matching code: 1. Click the name of a repository to display that repository on {% data variables.product.prodname_dotcom_the_website %}. -## View code references for {% data variables.copilot.copilot_coding_agent %} +## View code references for {% data variables.copilot.copilot_cloud_agent %} -When {% data variables.product.prodname_copilot_short %} provides a response that includes code that matches code in a public {% data variables.product.github %} repository, this is indicated in the agent session logs with a link to display details of the matched code. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions). +When {% data variables.product.prodname_copilot_short %} provides a response that includes code that matches code in a public {% data variables.product.github %} repository, this is indicated in the agent session logs with a link to display details of the matched code. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions). {% endwebui %} diff --git a/content/copilot/how-tos/manage-and-track-spending/manage-request-allowances.md b/content/copilot/how-tos/manage-and-track-spending/manage-request-allowances.md index 8d494c22a6f6..9cfc88391178 100644 --- a/content/copilot/how-tos/manage-and-track-spending/manage-request-allowances.md +++ b/content/copilot/how-tos/manage-and-track-spending/manage-request-allowances.md @@ -53,7 +53,7 @@ You can set the policy for an enterprise or a standalone organization. 1. Check the budgets for your enterprise or organizations, and edit or delete any budgets that "stop usage when budget limit is reached" for the Premium Request SKU. See [AUTOTITLE](/billing/managing-your-billing/using-budgets-control-spending#editing-or-deleting-a-budget). 1. Premium request budget types: * **Bundled premium requests budget**: Manages all premium request SKUs together (recommended for most users) - * **Individual SKU budgets**: Set separate budgets for each AI tool ({% data variables.product.prodname_copilot_short %}, {% data variables.product.prodname_spark_short %}, {% data variables.copilot.copilot_coding_agent %}) + * **Individual SKU budgets**: Set separate budgets for each AI tool ({% data variables.product.prodname_copilot_short %}, {% data variables.product.prodname_spark_short %}, {% data variables.copilot.copilot_cloud_agent %}) Creating new budgets without deleting an existing budget does not override the existing budget. If **any** applicable budget with "Stop usage when budget limit is reached" enabled is exhausted, additional premium requests are blocked. diff --git a/content/copilot/how-tos/manage-your-account/manage-policies.md b/content/copilot/how-tos/manage-your-account/manage-policies.md index 4b5f6c36bfac..1311be23f356 100644 --- a/content/copilot/how-tos/manage-your-account/manage-policies.md +++ b/content/copilot/how-tos/manage-your-account/manage-policies.md @@ -35,21 +35,21 @@ If you choose to allow suggestions matching public code or use a product that do {% data reusables.user-settings.copilot-settings %} 1. To the right of **Suggestions matching public code**, select the dropdown menu, then click **Allow** to allow suggestions matching public code, or **Block** to block suggestions matching public code. -## Disabling or enabling {% data variables.copilot.copilot_coding_agent %} in your repositories +## Disabling or enabling {% data variables.copilot.copilot_cloud_agent %} in your repositories -{% data variables.copilot.copilot_coding_agent %} allows you to assign {% data variables.product.prodname_copilot_short %} to {% data variables.product.github %} issues, or prompt {% data variables.product.prodname_copilot_short %} to undertake a task autonomously, such as deep research of a repository, planning, or code changes, with the option to create a pull request when you're ready. +{% data variables.copilot.copilot_cloud_agent %} allows you to assign {% data variables.product.prodname_copilot_short %} to {% data variables.product.github %} issues, or prompt {% data variables.product.prodname_copilot_short %} to undertake a task autonomously, such as deep research of a repository, planning, or code changes, with the option to create a pull request when you're ready. > [!NOTE] -> * {% data reusables.gated-features.copilot-coding-agent %} +> * {% data reusables.gated-features.copilot-cloud-agent %} -{% data variables.copilot.copilot_coding_agent %} is enabled in all repositories by default, but you can block it from being used in repositories owned by your own personal account by changing your account settings. +{% data variables.copilot.copilot_cloud_agent %} is enabled in all repositories by default, but you can block it from being used in repositories owned by your own personal account by changing your account settings. {% data reusables.user-settings.copilot-settings %} 1. In the sidebar, under **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}**, click **Cloud agent**. -1. On the {% data variables.copilot.copilot_coding_agent %} page, under "Policies," click the dropdown button for "Repository access," then choose either **No repositories**, **All repositories**, or **Only selected repositories**. -1. If you choose **Only selected repositories**, click **Select repositories** and choose the repositories where you want to enable {% data variables.copilot.copilot_coding_agent %}. +1. On the {% data variables.copilot.copilot_cloud_agent %} page, under "Policies," click the dropdown button for "Repository access," then choose either **No repositories**, **All repositories**, or **Only selected repositories**. +1. If you choose **Only selected repositories**, click **Select repositories** and choose the repositories where you want to enable {% data variables.copilot.copilot_cloud_agent %}. -{% data reusables.copilot.coding-agent.enabling-for-orgs-and-enterprises %} +{% data reusables.copilot.cloud-agent.enabling-for-orgs-and-enterprises %} {% ifversion fpt %} @@ -63,12 +63,12 @@ You can choose whether to allow the following coding agents to be enabled in you * {% data variables.product.prodname_anthropic_claude %} * {% data variables.product.prodname_openai_codex %} -Coding agents have access to the same repositories that {% data variables.copilot.copilot_coding_agent %} has been enabled in. +Coding agents have access to the same repositories that {% data variables.copilot.copilot_cloud_agent %} has been enabled in. To enable coding agents: 1. Navigate to your account's [cloud agent settings](https://github.com/settings/copilot/coding_agent?ref_product=copilot&ref_type=engagement&ref_style=text&utm_source=docs-3p-agents-cca-settings-cta&utm_medium=docs&utm_campaign=agent-3p-platform-feb-2026). -1. On the {% data variables.copilot.copilot_coding_agent %} page, under "Partner agents", click the toggle to enable the third-party agent you want to use. +1. On the {% data variables.copilot.copilot_cloud_agent %} page, under "Partner agents", click the toggle to enable the third-party agent you want to use. ## Enabling or disabling web search for {% data variables.copilot.copilot_chat %} diff --git a/content/copilot/how-tos/provide-context/use-mcp/configure-toolsets.md b/content/copilot/how-tos/provide-context/use-mcp/configure-toolsets.md index f093ddb98f12..6c20155c1d1c 100644 --- a/content/copilot/how-tos/provide-context/use-mcp/configure-toolsets.md +++ b/content/copilot/how-tos/provide-context/use-mcp/configure-toolsets.md @@ -16,7 +16,7 @@ The {% data variables.product.github %} MCP server includes default toolsets (`r * **Enabling individual toolsets** such as `actions`, `code_security`, or `secret_protection` * **Using special keywords** like `all` to enable every available toolset, or [`default`](https://github.com/github/github-mcp-server?tab=readme-ov-file#default-toolset) to include the standard set alongside others (for example, `default,stargazers`) -* **Accessing remote-only toolsets** such as `copilot` (for {% data variables.copilot.copilot_coding_agent %}) and `github_support_docs_search`, which are only available on the remote MCP server +* **Accessing remote-only toolsets** such as `copilot` (for {% data variables.copilot.copilot_cloud_agent %}) and `github_support_docs_search`, which are only available on the remote MCP server * **Selecting specific tools** for granular control when you want to exclude specific tools or combine toolsets with individual tools For a complete list of available toolsets, see [Tools](https://github.com/github/github-mcp-server/blob/main/README.md#tools) in the `github/github-mcp-server` repository. For configuration examples, see [Server configuration](https://github.com/github/github-mcp-server/blob/main/docs/server-configuration.md). For a full introduction to the {% data variables.product.github %} MCP server and an overview of MCP, see [AUTOTITLE](/copilot/concepts/context/mcp). diff --git a/content/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp.md b/content/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp.md index 0bd4e2960ff8..a6b5ab6fe1ac 100644 --- a/content/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp.md +++ b/content/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp.md @@ -321,6 +321,6 @@ For more information on creating and configuring your own MCP servers, see [the ## Further reading * [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers) -* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/extending-copilot-coding-agent-with-mcp) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp) * [AUTOTITLE](/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server) * [AUTOTITLE](/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp) diff --git a/content/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server.md b/content/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server.md index e545e40c03e9..015977c8b737 100644 --- a/content/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server.md +++ b/content/copilot/how-tos/provide-context/use-mcp/use-the-github-mcp-server.md @@ -16,7 +16,7 @@ category: - Integrate Copilot with your tools --- -The {% data variables.product.github %} MCP server is available to all {% data variables.product.github %} users regardless of plan type. However, specific tools within the MCP server inherit the same access requirements as their corresponding {% data variables.product.github %} features. If a feature requires a paid {% data variables.product.github %} or {% data variables.product.prodname_copilot_short %} license, the equivalent MCP tool will require the same subscription. For example, tools that interact with {% data variables.copilot.copilot_coding_agent %} require a paid {% data variables.product.prodname_copilot_short %} license. +The {% data variables.product.github %} MCP server is available to all {% data variables.product.github %} users regardless of plan type. However, specific tools within the MCP server inherit the same access requirements as their corresponding {% data variables.product.github %} features. If a feature requires a paid {% data variables.product.github %} or {% data variables.product.prodname_copilot_short %} license, the equivalent MCP tool will require the same subscription. For example, tools that interact with {% data variables.copilot.copilot_cloud_agent %} require a paid {% data variables.product.prodname_copilot_short %} license. {% vscode %} @@ -204,4 +204,4 @@ The {% data variables.product.github %} MCP server in {% data variables.copilot. ## Further reading * [AUTOTITLE](/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp) -* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/extending-copilot-coding-agent-with-mcp) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp) diff --git a/content/copilot/how-tos/use-copilot-agents/cloud-agent/changing-the-ai-model.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/changing-the-ai-model.md new file mode 100644 index 000000000000..bde97aa16dbc --- /dev/null +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/changing-the-ai-model.md @@ -0,0 +1,37 @@ +--- +title: Changing the AI model for GitHub Copilot cloud agent +shortTitle: Changing the AI model +allowTitleToDifferFromFilename: true +intro: 'In supported entrypoints, when starting a task with {% data variables.copilot.copilot_cloud_agent %}, you can select the model used.' +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +versions: + feature: copilot +contentType: how-tos +category: + - Author and optimize with Copilot +redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/changing-the-ai-model +--- + +> [!NOTE] +> For an overview of {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). + +## Introduction + +In supported entrypoints, you can select the model used by {% data variables.copilot.copilot_cloud_agent %}. + +You may find that different models perform better, or provide more useful responses, depending on the type of tasks you give {% data variables.product.prodname_copilot_short %}. + +> [!NOTE] +> Model selection for {% data variables.copilot.copilot_cloud_agent %} is only supported when assigning an issue to {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}, when mentioning `@copilot` in a pull request comment on {% data variables.product.prodname_dotcom_the_website %}, or when starting a task from the agents tab, agents panel, {% data variables.product.prodname_mobile %} or the Raycast launcher. Where a model picker is not available, Auto will be used automatically. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). + +## Supported models + +The following options are currently available: + +* Auto +{% data reusables.copilot.copilot-cloud-agent-auto-models %} +{% data reusables.copilot.copilot-cloud-agent-non-auto-models %} + +{% data reusables.copilot.auto-model-option %} + diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/configuring-agent-settings.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/configuring-agent-settings.md similarity index 83% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/configuring-agent-settings.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/configuring-agent-settings.md index 103602819cb6..cac3a5780193 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/configuring-agent-settings.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/configuring-agent-settings.md @@ -2,17 +2,19 @@ title: Configuring settings for GitHub Copilot cloud agent shortTitle: Configuring agent settings allowTitleToDifferFromFilename: true -intro: 'Learn how to configure settings for {% data variables.copilot.copilot_coding_agent %}' +intro: 'Learn how to configure settings for {% data variables.copilot.copilot_cloud_agent %}' versions: feature: copilot contentType: how-tos category: - Configure Copilot +redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/configuring-agent-settings --- ## Enabling or disabling built-in code quality and security validation tools -{% data reusables.copilot.coding-agent-validation-tools-intro %} +{% data reusables.copilot.cloud-agent-validation-tools-intro %} Optionally, you can choose to disable these tools to help {% data variables.product.prodname_copilot_short %} work faster or avoid conflicts with other code quality or security products you're using. @@ -20,12 +22,12 @@ You must be a repository administrator to configure these settings. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_coding_agent_short_cap_c %}**. +1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_cloud_agent_short_cap_c %}**. 1. In the "Validation tools" section, toggle the tool, or tools, you want to enable or disable. ## Allowing {% data variables.product.prodname_actions %} workflows to run automatically when {% data variables.product.prodname_copilot_short %} pushes -{% data reusables.copilot.coding-agent-workflow-run-approval-default %} +{% data reusables.copilot.cloud-agent-workflow-run-approval-default %} > [!WARNING] Allowing {% data variables.product.prodname_actions %} workflows to run without approval may allow unreviewed code written by {% data variables.product.prodname_copilot_short %} to gain write access to your repository or access your {% data variables.product.prodname_actions %} secrets. @@ -33,5 +35,5 @@ You must be a repository administrator to configure these settings. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_coding_agent_short %}**. +1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_cloud_agent_short %}**. 1. In the "Actions workflow approval" section, disable the **Require approval for workflow runs** setting. diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr.md similarity index 90% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr.md index de0a317b47e7..5a919ad1a789 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr.md @@ -2,10 +2,11 @@ title: Asking GitHub Copilot to create a pull request shortTitle: Create a PR intro: 'You can ask {% data variables.product.prodname_copilot_short %} to create a pull request from many places, including {% data variables.product.prodname_github_issues %}, the agents panel, {% data variables.copilot.copilot_chat_short %}, the {% data variables.product.prodname_cli %}, and agentic coding tools and IDEs with Model Context Protocol (MCP) support.' -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/asking-copilot-to-create-a-pull-request - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/asking-copilot-to-create-a-pull-request - /copilot/using-github-copilot/coding-agent/asking-copilot-to-create-a-pull-request @@ -26,7 +27,7 @@ category: --- > [!NOTE] -> For an overview of {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent). +> For an overview of {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). ## Introduction @@ -43,7 +44,7 @@ You can ask {% data variables.product.prodname_copilot_short %} to create a new * The [Raycast](#asking-copilot-to-create-a-pull-request-from-raycast) launcher * The ["New repository" form](#asking-copilot-to-create-a-pull-request-from-the-new-repository-page) on {% data variables.product.github %} -{% data variables.product.prodname_copilot_short %} will start working on the task, raise a pull request, then request a review from you when it's finished working. For more information, see [AUTOTITLE](/copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot). +{% data variables.product.prodname_copilot_short %} will start working on the task, raise a pull request, then request a review from you when it's finished working. For more information, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). ## Assigning an issue to {% data variables.product.prodname_copilot_short %} @@ -72,11 +73,11 @@ You can assign an issue to {% data variables.product.prodname_copilot_short %}: 1. Click **Copilot** from assignees list. - ![Screenshot of "Assignees" window on an issue. Copilot is available in the list.](/assets/images/help/copilot/coding-agent/assign-to-copilot.png) + ![Screenshot of "Assignees" window on an issue. Copilot is available in the list.](/assets/images/help/copilot/cloud-agent/assign-to-copilot.png) Additional options are displayed. - ![Screenshot of "Assign to Copilot" dialog showing options for target repository, starting branch, {% data variables.copilot.copilot_custom_agent_short %}, and additional instructions.](/assets/images/help/copilot/coding-agent/assign-to-copilot-dialog.png) + ![Screenshot of "Assign to Copilot" dialog showing options for target repository, starting branch, {% data variables.copilot.copilot_custom_agent_short %}, and additional instructions.](/assets/images/help/copilot/cloud-agent/assign-to-copilot-dialog.png) 1. In the **Optional prompt** field you can add specific guidance for {% data variables.product.prodname_copilot_short %}. Add any context, constraints, or specific requirements that will help {% data variables.product.prodname_copilot_short %} to understand and complete the task. @@ -86,7 +87,7 @@ You can assign an issue to {% data variables.product.prodname_copilot_short %}: 1. You can use the dropdown menus in the dialog to change the repository that {% data variables.product.prodname_copilot_short %} will work in and the branch that it will branch off from. - All repositories where you have **at least** read access will be displayed in the repository dropdown menu. However, you can only select a repository if you have write access to it, **and** if {% data variables.copilot.copilot_coding_agent %} is enabled for that repository. + All repositories where you have **at least** read access will be displayed in the repository dropdown menu. However, you can only select a repository if you have write access to it, **and** if {% data variables.copilot.copilot_cloud_agent %} is enabled for that repository. If you select a repository in a different organization than the issue's source organization, or if you select a public repository when the issue is in a private repository, a warning will be displayed. @@ -96,7 +97,7 @@ You can assign an issue to {% data variables.product.prodname_copilot_short %}: > When you assign an issue to {% data variables.product.prodname_copilot_short %}, it gets sent the issue title, description, any comments that currently exist, and any additional instructions you provide. After assigning the issue, {% data variables.product.prodname_copilot_short %} will not be aware of, and therefore won't react to, any further comments that are added to the issue. If you have more information, or changes to the original requirement, add this as a comment in the pull request that {% data variables.product.prodname_copilot_short %} raises. {% data reusables.copilot.optional-select-custom-agent-dotcom %} -{% data reusables.copilot.optional-select-copilot-coding-agent-model %} +{% data reusables.copilot.optional-select-copilot-cloud-agent-model %} You can also assign issues to {% data variables.product.prodname_copilot_short %} from other places on {% data variables.product.prodname_dotcom_the_website %}: @@ -151,7 +152,7 @@ You can use the following GraphQL mutations to assign issues to {% data variable > > If using a {% data variables.product.pat_v1 %}, it needs the `repo` scope to assign {% data variables.product.prodname_copilot_short %} to an issue. -1. Verify that {% data variables.copilot.copilot_coding_agent %} is enabled in the repository by checking if the repository's `suggestedActors` in the GraphQL API includes {% data variables.product.prodname_copilot_short %}. Replace `octo-org` with the repository owner, and `octo-repo` with the repository name. +1. Verify that {% data variables.copilot.copilot_cloud_agent %} is enabled in the repository by checking if the repository's `suggestedActors` in the GraphQL API includes {% data variables.product.prodname_copilot_short %}. Replace `octo-org` with the repository owner, and `octo-repo` with the repository name. ```graphql copy query { @@ -174,7 +175,7 @@ You can use the following GraphQL mutations to assign issues to {% data variable } ``` - If {% data variables.copilot.copilot_coding_agent %} is enabled for the user and in the repository, the first node returned from the query will have the `login` value `copilot-swe-agent`. + If {% data variables.copilot.copilot_cloud_agent %} is enabled for the user and in the repository, the first node returned from the query will have the `login` value `copilot-swe-agent`. 1. Make a note of the `id` value of this login. @@ -221,7 +222,7 @@ You can use the following GraphQL mutations to assign issues to {% data variable ##### Assigning an existing issue 1. Make sure you're authenticating with the API using a user token, for example a {% data variables.product.pat_generic %} or a {% data variables.product.prodname_github_app %} user-to-server token. -1. Verify that {% data variables.copilot.copilot_coding_agent %} is enabled in the repository by checking if the repository's `suggestedActors` in the GraphQL API includes {% data variables.product.prodname_copilot_short %}. Replace `octo-org` with the repository owner, and `octo-repo` with the repository name. +1. Verify that {% data variables.copilot.copilot_cloud_agent %} is enabled in the repository by checking if the repository's `suggestedActors` in the GraphQL API includes {% data variables.product.prodname_copilot_short %}. Replace `octo-org` with the repository owner, and `octo-repo` with the repository name. ```graphql copy query { @@ -244,7 +245,7 @@ You can use the following GraphQL mutations to assign issues to {% data variable } ``` - If {% data variables.copilot.copilot_coding_agent %} is enabled for the user and in the repository, the first node returned from the query will have the `login` value `copilot-swe-agent`. + If {% data variables.copilot.copilot_cloud_agent %} is enabled for the user and in the repository, the first node returned from the query will have the `login` value `copilot-swe-agent`. 1. Fetch the GraphQL global ID of the issue you want to assign to {% data variables.product.prodname_copilot_short %}, replacing `monalisa` with the repository owner, `octocat` with the name and `9000` with the issue number. @@ -419,30 +420,30 @@ gh api \ ### Assigning an issue to {% data variables.product.prodname_copilot_short %} from Raycast -{% data reusables.copilot.coding-agent.raycast-intro %} +{% data reusables.copilot.cloud-agent.raycast-intro %} -{% data reusables.copilot.coding-agent.raycast-setup %} +{% data reusables.copilot.cloud-agent.raycast-setup %} 1. Open Raycast, search for "{% data variables.product.prodname_copilot_short %}," find the **Assign Issues to {% data variables.product.prodname_copilot_short %}** command, then press Enter. 1. Click **Sign in with {% data variables.product.github %}**, then complete the authentication flow. Raycast will re-open. 1. Select the repository you want {% data variables.product.prodname_copilot_short %} to work in. 1. Select the issue you want to assign to {% data variables.product.prodname_copilot_short %}. 1. Optionally, select a base branch for {% data variables.product.prodname_copilot_short %}'s pull request. {% data variables.product.prodname_copilot_short %} will create a new branch based on this branch, then push the changes to a pull request targeting that branch. {% data reusables.copilot.optional-select-custom-agent-generic %} -{% data reusables.copilot.optional-select-copilot-coding-agent-model %} +{% data reusables.copilot.optional-select-copilot-cloud-agent-model %} 1. Optionally, provide additional instructions. These will be passed to {% data variables.product.prodname_copilot_short %} alongside your issue contents. 1. Press Command+Enter (macOS) or Ctrl+Enter (Windows) to assign the issue. {% data variables.product.prodname_copilot_short %} will start a new session. {% data variables.product.prodname_copilot_short %} will work on the task and push changes to its pull request, then add you as a reviewer when it has finished, triggering a notification. -{% data reusables.copilot.coding-agent.raycast-oauth-access-restrictions %} +{% data reusables.copilot.cloud-agent.raycast-oauth-access-restrictions %} ## Asking {% data variables.product.prodname_copilot_short %} to create a pull request from the agents tab or panel You can ask {% data variables.product.prodname_copilot_short %} to open a pull request from either the agents tab or the agents panel. The only difference is the entry point - once you see the "New agent task" form, the steps are the same. {% data reusables.copilot.open-agents-panel-or-page %} -{% data reusables.copilot.coding-agent.new-agent-task-form-instructions %} +{% data reusables.copilot.cloud-agent.new-agent-task-form-instructions %} ## Asking {% data variables.product.prodname_copilot_short %} to create a pull request from the dashboard @@ -484,7 +485,7 @@ You can ask {% data variables.product.prodname_copilot_short %} to open a pull r ## Asking {% data variables.product.prodname_copilot_short %} to create a pull request from {% data variables.copilot.copilot_chat_short %} in JetBrains IDEs > [!NOTE] -> {% data variables.copilot.copilot_coding_agent %} in JetBrains IDEs is in {% data variables.release-phases.public_preview %}, and subject to change. +> {% data variables.copilot.copilot_cloud_agent %} in JetBrains IDEs is in {% data variables.release-phases.public_preview %}, and subject to change. 1. Open {% data variables.copilot.copilot_chat %} in your JetBrains IDE. 1. Type a prompt explaining what you want {% data variables.product.prodname_copilot_short %} to do @@ -498,7 +499,7 @@ You can ask {% data variables.product.prodname_copilot_short %} to open a pull r ## Asking {% data variables.product.prodname_copilot_short %} to create a pull request from {% data variables.copilot.copilot_chat_short %} in Eclipse > [!NOTE] -> {% data variables.copilot.copilot_coding_agent %} in Eclipse is in {% data variables.release-phases.public_preview %}, and subject to change. +> {% data variables.copilot.copilot_cloud_agent %} in Eclipse is in {% data variables.release-phases.public_preview %}, and subject to change. 1. Open {% data variables.copilot.copilot_chat %} in Eclipse. 1. Type a prompt explaining what you want {% data variables.product.prodname_copilot_short %} to do. @@ -512,9 +513,9 @@ You can ask {% data variables.product.prodname_copilot_short %} to open a pull r ## Asking {% data variables.product.prodname_copilot_short %} to create a pull request from {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vs %} 2026 -> [!NOTE] To use {% data variables.copilot.copilot_coding_agent %} in {% data variables.product.prodname_vs %}, you'll need to be running at least [December Update 18.1.0](https://learn.microsoft.com/en-us/visualstudio/releases/2026/release-notes#github-copilot-1) of {% data variables.product.prodname_vs %} 2026. +> [!NOTE] To use {% data variables.copilot.copilot_cloud_agent %} in {% data variables.product.prodname_vs %}, you'll need to be running at least [December Update 18.1.0](https://learn.microsoft.com/en-us/visualstudio/releases/2026/release-notes#github-copilot-1) of {% data variables.product.prodname_vs %} 2026. -1. Enable {% data variables.copilot.copilot_coding_agent %} support in {% data variables.product.prodname_vs %}. +1. Enable {% data variables.copilot.copilot_cloud_agent %} support in {% data variables.product.prodname_vs %}. 1. Open the **Tools** menu, then click **Options**. 1. In the sidebar, select **{% data variables.product.github %}**. 1. Check the **Enable Copilot Cloud agent (preview)** box. @@ -564,9 +565,9 @@ You can ask {% data variables.product.prodname_copilot_short %} to open a pull r > [!NOTE] > The `agent-task` command set is only available in v2.80.0 or later of the {% data variables.product.prodname_cli %}. This command set is a {% data variables.release-phases.public_preview %} and is subject to change. -You can start a new {% data variables.copilot.copilot_coding_agent %} session with the `gh agent-task create` command in the {% data variables.product.prodname_cli %}. +You can start a new {% data variables.copilot.copilot_cloud_agent %} session with the `gh agent-task create` command in the {% data variables.product.prodname_cli %}. -When you run the command without any arguments, you are asked to enter a prompt. {% data variables.copilot.copilot_coding_agent %} acts on the prompt and opens a pull request in the current repository. +When you run the command without any arguments, you are asked to enter a prompt. {% data variables.copilot.copilot_cloud_agent %} acts on the prompt and opens a pull request in the current repository. You can use command line options to: @@ -601,9 +602,9 @@ To see all of the available options, run `gh agent-task create --help`. ## Asking {% data variables.product.prodname_copilot_short %} to create a pull request from Raycast -{% data reusables.copilot.coding-agent.raycast-intro %} +{% data reusables.copilot.cloud-agent.raycast-intro %} -{% data reusables.copilot.coding-agent.raycast-setup %} +{% data reusables.copilot.cloud-agent.raycast-setup %} 1. Open Raycast, search for "{% data variables.product.prodname_copilot_short %}," find the **Create Task** command, then press Enter. 1. Click **Sign in with {% data variables.product.github %}**, then complete the authentication flow. Raycast will re-open. 1. Type a prompt describing what you want {% data variables.product.prodname_copilot_short %} to do. @@ -612,13 +613,13 @@ To see all of the available options, run `gh agent-task create --help`. 1. Select the repository you want {% data variables.product.prodname_copilot_short %} to work in. 1. Optionally, select a base branch for {% data variables.product.prodname_copilot_short %}'s pull request. {% data variables.product.prodname_copilot_short %} will create a new branch based on this branch, then push the changes to a pull request targeting that branch. {% data reusables.copilot.optional-select-custom-agent-generic %} -{% data reusables.copilot.optional-select-copilot-coding-agent-model %} +{% data reusables.copilot.optional-select-copilot-cloud-agent-model %} 1. Press Command+Enter (macOS) or Ctrl+Enter (Windows) to start the task. {% data variables.product.prodname_copilot_short %} will start a new session. {% data variables.product.prodname_copilot_short %} will work on the task and push changes to its pull request, then add you as a reviewer when it has finished, triggering a notification. -{% data reusables.copilot.coding-agent.raycast-oauth-access-restrictions %} +{% data reusables.copilot.cloud-agent.raycast-oauth-access-restrictions %} ## Asking {% data variables.product.prodname_copilot_short %} to create a pull request from the "New repository" page @@ -633,11 +634,11 @@ When creating a new repository, you can ask {% data variables.product.prodname_c {% data variables.product.prodname_copilot_short %} will immediately open a draft pull request. {% data variables.product.prodname_copilot_short %} will work on the task and push changes to its pull request, then add you as a reviewer when it has finished, triggering a notification. -{% data reusables.copilot.coding-agent.monitoring-progress-heading %} +{% data reusables.copilot.cloud-agent.monitoring-progress-heading %} ## Further reading -* [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent) -* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents) -* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent#copilot-cant-create-a-pull-request-from-copilot-chat) +* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent) +* [AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/troubleshoot-cloud-agent#copilot-cant-create-a-pull-request-from-copilot-chat) diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents.md similarity index 91% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents.md index 13e0a4a988d8..ced4a9130f51 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents.md @@ -1,17 +1,19 @@ --- -title: Creating custom agents for {% data variables.copilot.copilot_coding_agent %} +title: Creating custom agents for {% data variables.copilot.copilot_cloud_agent %} shortTitle: Create custom agents intro: You can create specialized agents with tailored expertise for specific development tasks. -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot category: - Configure Copilot - Author and optimize with Copilot contentType: how-tos +redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents --- -{% data variables.copilot.custom_agents_caps_short %} allow you to tailor {% data variables.product.prodname_copilot_short %}'s expertise for specific tasks. For a conceptual overview of {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents). +{% data variables.copilot.custom_agents_caps_short %} allow you to tailor {% data variables.product.prodname_copilot_short %}'s expertise for specific tasks. For a conceptual overview of {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-custom-agents). {% data reusables.copilot.custom-agents-ide-preview %} @@ -99,15 +101,15 @@ To configure your {% data variables.copilot.agent_profile %}: ## Using {% data variables.copilot.custom_agents_short %} -Once you've created a {% data variables.copilot.copilot_custom_agent_short %}, you can use it wherever {% data variables.copilot.copilot_coding_agent %} is available. +Once you've created a {% data variables.copilot.copilot_custom_agent_short %}, you can use it wherever {% data variables.copilot.copilot_cloud_agent %} is available. -* When prompting {% data variables.copilot.copilot_coding_agent %} with a task on {% data variables.product.prodname_dotcom_the_website %}, use the dropdown menu in the agents panel or agents tab to select your {% data variables.copilot.copilot_custom_agent_short %} instead of the default {% data variables.copilot.copilot_coding_agent_short %}. -* When assigning {% data variables.copilot.copilot_coding_agent %} to an issue, you can select your {% data variables.copilot.copilot_custom_agent_short %} from the dropdown menu to handle the issue with your specialized configuration. +* When prompting {% data variables.copilot.copilot_cloud_agent %} with a task on {% data variables.product.prodname_dotcom_the_website %}, use the dropdown menu in the agents panel or agents tab to select your {% data variables.copilot.copilot_custom_agent_short %} instead of the default {% data variables.copilot.copilot_cloud_agent_short %}. +* When assigning {% data variables.copilot.copilot_cloud_agent %} to an issue, you can select your {% data variables.copilot.copilot_custom_agent_short %} from the dropdown menu to handle the issue with your specialized configuration. * When using the {% data variables.copilot.copilot_cli %}, you can choose to use a particular {% data variables.copilot.copilot_custom_agent_short %} by using the `/agent` slash command or referencing the agent in a prompt or via a command-line argument. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents). When {% data variables.product.prodname_copilot_short %} opens pull requests, it will note which {% data variables.copilot.copilot_custom_agent_short %} was used to complete the work in the pull request description. -For more information on using {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr). +For more information on using {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). ### Using {% data variables.copilot.custom_agents_short %} in your IDE @@ -121,4 +123,4 @@ For more information on {% data variables.copilot.custom_agents_short %} in {% d * For a hands-on tutorial to create your first {% data variables.copilot.copilot_custom_agent_short %}, see [AUTOTITLE](/copilot/tutorials/customization-library/custom-agents/your-first-custom-agent). * For detailed configuration information, see [AUTOTITLE](/copilot/reference/custom-agents-configuration). -* For information on using cloud agents, including your {% data variables.copilot.custom_agents_short %}, to create pull requests, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr). +* For information on using cloud agents, including your {% data variables.copilot.custom_agents_short %}, to create pull requests, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/create-skills.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/create-skills.md similarity index 77% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/create-skills.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/create-skills.md index 699de056a290..e54f03ba5de4 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/create-skills.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/create-skills.md @@ -9,10 +9,12 @@ contentType: how-tos category: - Configure Copilot - Author and optimize with Copilot +redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/create-skills --- > [!NOTE] -> Agent skills work with {% data variables.copilot.copilot_coding_agent %}, the {% data variables.copilot.copilot_cli %}, and agent mode in {% data variables.product.prodname_vscode %}. +> Agent skills work with {% data variables.copilot.copilot_cloud_agent %}, the {% data variables.copilot.copilot_cli %}, and agent mode in {% data variables.product.prodname_vscode %}. Agent skills are folders of instructions, scripts, and resources that {% data variables.product.prodname_copilot_short %} can load when relevant to improve its performance in specialized tasks. For more information, see [AUTOTITLE](/copilot/concepts/agents/about-agent-skills). diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment.md similarity index 79% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment.md index e53917f499a6..32516b39d1ef 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment.md @@ -6,6 +6,7 @@ intro: 'Learn how to customize {% data variables.product.prodname_copilot %}''s versions: feature: copilot redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment - /early-access/copilot/coding-agent/customizing-copilot-coding-agents-development-environment - /copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent - /copilot/how-tos/agents/copilot-coding-agent/customizing-the-development-environment-for-copilot-coding-agent @@ -16,7 +17,7 @@ category: - Configure Copilot --- -## About customizing {% data variables.copilot.copilot_coding_agent %}'s development environment +## About customizing {% data variables.copilot.copilot_cloud_agent %}'s development environment While working on a task, {% data variables.product.prodname_copilot_short %} has access to its own ephemeral development environment, powered by {% data variables.product.prodname_actions %}, where it can explore your code, make changes, execute automated tests and linters and more. @@ -31,10 +32,10 @@ You can customize {% data variables.product.prodname_copilot_short %}'s developm In addition, you can: * [Set environment variables in {% data variables.product.prodname_copilot_short %}'s environment](#setting-environment-variables-in-copilots-environment) -* [Disable or customize the agent's firewall](/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent). +* [Disable or customize the agent's firewall](/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-cloud-agent). > [!NOTE] -> Organization owners can configure the default runner type for {% data variables.copilot.copilot_coding_agent %} across all repositories in their organization, and choose whether repositories are allowed to override this default. For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/configure-runner-for-coding-agent). +> Organization owners can configure the default runner type for {% data variables.copilot.copilot_cloud_agent %} across all repositories in their organization, and choose whether repositories are allowed to override this default. For more information, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/configure-runner-for-coding-agent). ## Customizing {% data variables.product.prodname_copilot_short %}'s development environment with {% data variables.product.prodname_copilot_short %} setup steps @@ -97,7 +98,7 @@ Your `copilot-setup-steps.yml` file will automatically be run as a normal {% dat Once you have merged the yml file into your default branch, you can manually run the workflow from the repository's **Actions** tab at any time to check that everything works as expected. For more information, see [AUTOTITLE](/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow). -When {% data variables.product.prodname_copilot_short %} starts work, your setup steps will be run, and updates will show in the session logs. See [AUTOTITLE](/copilot/how-tos/agents/copilot-coding-agent/tracking-copilots-sessions). +When {% data variables.product.prodname_copilot_short %} starts work, your setup steps will be run, and updates will show in the session logs. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions). If any setup step fails by returning a non-zero exit code, {% data variables.product.prodname_copilot_short %} will skip the remaining setup steps and begin working with the current state of its development environment. @@ -137,11 +138,11 @@ jobs: By default, {% data variables.product.prodname_copilot_short %} works in a standard {% data variables.product.prodname_actions %} runner. You can upgrade to larger runners for better performance (CPU and memory), more disk space and advanced features like Azure private networking. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/using-larger-runners/about-larger-runners). 1. Set up larger runners for your organization. For more information, see [AUTOTITLE](/actions/using-github-hosted-runners/managing-larger-runners). -1. If you are using larger runners with Azure private networking, configure your Azure private network to allow outbound access to the hosts required for {% data variables.copilot.copilot_coding_agent %}: +1. If you are using larger runners with Azure private networking, configure your Azure private network to allow outbound access to the hosts required for {% data variables.copilot.copilot_cloud_agent %}: - {% data reusables.copilot.coding-agent-required-hosts %} + {% data reusables.copilot.cloud-agent-required-hosts %} -1. Use a `copilot-setup-steps.yml` file in your repository to configure {% data variables.copilot.copilot_coding_agent %} to run on your chosen runners. Set the `runs-on` step of the `copilot-setup-steps` job to the label and/or group for the larger runners you want {% data variables.product.prodname_copilot_short %} to use. For more information on specifying larger runners with `runs-on`, see [AUTOTITLE](/actions/using-github-hosted-runners/running-jobs-on-larger-runners). +1. Use a `copilot-setup-steps.yml` file in your repository to configure {% data variables.copilot.copilot_cloud_agent %} to run on your chosen runners. Set the `runs-on` step of the `copilot-setup-steps` job to the label and/or group for the larger runners you want {% data variables.product.prodname_copilot_short %} to use. For more information on specifying larger runners with `runs-on`, see [AUTOTITLE](/actions/using-github-hosted-runners/running-jobs-on-larger-runners). ```yaml # ... @@ -153,24 +154,24 @@ By default, {% data variables.product.prodname_copilot_short %} works in a stand ``` > [!NOTE] -> * {% data variables.copilot.copilot_coding_agent %} is only compatible with Ubuntu x64 Linux and Windows 64-bit runners. Runners with macOS or other operating systems are not supported. +> * {% data variables.copilot.copilot_cloud_agent %} is only compatible with Ubuntu x64 Linux and Windows 64-bit runners. Runners with macOS or other operating systems are not supported. ## Using self-hosted {% data variables.product.prodname_actions %} runners -You can run {% data variables.copilot.copilot_coding_agent %} on self-hosted runners. You may want to do this to match how you run CI/CD workflows on {% data variables.product.prodname_actions %}, or to give {% data variables.product.prodname_copilot_short %} access to internal resources on your network. +You can run {% data variables.copilot.copilot_cloud_agent %} on self-hosted runners. You may want to do this to match how you run CI/CD workflows on {% data variables.product.prodname_actions %}, or to give {% data variables.product.prodname_copilot_short %} access to internal resources on your network. -We recommend that you only use {% data variables.copilot.copilot_coding_agent %} with ephemeral, single-use runners that are not reused for multiple jobs. Most customers set this up using ARC (Actions Runner Controller) or the {% data variables.product.prodname_actions %} Runner Scale Set Client. For more information, see [AUTOTITLE](/actions/reference/runners/self-hosted-runners#supported-autoscaling-solutions). +We recommend that you only use {% data variables.copilot.copilot_cloud_agent %} with ephemeral, single-use runners that are not reused for multiple jobs. Most customers set this up using ARC (Actions Runner Controller) or the {% data variables.product.prodname_actions %} Runner Scale Set Client. For more information, see [AUTOTITLE](/actions/reference/runners/self-hosted-runners#supported-autoscaling-solutions). > [!NOTE] -> {% data variables.copilot.copilot_coding_agent %} is only compatible with Ubuntu x64 and Windows 64-bit runners. Runners with macOS or other operating systems are not supported. +> {% data variables.copilot.copilot_cloud_agent %} is only compatible with Ubuntu x64 and Windows 64-bit runners. Runners with macOS or other operating systems are not supported. -1. Configure network security controls for your {% data variables.product.prodname_actions %} runners to ensure that {% data variables.copilot.copilot_coding_agent %} does not have open access to your network or the public internet. +1. Configure network security controls for your {% data variables.product.prodname_actions %} runners to ensure that {% data variables.copilot.copilot_cloud_agent %} does not have open access to your network or the public internet. You must configure your firewall to allow connections to the [standard hosts required for {% data variables.product.prodname_actions %} self-hosted runners](/actions/reference/runners/self-hosted-runners#accessible-domains-by-function), plus the following hosts: - {% data reusables.copilot.coding-agent-required-hosts %} + {% data reusables.copilot.cloud-agent-required-hosts %} -1. Disable {% data variables.copilot.copilot_coding_agent %}'s integrated firewall in your repository settings. The firewall is not compatible with self-hosted runners. Unless this is disabled, use of {% data variables.copilot.copilot_coding_agent %} will be blocked. For more information, see [AUTOTITLE](/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent). +1. Disable {% data variables.copilot.copilot_cloud_agent %}'s integrated firewall in your repository settings. The firewall is not compatible with self-hosted runners. Unless this is disabled, use of {% data variables.copilot.copilot_cloud_agent %} will be blocked. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall). 1. In your `copilot-setup-steps.yml` file, set the `runs-on` attribute to your ARC-managed scale set name: ```yaml @@ -182,7 +183,7 @@ We recommend that you only use {% data variables.copilot.copilot_coding_agent %} # ... ``` -1. If you want to configure a proxy server for {% data variables.copilot.copilot_coding_agent %}'s connections to the internet, configure the following environment variables as appropriate: +1. If you want to configure a proxy server for {% data variables.copilot.copilot_cloud_agent %}'s connections to the internet, configure the following environment variables as appropriate: {% data reusables.actions.actions-proxy-environment-variables-table %} | `ssl_cert_file` | The path to the SSL certificate presented by your proxy server. You will need to configure this if your proxy intercepts SSL connections. | `/path/to/key.pem` | @@ -196,7 +197,7 @@ By default, {% data variables.product.prodname_copilot_short %} uses an Ubuntu L You may want to use a Windows development environment if you're building software for Windows or your repository uses a Windows-based toolchain so {% data variables.product.prodname_copilot_short %} can build your project, run tests and validate its work. -{% data variables.copilot.copilot_coding_agent %}'s integrated firewall is not compatible with Windows, so we recommend that you only use self-hosted runners or larger {% data variables.product.prodname_dotcom %}-hosted runners with Azure private networking where you can implement your own network controls. For more information on runners with Azure private networking, see [AUTOTITLE](/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/about-azure-private-networking-for-github-hosted-runners-in-your-enterprise). +{% data variables.copilot.copilot_cloud_agent %}'s integrated firewall is not compatible with Windows, so we recommend that you only use self-hosted runners or larger {% data variables.product.prodname_dotcom %}-hosted runners with Azure private networking where you can implement your own network controls. For more information on runners with Azure private networking, see [AUTOTITLE](/admin/configuring-settings/configuring-private-networking-for-hosted-compute-products/about-azure-private-networking-for-github-hosted-runners-in-your-enterprise). To use Windows with self-hosted runners, follow the instructions in the [Using self-hosted {% data variables.product.prodname_actions %} runners](#using-self-hosted-github-actions-runners) section above, using the label for your Windows runners. To use Windows with larger {% data variables.product.prodname_dotcom %}-hosted runners, follow the instructions in the [Upgrading to larger runners](#upgrading-to-larger-github-hosted-github-actions-runners) section above, using the label for your Windows runners. @@ -235,4 +236,4 @@ To set an environment variable for {% data variables.product.prodname_copilot_sh ## Further reading -* [AUTOTITLE](/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall) diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-firewall.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall.md similarity index 90% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-firewall.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall.md index 7e79140740d1..daa3b75f5a09 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-firewall.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall.md @@ -2,10 +2,11 @@ title: Customizing or disabling the firewall for GitHub Copilot cloud agent shortTitle: Customize the agent firewall allowTitleToDifferFromFilename: true -intro: 'Learn how to control the domains and URLs that {% data variables.copilot.copilot_coding_agent %} can access.' +intro: 'Learn how to control the domains and URLs that {% data variables.copilot.copilot_cloud_agent %} can access.' versions: feature: copilot redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-firewall - /copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent - /copilot/how-tos/agents/copilot-coding-agent/customizing-or-disabling-the-firewall-for-copilot-coding-agent - /copilot/how-tos/agents/copilot-coding-agent/customize-the-agent-firewall @@ -15,6 +16,9 @@ category: - Configure Copilot --- +> [!NOTE] +> Firewall configuration has moved to the {% data variables.copilot.copilot_cloud_agent %} settings page. Previous configurations saved as Actions variables will be maintained on that page. + ## Overview By default, {% data variables.product.prodname_copilot_short %}'s access to the internet is limited by a firewall. @@ -25,7 +29,7 @@ The firewall always allows access to a number of hosts that {% data variables.pr If {% data variables.product.prodname_copilot_short %} tries to make a request which is blocked by the firewall, a warning is added to the pull request body (if {% data variables.product.prodname_copilot_short %} is creating a pull request for the first time) or to a comment (if {% data variables.product.prodname_copilot_short %} is responding to a pull request comment). The warning shows the blocked address and the command that tried to make the request. -![Screenshot of a warning from {% data variables.product.prodname_copilot_short %} about being blocked by the firewall.](/assets/images/help/copilot/coding-agent/firewall-warning.png) +![Screenshot of a warning from {% data variables.product.prodname_copilot_short %} about being blocked by the firewall.](/assets/images/help/copilot/cloud-agent/firewall-warning.png) ## Limitations @@ -47,7 +51,7 @@ The recommended allowlist, enabled by default, allows access to: * Common certificate authorities (to allow SSL certificates to be validated). * Hosts used to download web browsers for the Playwright MCP server. -For the complete list of hosts included in the recommended allowlist, see [AUTOTITLE](/copilot/reference/copilot-allowlist-reference#copilot-coding-agent-recommended-allowlist). +For the complete list of hosts included in the recommended allowlist, see [AUTOTITLE](/copilot/reference/copilot-allowlist-reference#copilot-cloud-agent-recommended-allowlist). ## Configuring the firewall at the organization level @@ -55,7 +59,7 @@ Organization owners can configure all firewall settings at the organization leve {% data reusables.profile.access_org %} {% data reusables.profile.org_settings %} -{% data reusables.copilot.coding-agent-settings %} +{% data reusables.copilot.cloud-agent-settings %} ### Enabling or disabling the firewall @@ -79,7 +83,7 @@ By default, repository administrators can add their own entries to the firewall Items added to the organization custom allowlist apply to all repositories in the organization. These items cannot be deleted at the repository level. Organization-level and repository-level rules are combined. 1. Under "Internet access", click **Organization custom allowlist**. -{% data reusables.copilot.coding-agent.custom-allowlist-add-entries %} +{% data reusables.copilot.cloud-agent.custom-allowlist-add-entries %} ## Configuring the firewall at the repository level @@ -89,7 +93,7 @@ To access the firewall settings: {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_coding_agent_short %}**. +1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_cloud_agent_short %}**. ### Enabling or disabling the firewall @@ -111,9 +115,9 @@ To access the firewall settings: > You can only add custom allowlist rules at the repository level if the organization-level **Allow repository custom rules** setting is set to **Enabled**. For more information, see [Controlling whether repositories can add custom allowlist rules](#controlling-whether-repositories-can-add-custom-allowlist-rules). 1. Click **Custom allowlist**. -{% data reusables.copilot.coding-agent.custom-allowlist-add-entries %} +{% data reusables.copilot.cloud-agent.custom-allowlist-add-entries %} ## Further reading * [AUTOTITLE](/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#creating-configuration-variables-for-a-repository) -* [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment) diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp.md similarity index 91% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp.md index af7e2af26476..2266a05e7389 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp.md @@ -2,10 +2,11 @@ title: Extending GitHub Copilot cloud agent with the Model Context Protocol (MCP) shortTitle: Extend cloud agent with MCP allowTitleToDifferFromFilename: true -intro: 'Learn how to use the Model Context Protocol (MCP) to extend the capabilities of {% data variables.copilot.copilot_coding_agent %}.' +intro: 'Learn how to use the Model Context Protocol (MCP) to extend the capabilities of {% data variables.copilot.copilot_cloud_agent %}.' versions: feature: copilot redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp - /copilot/customizing-copilot/using-model-context-protocol/extending-copilot-coding-agent-with-mcp - /copilot/customizing-copilot/extending-copilot-coding-agent-with-mcp - /early-access/copilot/coding-agent/extending-copilot-coding-agent-with-model-context-protocol @@ -20,7 +21,7 @@ category: ## Prerequisite -Before setting up an MCP server for {% data variables.copilot.copilot_coding_agent %}, read [AUTOTITLE](/copilot/concepts/coding-agent/mcp-and-coding-agent) to make sure you understand the concepts around MCP servers and {% data variables.copilot.copilot_coding_agent %}. +Before setting up an MCP server for {% data variables.copilot.copilot_cloud_agent %}, read [AUTOTITLE](/copilot/concepts/agents/cloud-agent/mcp-and-cloud-agent) to make sure you understand the concepts around MCP servers and {% data variables.copilot.copilot_cloud_agent %}. ## Introduction @@ -31,7 +32,7 @@ Organization and enterprise administrators can also configure MCP servers as par > [!WARNING] > Once you've configured an MCP server, {% data variables.product.prodname_copilot_short %} will be able to use the tools provided by the server autonomously, and will not ask for your approval before using them. -{% data reusables.copilot.mcp.coding-agent-limitations %} +{% data reusables.copilot.mcp.cloud-agent-limitations %} ## Adding an MCP configuration to your repository @@ -39,7 +40,7 @@ Repository administrators can configure MCP servers by following these steps: {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_coding_agent_short_cap_c %}**. +1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_cloud_agent_short_cap_c %}**. 1. Add your configuration in the **MCP configuration** section. The following sections in this article explain how to write the JSON configuration that you need to enter here. @@ -48,7 +49,7 @@ Repository administrators can configure MCP servers by following these steps: Your configuration will be validated to ensure proper syntax. -1. If your MCP server requires a variable, key, or secret, add a variable or secret to your {% data variables.product.prodname_copilot_short %} environment. Only variables and secrets with names prefixed with `COPILOT_MCP_` will be available to your MCP configuration. See [Setting up a {% data variables.product.prodname_copilot_short %} environment for {% data variables.copilot.copilot_coding_agent %}](#setting-up-a-copilot-environment-for-copilot-coding-agent). +1. If your MCP server requires a variable, key, or secret, add a variable or secret to your {% data variables.product.prodname_copilot_short %} environment. Only variables and secrets with names prefixed with `COPILOT_MCP_` will be available to your MCP configuration. See [Setting up a {% data variables.product.prodname_copilot_short %} environment for {% data variables.copilot.copilot_cloud_agent %}](#setting-up-a-copilot-environment-for-copilot-cloud-agent). ## Writing a JSON configuration for MCP servers @@ -76,7 +77,7 @@ The configuration object can contain the following keys: **Required keys for local and remote MCP servers** * `tools` (`string[]`): The tools from the MCP server to enable. You may be able to find a list of tools in the server's documentation, or in its code. We strongly recommend that you allowlist specific read-only tools, since the agent will be able to use these tools autonomously and will not ask you for approval first. You can also enable all tools by including `*` in the array. -* `type` (`string`): {% data variables.copilot.copilot_coding_agent %} accepts `"local"`, `"stdio"`, `"http"`, or `"sse"`. +* `type` (`string`): {% data variables.copilot.copilot_cloud_agent %} accepts `"local"`, `"stdio"`, `"http"`, or `"sse"`. **Local MCP specific keys** * `command` (`string`): Required. The command to run to start the MCP server. @@ -177,7 +178,7 @@ The [Notion MCP server](https://github.com/makenotion/notion-mcp-server) gives { The [Microsoft MCP repository](https://github.com/microsoft/mcp) includes the Azure MCP server, which allows {% data variables.product.prodname_copilot_short %} to understand your Azure-specific files and Azure resources within your subscription when making code changes. -To automatically configure your repository with a `copilot-setup-steps.yml` file to authenticate with Azure, plus secrets for authentication, clone the repository locally then run the [Azure Developer CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/?ref_product=copilot&ref_type=engagement&ref_style=button)'s `azd coding-agent config` command in the root of the repository. +To automatically configure your repository with a `copilot-setup-steps.yml` file to authenticate with Azure, plus secrets for authentication, clone the repository locally then run the [Azure Developer CLI](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/?ref_product=copilot&ref_type=engagement&ref_style=button)'s `azd cloud-agent config` command in the root of the repository. Once you've run the command and merged the created pull request, you can add the MCP configuration to your repository. @@ -219,7 +220,7 @@ The [Cloudflare MCP server](https://github.com/cloudflare/mcp-server-cloudflare) The [Azure DevOps MCP server](https://github.com/microsoft/azure-devops-mcp) creates a seamless connection between {% data variables.product.prodname_copilot_short %} and your Azure DevOps services, including work items, pipelines or documentation. -To use the Azure DevOps MCP server with {% data variables.copilot.copilot_coding_agent %}, you must update the repository's copilot-setup-steps.yml file to include an Azure login workflow step. +To use the Azure DevOps MCP server with {% data variables.copilot.copilot_cloud_agent %}, you must update the repository's copilot-setup-steps.yml file to include an Azure login workflow step. 1. Configure OIDC in a Microsoft Entra application, trusting {% data variables.product.github %}. See [Use the Azure Login action with OpenID Connect](https://learn.microsoft.com/en-us/azure/developer/github/connect-from-azure-openid-connect). 1. Setup access to Azure DevOps organization and projects for the application identity. See [Add organization users and manage access](https://learn.microsoft.com/en-us/azure/devops/organizations/accounts/add-organization-users). @@ -249,9 +250,9 @@ To use the Azure DevOps MCP server with {% data variables.copilot.copilot_coding allow-no-subscriptions: true ``` - This configuration ensures the `azure/login` action is executed when {% data variables.copilot.copilot_coding_agent %} runs. + This configuration ensures the `azure/login` action is executed when {% data variables.copilot.copilot_cloud_agent %} runs. 1. In your repository’s {% data variables.product.prodname_copilot_short %} environment, add secrets for your `AZURE_CLIENT_ID` and `AZURE_TENANT_ID`. -1. Configure the Azure DevOps MCP server by adding an `ado` object to your MCP configuration with defined tools you want {% data variables.copilot.copilot_coding_agent %} to use. +1. Configure the Azure DevOps MCP server by adding an `ado` object to your MCP configuration with defined tools you want {% data variables.copilot.copilot_cloud_agent %} to use. ```json copy { @@ -301,11 +302,11 @@ For more information about authenticating to the Atlassian MCP server using an A ## Reusing your MCP configuration from {% data variables.product.prodname_vscode %} -If you have already configured MCP servers in {% data variables.product.prodname_vscode_shortname %}, you can leverage a similar configuration for {% data variables.copilot.copilot_coding_agent %}. +If you have already configured MCP servers in {% data variables.product.prodname_vscode_shortname %}, you can leverage a similar configuration for {% data variables.copilot.copilot_cloud_agent %}. Depending on how {% data variables.product.prodname_vscode_shortname %} is configured, you may be able to find your MCP settings in your repository's `.vscode/mcp.json` file, or in your machine's private `settings.json` file. -To adapt the configuration for {% data variables.copilot.copilot_coding_agent %}, you will need to: +To adapt the configuration for {% data variables.copilot.copilot_cloud_agent %}, you will need to: 1. Add a `tools` key for each MCP server, specifying which tools will be available to {% data variables.product.prodname_copilot_short %}. 1. If you've configured `inputs`, switch to using `env` directly. @@ -314,9 +315,9 @@ To adapt the configuration for {% data variables.copilot.copilot_coding_agent %} For more information on MCP in {% data variables.product.prodname_vscode_shortname %}, see the [{% data variables.product.prodname_vscode_shortname %} docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers). -## Setting up a {% data variables.product.prodname_copilot_short %} environment for {% data variables.copilot.copilot_coding_agent %} +## Setting up a {% data variables.product.prodname_copilot_short %} environment for {% data variables.copilot.copilot_cloud_agent %} -Some MCP servers will require keys or secrets. To leverage those servers in {% data variables.copilot.copilot_coding_agent %}, you can add secrets to an environment for {% data variables.product.prodname_copilot_short %}. This ensures the secrets are properly recognized and passed to the applicable MCP server that you have configured. +Some MCP servers will require keys or secrets. To leverage those servers in {% data variables.copilot.copilot_cloud_agent %}, you can add secrets to an environment for {% data variables.product.prodname_copilot_short %}. This ensures the secrets are properly recognized and passed to the applicable MCP server that you have configured. You must be a repository administrator to configure a {% data variables.product.prodname_copilot_short %} environment for your repository. @@ -336,12 +337,12 @@ Once you've set up your MCP configuration, you should test it to make sure it is 1. Wait a few seconds, and {% data variables.product.prodname_copilot_short %} will leave an 👀 reaction on the issue. 1. Wait a few more seconds, and {% data variables.product.prodname_copilot_short %} will create a pull request, which will appear in the issue's timeline. 1. Click the created pull request in the timeline, and wait until a "Copilot started work" timeline event appears. -1. Click **View session** to open the {% data variables.copilot.copilot_coding_agent %} logs. +1. Click **View session** to open the {% data variables.copilot.copilot_cloud_agent %} logs. 1. Click the ellipsis button (**...**) at the top right of the log viewer, then click **{% data variables.product.prodname_copilot_short %}** in the sidebar. 1. Click the **Start MCP Servers** step to expand the logs. 1. If your MCP servers have been started successfully, you will see their tools listed at the bottom of the logs. -If your MCP servers require any dependencies that are not installed on the {% data variables.product.prodname_actions %} runner by default, such as `uv` and `pipx`, or that need special setup steps, you may need to create a `copilot-setup-steps.yml` Actions workflow file to install them. For more information, see [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent). +If your MCP servers require any dependencies that are not installed on the {% data variables.product.prodname_actions %} runner by default, such as `uv` and `pipx`, or that need special setup steps, you may need to create a `copilot-setup-steps.yml` Actions workflow file to install them. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment). ## Customizing the built-in {% data variables.product.github %} MCP server @@ -352,7 +353,7 @@ If you want to allow {% data variables.product.prodname_copilot_short %} to acce 1. Create a {% data variables.product.pat_generic %} with the appropriate permissions. We recommend using a {% data variables.product.pat_v2 %}, where you can limit the token's access to read-only permissions on specific repositories. For more information on {% data variables.product.pat_generic_plural %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} -1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_coding_agent_short_cap_c %}**. +1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_cloud_agent_short_cap_c %}**. 1. Add your configuration in the **MCP configuration** section. For example, you can add the following: ```javascript copy @@ -387,6 +388,6 @@ For information on using the {% data variables.product.github %} MCP server in o ## Next steps * [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents) -* [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment) * [AUTOTITLE](/copilot/customizing-copilot/extending-copilot-chat-with-mcp) diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/index.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/index.md similarity index 65% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/index.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/index.md index facd9ce62fc8..e4d68c308282 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/index.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/index.md @@ -1,6 +1,6 @@ --- title: GitHub Copilot cloud agent -shortTitle: '{% data variables.copilot.copilot_coding_agent_short_cap_c %}' +shortTitle: '{% data variables.copilot.copilot_cloud_agent_short_cap_c %}' allowTitleToDifferFromFilename: true intro: 'Find out how {% data variables.product.prodname_copilot_short %} can research a repository, plan and make code changes, and create pull requests for you to review.' versions: @@ -15,19 +15,20 @@ children: - /create-custom-agents - /test-custom-agents - /create-skills - - /extend-coding-agent-with-mcp - - /integrate-coding-agent-with-jira - - /integrate-coding-agent-with-slack - - /integrate-coding-agent-with-teams - - /integrate-coding-agent-with-linear - - /integrate-coding-agent-with-azure-boards + - /extend-cloud-agent-with-mcp + - /integrate-cloud-agent-with-jira + - /integrate-cloud-agent-with-slack + - /integrate-cloud-agent-with-teams + - /integrate-cloud-agent-with-linear + - /integrate-cloud-agent-with-azure-boards - /changing-the-ai-model - /configuring-agent-settings - /customize-the-agent-environment - /customize-the-agent-firewall - /use-hooks - - /troubleshoot-coding-agent + - /troubleshoot-cloud-agent redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues - /early-access/copilot/coding-agent @@ -37,4 +38,4 @@ redirect_from: contentType: how-tos --- -These articles provide how-to information for using {% data variables.copilot.copilot_coding_agent %}. For an overview of {% data variables.copilot.copilot_coding_agent %}, see the articles under [AUTOTITLE](/copilot/concepts/agents/coding-agent). +These articles provide how-to information for using {% data variables.copilot.copilot_cloud_agent %}. For an overview of {% data variables.copilot.copilot_cloud_agent %}, see the articles under [AUTOTITLE](/copilot/concepts/agents/cloud-agent). diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-azure-boards.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-azure-boards.md similarity index 74% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-azure-boards.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-azure-boards.md index c7d6707b4d0b..93e31c870c50 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-azure-boards.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-azure-boards.md @@ -2,26 +2,28 @@ title: Integrating Copilot cloud agent with Azure Boards shortTitle: Integrate cloud agent with Azure Boards allowTitleToDifferFromFilename: true -intro: 'Use the {% data variables.product.prodname_copilot_short %} integration in Azure Boards to send work items directly to {% data variables.copilot.copilot_coding_agent %} and generate pull requests, all from within your Azure DevOps workspace.' +intro: 'Use the {% data variables.product.prodname_copilot_short %} integration in Azure Boards to send work items directly to {% data variables.copilot.copilot_cloud_agent %} and generate pull requests, all from within your Azure DevOps workspace.' versions: feature: copilot contentType: how-tos category: - Integrate Copilot with your tools +redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-azure-boards --- -The Azure Boards {% data variables.product.github %} integration allows you to invoke {% data variables.copilot.copilot_coding_agent %} without leaving your workspace. From within a Azure Boards work item you can initiate {% data variables.copilot.copilot_coding_agent_short %} sessions and open pull requests, using the context of your work item description and comments. +The Azure Boards {% data variables.product.github %} integration allows you to invoke {% data variables.copilot.copilot_cloud_agent %} without leaving your workspace. From within a Azure Boards work item you can initiate {% data variables.copilot.copilot_cloud_agent_short %} sessions and open pull requests, using the context of your work item description and comments. For information about additional {% data variables.product.prodname_copilot_short %} integrations, see [AUTOTITLE](/copilot/concepts/tools/about-copilot-integrations). > [!NOTE] -> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-coding-agent). -> * When you send a work item to {% data variables.copilot.copilot_coding_agent %}, the agent will capture content from text fields (such as the description and reproduction steps), along with the last 50 comments. This context is stored in the pull request, and is visible to anyone with access to the repository. +> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-cloud-agent). +> * When you send a work item to {% data variables.copilot.copilot_cloud_agent %}, the agent will capture content from text fields (such as the description and reproduction steps), along with the last 50 comments. This context is stored in the pull request, and is visible to anyone with access to the repository. ## Prerequisites * You must have a {% data variables.product.github %} account with access to {% data variables.product.prodname_copilot_short %} through {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, {% data variables.copilot.copilot_business_short %}, or {% data variables.copilot.copilot_enterprise_short %}. -* The repositories connected to the Azure DevOps project must have {% data variables.copilot.copilot_coding_agent %} enabled. +* The repositories connected to the Azure DevOps project must have {% data variables.copilot.copilot_cloud_agent %} enabled. ## Installing the Azure Boards application on {% data variables.product.github %} @@ -46,7 +48,7 @@ If you already have the Azure Boards application installed on {% data variables. ## Creating a pull request from a work item -1. In Azure Boards, open the work item you want to send to {% data variables.copilot.copilot_coding_agent %}. +1. In Azure Boards, open the work item you want to send to {% data variables.copilot.copilot_cloud_agent %}. 1. Click the {% octicon "copilot" aria-label="Copilot" %} icon on the work item. 1. Select **Create a pull request with {% data variables.product.prodname_copilot_short %}**. 1. Under **{% data variables.product.github %} repository**, select the repository where {% data variables.product.prodname_copilot_short %} should create the pull request. @@ -54,9 +56,9 @@ If you already have the Azure Boards application installed on {% data variables. 1. Optionally, add any additional instructions to provide {% data variables.product.prodname_copilot_short %} with more context. 1. Click **Create**. -{% data variables.copilot.copilot_coding_agent %} will begin processing the work item and create a draft pull request linked back to the work item. +{% data variables.copilot.copilot_cloud_agent %} will begin processing the work item and create a draft pull request linked back to the work item. ## Further reading -* [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-coding-agent) -* [AUTOTITLE](/copilot/concepts/agents/coding-agent/access-management) +* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent) +* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/access-management) diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-jira.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-jira.md similarity index 78% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-jira.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-jira.md index 417b038cee7e..5fc8c6281c33 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-jira.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-jira.md @@ -6,6 +6,7 @@ intro: 'You can use the {% data variables.product.github %} integration in Jira versions: feature: copilot redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-jira - /early-access/copilot/integrate-coding-agent-with-jira contentType: how-tos category: @@ -14,10 +15,10 @@ category: > [!NOTE] > * This feature is currently in {% data variables.release-phases.public_preview %} and subject to change. -> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-coding-agent). +> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-cloud-agent). > * You can provide feedback about the {% data variables.product.prodname_copilot %} for Jira integration in the [{% data variables.product.github %} survey](https://www.surveymonkey.com/r/CCAforJira). -The {% data variables.product.prodname_copilot %} integration in Jira allows you to invoke {% data variables.copilot.copilot_coding_agent %} without leaving your Jira workspace. From within a Jira work item you can initiate {% data variables.copilot.copilot_coding_agent_short %} sessions and open pull requests, using the context of the work item's title, description, labels, and comments. +The {% data variables.product.prodname_copilot %} integration in Jira allows you to invoke {% data variables.copilot.copilot_cloud_agent %} without leaving your Jira workspace. From within a Jira work item you can initiate {% data variables.copilot.copilot_cloud_agent_short %} sessions and open pull requests, using the context of the work item's title, description, labels, and comments. ## Prerequisites @@ -79,24 +80,24 @@ To enable the {% data variables.product.prodname_copilot %} for Jira app for an The {% data variables.product.prodname_copilot_short %} app must be enabled for a {% data variables.product.github %} organization you are a member of, before you can start using it. -The first time you use {% data variables.copilot.copilot_coding_agent %} in Jira, you will need to connect it to your {% data variables.product.github %} account. +The first time you use {% data variables.copilot.copilot_cloud_agent %} in Jira, you will need to connect it to your {% data variables.product.github %} account. -Only users with **write** access to a repository can trigger {% data variables.copilot.copilot_coding_agent %} to work in that repository. +Only users with **write** access to a repository can trigger {% data variables.copilot.copilot_cloud_agent %} to work in that repository. -You can trigger {% data variables.copilot.copilot_coding_agent %} in three ways: +You can trigger {% data variables.copilot.copilot_cloud_agent %} in three ways: * **Assign** {% data variables.product.prodname_copilot %} to a work item using the Assignee field. * **Mention** `@{% data variables.product.prodname_copilot %}` in a comment on a work item. * **Add {% data variables.product.prodname_copilot_short %} to a workflow transition** so it is triggered automatically when a work item moves to a specific status. See [Collaborate on work items with AI agents](https://support.atlassian.com/jira-software-cloud/docs/collaborate-on-work-items-with-ai-agents/#Add-an-agent-to-workflow-transitions) for setup instructions. -To change the model used by {% data variables.copilot.copilot_coding_agent %} for a specific task, include the model name in your instructions to {% data variables.product.prodname_copilot_short %}. For example, you can say `@{% data variables.product.prodname_copilot %} use Claude Sonnet 4.5 to create a new API endpoint for user authentication in octo-org/octorepo`. If you do not specify a model, {% data variables.copilot.copilot_coding_agent %} will use the default model for coding tasks, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/changing-the-ai-model). +To change the model used by {% data variables.copilot.copilot_cloud_agent %} for a specific task, include the model name in your instructions to {% data variables.product.prodname_copilot_short %}. For example, you can say `@{% data variables.product.prodname_copilot %} use Claude Sonnet 4.5 to create a new API endpoint for user authentication in octo-org/octorepo`. If you do not specify a model, {% data variables.copilot.copilot_cloud_agent %} will use the default model for coding tasks, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/changing-the-ai-model). > [!NOTE] > When you assign {% data variables.product.prodname_copilot_short %} to a Jira work item, the context the agent captures from Jira will be added to the pull request and **visible to everyone** if the repository is public. -### Example: Triggering {% data variables.copilot.copilot_coding_agent %} from a Jira work item +### Example: Triggering {% data variables.copilot.copilot_cloud_agent %} from a Jira work item -1. In Jira, open or create a work item that contains clear requirements you want to delegate to {% data variables.copilot.copilot_coding_agent %}. +1. In Jira, open or create a work item that contains clear requirements you want to delegate to {% data variables.copilot.copilot_cloud_agent %}. 1. To specify a repository you want {% data variables.product.prodname_copilot_short %} to work in, mention it in the work item description or in a comment. 1. Assign `{% data variables.product.prodname_copilot %}` to the work item, or mention `@{% data variables.product.prodname_copilot %}` in a comment. For example: @@ -105,34 +106,34 @@ To change the model used by {% data variables.copilot.copilot_coding_agent %} fo ``` 1. If you have not previously connected the {% data variables.product.github %} application in Jira to your {% data variables.product.github %} account, follow the prompts to authorize the application for both {% data variables.product.github %} and Atlassian. -1. Once {% data variables.copilot.copilot_coding_agent %} has started working on the pull request, a comment will appear in the Jira work item. The user who initiated the agent session can view progress updates for the agent. +1. Once {% data variables.copilot.copilot_cloud_agent %} has started working on the pull request, a comment will appear in the Jira work item. The user who initiated the agent session can view progress updates for the agent. 1. You can follow up with further instructions for {% data variables.product.prodname_copilot_short %} in a work item: * Mention `@{% data variables.product.prodname_copilot %}` in a comment. * Use the **Continue in Chat** button under the **Agents** heading to chat directly with {% data variables.product.prodname_copilot_short %}. > [!TIP] -> If you have not received confirmation of triggering {% data variables.copilot.copilot_coding_agent %} after 1 minute, refresh the Jira work item page. +> If you have not received confirmation of triggering {% data variables.copilot.copilot_cloud_agent %} after 1 minute, refresh the Jira work item page. ## Usage costs -{% data variables.copilot.copilot_coding_agent %} uses {% data variables.product.prodname_actions %} minutes and {% data variables.product.prodname_copilot_short %} premium requests. +{% data variables.copilot.copilot_cloud_agent %} uses {% data variables.product.prodname_actions %} minutes and {% data variables.product.prodname_copilot_short %} premium requests. -Within your monthly usage allowance for {% data variables.product.prodname_actions %} and premium requests, you can ask {% data variables.copilot.copilot_coding_agent %} to work on coding tasks without incurring any additional costs. +Within your monthly usage allowance for {% data variables.product.prodname_actions %} and premium requests, you can ask {% data variables.copilot.copilot_cloud_agent %} to work on coding tasks without incurring any additional costs. -For more information, see [AUTOTITLE](/billing/concepts/product-billing/github-copilot-premium-requests#usage-by-copilot-coding-agent). +For more information, see [AUTOTITLE](/billing/concepts/product-billing/github-copilot-premium-requests#usage-by-copilot-cloud-agent). ## Troubleshooting If you run into problems, try the following solutions. -### You can't see the {% data variables.copilot.copilot_coding_agent %} and it is not possible to assign it to a Jira work item +### You can't see the {% data variables.copilot.copilot_cloud_agent %} and it is not possible to assign it to a Jira work item In Jira, check your Atlassian Administration settings for your organization are set as follows. 1. Jira is an AI-enabled app, see [Activate AI for apps](https://support.atlassian.com/organization-administration/docs/activate-atlassian-intelligence-for-products) in the Atlassian documentation. 1. Beta AI features are enabled, see [Control access to beta AI features](https://support.atlassian.com/organization-administration/docs/control-access-to-beta-ai-features/) in the Atlassian documentation. -### You can see the {% data variables.copilot.copilot_coding_agent %} but it is not possible to assign it to a Jira work item +### You can see the {% data variables.copilot.copilot_cloud_agent %} but it is not possible to assign it to a Jira work item Check that you have connected your personal account on {% data variables.product.github %} to the {% data variables.product.prodname_copilot %} for Jira app. @@ -142,17 +143,17 @@ Check that you have connected your personal account on {% data variables.product ### When chatting with {% data variables.product.prodname_copilot %}, you are prompted to sign in -To sign in to {% data variables.product.prodname_copilot %} for Jira app, follow the steps above in [You can see the {% data variables.copilot.copilot_coding_agent %} but it is not possible to assign it to a Jira work item](#you-can-see-the-copilot-coding-agent-but-it-is-not-possible-to-assign-it-to-a-jira-work-item) +To sign in to {% data variables.product.prodname_copilot %} for Jira app, follow the steps above in [You can see the {% data variables.copilot.copilot_cloud_agent %} but it is not possible to assign it to a Jira work item](#you-can-see-the-copilot-cloud-agent-but-it-is-not-possible-to-assign-it-to-a-jira-work-item) ### {% data variables.product.prodname_copilot %} is not responding * Check {% data variables.product.github %}'s [Status page](https://githubstatus.com) for any active incidents. -* Verify that {% data variables.copilot.copilot_coding_agent %} has access to the repository by testing if you can assign {% data variables.product.prodname_copilot_short %} to an issue on {% data variables.product.github %}. See [AUTOTITLE](/copilot/concepts/agents/coding-agent/access-management). +* Verify that {% data variables.copilot.copilot_cloud_agent %} has access to the repository by testing if you can assign {% data variables.product.prodname_copilot_short %} to an issue on {% data variables.product.github %}. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/access-management). * Verify that the {% data variables.product.prodname_copilot %} for Jira application has access to the repository. See [AUTOTITLE](/apps/using-github-apps/reviewing-and-modifying-installed-github-apps#modifying-repository-access). ## Further reading -* [AUTOTITLE](/copilot/concepts/coding-agent/coding-agent) -* [AUTOTITLE](/copilot/concepts/coding-agent/enable-coding-agent) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp#example-atlassian) +* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent) +* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/access-management) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp#example-atlassian) * [Collaborate on work items with AI agents](https://support.atlassian.com/jira-software-cloud/docs/collaborate-on-work-items-with-ai-agents/) in the Atlassian documentation diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-linear.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-linear.md similarity index 71% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-linear.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-linear.md index ab74916668fb..77c677b41e07 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-linear.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-linear.md @@ -8,13 +8,15 @@ versions: contentType: how-tos category: - Integrate Copilot with your tools +redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-linear --- > [!NOTE] > * This feature is currently in {% data variables.release-phases.public_preview %} and subject to change. -> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-coding-agent). +> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-cloud-agent). -The {% data variables.product.prodname_copilot_short %} integration in Linear allows you to invoke {% data variables.copilot.copilot_coding_agent %} without leaving your Linear workspace. From within a Linear issue you can initiate {% data variables.copilot.copilot_coding_agent_short %} sessions and open pull requests, using the context of your issue description and comments. +The {% data variables.product.prodname_copilot_short %} integration in Linear allows you to invoke {% data variables.copilot.copilot_cloud_agent %} without leaving your Linear workspace. From within a Linear issue you can initiate {% data variables.copilot.copilot_cloud_agent_short %} sessions and open pull requests, using the context of your issue description and comments. For information about additional {% data variables.product.prodname_copilot_short %} integrations, see [AUTOTITLE](/copilot/concepts/tools/about-copilot-integrations). @@ -37,16 +39,16 @@ The {% data variables.product.prodname_copilot_short %} app only needs to be ins ## Using the {% data variables.product.prodname_copilot_short %} app in Linear -The first time you use the {% data variables.product.prodname_copilot_short %} app in Linear, you will need to connect it to your {% data variables.product.github %} account. You will also need to specify a repository for {% data variables.copilot.copilot_coding_agent %} to use. Only users with **write** access to the specified repository can trigger {% data variables.copilot.copilot_coding_agent %} to work in that repository. Contributors to the issue without repository **write** access can help guide {% data variables.product.prodname_copilot_short %} by providing input to the issue conversation, which will be used as context when creating the pull request. +The first time you use the {% data variables.product.prodname_copilot_short %} app in Linear, you will need to connect it to your {% data variables.product.github %} account. You will also need to specify a repository for {% data variables.copilot.copilot_cloud_agent %} to use. Only users with **write** access to the specified repository can trigger {% data variables.copilot.copilot_cloud_agent %} to work in that repository. Contributors to the issue without repository **write** access can help guide {% data variables.product.prodname_copilot_short %} by providing input to the issue conversation, which will be used as context when creating the pull request. -1. In Linear, create an issue where you want to use {% data variables.copilot.copilot_coding_agent %}. +1. In Linear, create an issue where you want to use {% data variables.copilot.copilot_cloud_agent %}. 1. Click the **Assign** dropdown, then select **{% data variables.product.prodname_copilot %}**. -1. If you haven't yet specified a repository for {% data variables.copilot.copilot_coding_agent %} to use, you will be prompted to do so now. This is where {% data variables.copilot.copilot_coding_agent %} will open the pull request related to this issue. +1. If you haven't yet specified a repository for {% data variables.copilot.copilot_cloud_agent %} to use, you will be prompted to do so now. This is where {% data variables.copilot.copilot_cloud_agent %} will open the pull request related to this issue. 1. If this is your first time using the app, you will be prompted to sign in to your {% data variables.product.github %} account and authorize the app. Follow the prompts to complete the authorization. -1. In the "Links" section of your Linear issue, you will now see a linked "[WIP]" pull request created by {% data variables.copilot.copilot_coding_agent %}. Click the link to view the pull request on {% data variables.product.github %}. -1. Once {% data variables.copilot.copilot_coding_agent %} has finished working on the pull request, a notification will be added to the "Activity" section of your Linear issue. +1. In the "Links" section of your Linear issue, you will now see a linked "[WIP]" pull request created by {% data variables.copilot.copilot_cloud_agent %}. Click the link to view the pull request on {% data variables.product.github %}. +1. Once {% data variables.copilot.copilot_cloud_agent %} has finished working on the pull request, a notification will be added to the "Activity" section of your Linear issue. ## Further reading -* [AUTOTITLE](/copilot/concepts/coding-agent/coding-agent) -* [AUTOTITLE](/copilot/concepts/coding-agent/enable-coding-agent) +* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent) +* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/access-management) diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-slack.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-slack.md similarity index 66% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-slack.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-slack.md index 9f841b6bd7d2..65ed86ec9ff5 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-slack.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-slack.md @@ -8,15 +8,17 @@ versions: contentType: how-tos category: - Integrate Copilot with your tools +redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-slack --- > [!NOTE] > * This feature is in {% data variables.release-phases.public_preview %} and subject to change. -> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-coding-agent) +> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-cloud-agent) ## Introduction -The {% data variables.copilot.copilot_coding_agent %} integration in Slack allows you to interact with {% data variables.copilot.copilot_coding_agent %} from your Slack workspace and is included in the {% data variables.product.prodname_github_app %} for Slack. From within a Slack thread or direct message, you can initiate {% data variables.copilot.copilot_coding_agent_short %} sessions using the context of your conversation. +The {% data variables.copilot.copilot_cloud_agent %} integration in Slack allows you to interact with {% data variables.copilot.copilot_cloud_agent %} from your Slack workspace and is included in the {% data variables.product.prodname_github_app %} for Slack. From within a Slack thread or direct message, you can initiate {% data variables.copilot.copilot_cloud_agent_short %} sessions using the context of your conversation. For information about additional {% data variables.product.prodname_copilot_short %} integrations, see [AUTOTITLE](/copilot/concepts/tools/about-copilot-integrations). @@ -25,7 +27,7 @@ For information about additional {% data variables.product.prodname_copilot_shor When you @mention {% data variables.product.prodname_copilot_short %} in Slack, consider the following. * {% data variables.product.prodname_copilot_short %} may perform write actions on your behalf, such as creating pull requests or issues, in addition to answering questions. {% data variables.product.prodname_copilot_short %} uses the permissions of your linked {% data variables.product.github %} account for any actions it takes. -* {% data variables.copilot.copilot_coding_agent %} will capture the entire thread as context for your request, understanding and implementing solutions based on the discussion. This context is stored in the pull request. If you want to limit the context, you can send a direct message to the {% data variables.product.prodname_github_app %} for Slack instead. +* {% data variables.copilot.copilot_cloud_agent %} will capture the entire thread as context for your request, understanding and implementing solutions based on the discussion. This context is stored in the pull request. If you want to limit the context, you can send a direct message to the {% data variables.product.prodname_github_app %} for Slack instead. ## Prerequisites @@ -35,10 +37,10 @@ When you @mention {% data variables.product.prodname_copilot_short %} in Slack, ## Connecting the {% data variables.product.prodname_github_app %} to your {% data variables.product.github %} account -The first time you use the {% data variables.product.prodname_github_app %} in Slack, the app will prompt you to connect it to your {% data variables.product.github %} account and set a default repository. The default repository is where pull requests created by {% data variables.copilot.copilot_coding_agent %} sessions will be opened. +The first time you use the {% data variables.product.prodname_github_app %} in Slack, the app will prompt you to connect it to your {% data variables.product.github %} account and set a default repository. The default repository is where pull requests created by {% data variables.copilot.copilot_cloud_agent %} sessions will be opened. 1. In Slack, open a direct message with the {% data variables.product.prodname_github_app %} or mention {% data variables.product.prodname_copilot_short %} in a thread by typing `@{% data variables.product.prodname_copilot %}`. -1. Send a prompt to {% data variables.copilot.copilot_coding_agent %}. This can be a request to perform a task, or simply `login`. +1. Send a prompt to {% data variables.copilot.copilot_cloud_agent %}. This can be a request to perform a task, or simply `login`. 1. If asked to connect your {% data variables.product.github %} account, follow the instructions in {% data variables.product.prodname_copilot_short %}'s reply and authorize the app to access your {% data variables.product.github %} account. 1. In the Slack message thread, click **Configure settings** to set a default repository for pull requests. You can change this repository later using the `settings` command. 1. In the "Settings" dialog, type the name of a repository where you'll be using the cloud agent, then click **Save changes**. @@ -47,18 +49,18 @@ The first time you use the {% data variables.product.prodname_github_app %} in S You can send the {% data variables.product.prodname_github_app %} direct messages or mention it in a thread. The bot will respond to your messages and perform tasks based on your requests. -You must have write access to the default repository – or the repository specified in your prompt – in order to trigger {% data variables.copilot.copilot_coding_agent %} to work. If you do not have write access to the relevant repository, you can still help guide {% data variables.product.prodname_copilot_short %} by providing input in the Slack thread, which will be used as context when {% data variables.copilot.copilot_coding_agent %} makes changes in the pull request. +You must have write access to the default repository – or the repository specified in your prompt – in order to trigger {% data variables.copilot.copilot_cloud_agent %} to work. If you do not have write access to the relevant repository, you can still help guide {% data variables.product.prodname_copilot_short %} by providing input in the Slack thread, which will be used as context when {% data variables.copilot.copilot_cloud_agent %} makes changes in the pull request. -Users can invoke {% data variables.copilot.copilot_coding_agent %} on any repository where they have `write` access. For enterprise-owned repositories, administrators must install and configure the [Slack {% data variables.product.prodname_github_app %}](https://github.com/marketplace/slack-github?ref_product=copilot&ref_type=engagement&ref_style=text&ref_plan=enterprise) and specify which repositories the Slack app can access. For more information about configuring {% data variables.product.prodname_github_apps %}, see [AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations). +Users can invoke {% data variables.copilot.copilot_cloud_agent %} on any repository where they have `write` access. For enterprise-owned repositories, administrators must install and configure the [Slack {% data variables.product.prodname_github_app %}](https://github.com/marketplace/slack-github?ref_product=copilot&ref_type=engagement&ref_style=text&ref_plan=enterprise) and specify which repositories the Slack app can access. For more information about configuring {% data variables.product.prodname_github_apps %}, see [AUTOTITLE](/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations). 1. In Slack, open a direct message with the {% data variables.product.prodname_github_app %} or mention the app in a thread by typing `@{% data variables.product.prodname_copilot %}`. 1. Type your prompt, then send it. Optionally, you can specify a repository or branch using the following syntax: `@{% data variables.product.github %} Add "Hello World" to the README in repo=REPO_OWNER/REPO_NAME branch=BRANCH_NAME` - > [!NOTE] The repo parameter tells {% data variables.copilot.copilot_coding_agent %} which repository to use for the request, and the branch parameter specifies an existing branch of the repository that should be used as the base branch for a pull request. By default, {% data variables.product.prodname_copilot_short %} uses your configured default repository and the repository’s default branch. + > [!NOTE] The repo parameter tells {% data variables.copilot.copilot_cloud_agent %} which repository to use for the request, and the branch parameter specifies an existing branch of the repository that should be used as the base branch for a pull request. By default, {% data variables.product.prodname_copilot_short %} uses your configured default repository and the repository’s default branch. -1. {% data variables.copilot.copilot_coding_agent %} will initiate a {% data variables.copilot.copilot_coding_agent_short %} session and, once the {% data variables.copilot.copilot_coding_agent_short %} has finished, respond with a summary of the changes it plans to make and a link to the pull request it has created in the default repository. +1. {% data variables.copilot.copilot_cloud_agent %} will initiate a {% data variables.copilot.copilot_cloud_agent_short %} session and, once the {% data variables.copilot.copilot_cloud_agent_short %} has finished, respond with a summary of the changes it plans to make and a link to the pull request it has created in the default repository. ### Creating an issue with {% data variables.product.prodname_copilot_short %} @@ -94,4 +96,4 @@ You can ask {% data variables.product.prodname_copilot_short %} to draft {% data ## Further reading -* [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-coding-agent) - Learn more about {% data variables.copilot.copilot_coding_agent %} and how it can support you. +* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent) - Learn more about {% data variables.copilot.copilot_cloud_agent %} and how it can support you. diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-teams.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-teams.md similarity index 73% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-teams.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-teams.md index 2037099d317c..a506dd84ae14 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-teams.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/integrate-cloud-agent-with-teams.md @@ -8,13 +8,15 @@ versions: contentType: how-tos category: - Integrate Copilot with your tools +redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/integrate-coding-agent-with-teams --- > [!NOTE] > * This feature is currently in {% data variables.release-phases.public_preview %} and subject to change. -> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-coding-agent). +> * {% data variables.product.prodname_copilot %} uses AI. Check for mistakes. See [AUTOTITLE](/copilot/responsible-use/copilot-cloud-agent). -The {% data variables.product.github %} integration in Microsoft Teams allows you to interact with {% data variables.copilot.copilot_coding_agent %} all from within your Teams channels. From within a Teams thread you can initiate {% data variables.copilot.copilot_coding_agent_short %} sessions and open pull requests, using the context of your conversation. +The {% data variables.product.github %} integration in Microsoft Teams allows you to interact with {% data variables.copilot.copilot_cloud_agent %} all from within your Teams channels. From within a Teams thread you can initiate {% data variables.copilot.copilot_cloud_agent_short %} sessions and open pull requests, using the context of your conversation. For information about additional {% data variables.product.prodname_copilot_short %} integrations, see [AUTOTITLE](/copilot/concepts/tools/about-copilot-integrations). @@ -36,7 +38,7 @@ The {% data variables.product.github %} app only needs to be installed once in a ## Connecting the {% data variables.product.github %} app to your {% data variables.product.github %} account -The first time you use the {% data variables.product.github %} app in Teams, you need to connect it to your {% data variables.product.github %} account and set a default repository. The default repository provides the context that {% data variables.product.prodname_copilot_short %} uses when responding to prompts, and it’s also where pull requests created by {% data variables.copilot.copilot_coding_agent %} sessions will be opened unless you specify a repository in your prompt. +The first time you use the {% data variables.product.github %} app in Teams, you need to connect it to your {% data variables.product.github %} account and set a default repository. The default repository provides the context that {% data variables.product.prodname_copilot_short %} uses when responding to prompts, and it’s also where pull requests created by {% data variables.copilot.copilot_cloud_agent %} sessions will be opened unless you specify a repository in your prompt. To get started, mention `@{% data variables.product.github %} ` in any Teams thread. The app will guide you through signing in and setting a default repository. Or you can connect your {% data variables.product.github %} account and set the default repository manually by following these steps: @@ -48,7 +50,7 @@ To get started, mention `@{% data variables.product.github %} ` in an ## Using the {% data variables.product.prodname_copilot_short %} app in Teams -You can interact with the {% data variables.product.github %} app in Teams by mentioning it in a thread. The agent will respond to your messages and perform tasks based on your requests. Only users with **write** access to the default repository—or the repository specified in their prompt—can trigger {% data variables.copilot.copilot_coding_agent %} to work. Contributors to the thread without **write** access can help guide {% data variables.product.prodname_copilot_short %} by providing input to the conversation, which will be used as context when making changes in the pull request. +You can interact with the {% data variables.product.github %} app in Teams by mentioning it in a thread. The agent will respond to your messages and perform tasks based on your requests. Only users with **write** access to the default repository—or the repository specified in their prompt—can trigger {% data variables.copilot.copilot_cloud_agent %} to work. Contributors to the thread without **write** access can help guide {% data variables.product.prodname_copilot_short %} by providing input to the conversation, which will be used as context when making changes in the pull request. 1. In Teams, mention the app in a thread by typing @{% data variables.product.github %}. 1. Type your message or request, then send it. Optionally, you can specify a repository or branch using the following syntax: @@ -57,13 +59,13 @@ You can interact with the {% data variables.product.github %} app in Teams by me @GitHub Add "Hello World" to the README in repo=REPO_OWNER/REPO_NAME branch=BRANCH_NAME ``` - The `repo` parameter tells {% data variables.copilot.copilot_coding_agent %} which repository to use for the request, and the `branch` parameter specifies an existing branch of the repository that should be used as the base branch for a pull request. By default, {% data variables.product.prodname_copilot_short %} uses your configured default repository and the repository’s default branch. + The `repo` parameter tells {% data variables.copilot.copilot_cloud_agent %} which repository to use for the request, and the `branch` parameter specifies an existing branch of the repository that should be used as the base branch for a pull request. By default, {% data variables.product.prodname_copilot_short %} uses your configured default repository and the repository’s default branch. - {% data variables.product.prodname_copilot_short %} will initiate a {% data variables.copilot.copilot_coding_agent_short %} session and respond with a summary of the changes it plans to make, including a link to the pull request it has created in the repository. + {% data variables.product.prodname_copilot_short %} will initiate a {% data variables.copilot.copilot_cloud_agent_short %} session and respond with a summary of the changes it plans to make, including a link to the pull request it has created in the repository. -You can continue to iterate on the pull request in the same Teams thread. Mention @{% data variables.product.github %} with your suggested change, and the {% data variables.copilot.copilot_coding_agent %} will use all of the messages in the thread since the previous mention to iterate on the existing pull request. +You can continue to iterate on the pull request in the same Teams thread. Mention @{% data variables.product.github %} with your suggested change, and the {% data variables.copilot.copilot_cloud_agent %} will use all of the messages in the thread since the previous mention to iterate on the existing pull request. ## Further reading -* [AUTOTITLE](/copilot/concepts/coding-agent/coding-agent) -* [AUTOTITLE](/copilot/concepts/coding-agent/enable-coding-agent) +* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent) +* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/access-management) diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/make-changes-to-an-existing-pr.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/make-changes-to-an-existing-pr.md similarity index 71% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/make-changes-to-an-existing-pr.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/make-changes-to-an-existing-pr.md index 7e539e09041b..05aaf8eb8891 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/make-changes-to-an-existing-pr.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/make-changes-to-an-existing-pr.md @@ -3,16 +3,18 @@ title: Asking GitHub Copilot to make changes to an existing pull request shortTitle: Update existing PR allowTitleToDifferFromFilename: true intro: 'You can ask {% data variables.product.prodname_copilot_short %} to make changes to an existing pull request by mentioning `@copilot`.' -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot contentType: how-tos category: - Author and optimize with Copilot +redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/make-changes-to-an-existing-pr --- > [!NOTE] -> For an overview of {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent). +> For an overview of {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). ## Introduction @@ -37,10 +39,10 @@ You can ask {% data variables.product.prodname_copilot_short %} to resolve merge If you prefer not to use this default behavior, you can ask {% data variables.product.prodname_copilot_short %} to create a new branch and a new pull request targeting your branch instead. Once the agent finishes work, it will request a review from you. -{% data reusables.copilot.coding-agent.monitoring-progress-heading %} +{% data reusables.copilot.cloud-agent.monitoring-progress-heading %} ## Further reading -* [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent) -* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices) -* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent#copilot-cant-create-a-pull-request-from-copilot-chat) +* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent) +* [AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/troubleshoot-cloud-agent#copilot-cant-create-a-pull-request-from-copilot-chat) diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/provide-visual-inputs.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/provide-visual-inputs.md similarity index 63% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/provide-visual-inputs.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/provide-visual-inputs.md index 426162b76be0..13dc462bca92 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/provide-visual-inputs.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/provide-visual-inputs.md @@ -2,20 +2,22 @@ title: Provide visual inputs to GitHub Copilot shortTitle: Provide visual inputs intro: 'You can attach images to issues or {% data variables.copilot.copilot_chat_short %} prompts to help {% data variables.product.prodname_copilot_short %} understand your task.' -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot contentType: how-tos category: - Author and optimize with Copilot +redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/provide-visual-inputs --- > [!NOTE] -> For an overview of {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent). +> For an overview of {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). ## Introduction -{% data variables.copilot.copilot_coding_agent_short_cap_c %} can process images, such as a photo or screenshot of a sketch or design, as part of your task description. This is useful when you want to show {% data variables.product.prodname_copilot_short %} what you're trying to achieve visually, for example, when updating a UI or implementing a design. +{% data variables.copilot.copilot_cloud_agent_short_cap_c %} can process images, such as a photo or screenshot of a sketch or design, as part of your task description. This is useful when you want to show {% data variables.product.prodname_copilot_short %} what you're trying to achieve visually, for example, when updating a UI or implementing a design. You can provide images to {% data variables.product.prodname_copilot_short %} in two ways: @@ -28,7 +30,7 @@ You can provide images to {% data variables.product.prodname_copilot_short %} in 1. Create a new issue or open an existing issue. 1. In the issue body, drag and drop your image. 1. Add a clear description of what you want {% data variables.product.prodname_copilot_short %} to do with the image. For example, "Let's update the login form to match this mockup". -1. Assign the issue to {% data variables.product.prodname_copilot_short %}. For detailed instructions, see [Assign an issue to {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr#assigning-an-issue-to-copilot-on-githubcom). +1. Assign the issue to {% data variables.product.prodname_copilot_short %}. For detailed instructions, see [Assign an issue to {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr#assigning-an-issue-to-copilot-on-githubcom). {% data variables.product.prodname_copilot_short %} will analyze the image along with your description when working on the task. @@ -37,11 +39,11 @@ You can provide images to {% data variables.product.prodname_copilot_short %} in 1. Open {% data variables.copilot.copilot_chat_short %}. 1. Attach your image to the chat prompt, and use `/task` to describe what you want {% data variables.product.prodname_copilot_short %} to do. For example, "Update the notification badge to match this mockup". - For detailed instructions, see [Asking {% data variables.product.prodname_copilot_short %} to create a pull request from {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_dotcom_the_website %}](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr#asking-copilot-to-create-a-pull-request-from-copilot-chat-in-githubcom). + For detailed instructions, see [Asking {% data variables.product.prodname_copilot_short %} to create a pull request from {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_dotcom_the_website %}](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr#asking-copilot-to-create-a-pull-request-from-copilot-chat-in-githubcom). 1. {% data variables.product.prodname_copilot_short %} will start work using the image as context for the task. ## Further reading -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr) -* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr) +* [AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs) diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/research-plan-iterate.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/research-plan-iterate.md similarity index 63% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/research-plan-iterate.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/research-plan-iterate.md index 5a3e1450640a..ee12c65f4927 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/research-plan-iterate.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/research-plan-iterate.md @@ -2,12 +2,14 @@ title: Research, plan, and iterate on code changes with Copilot cloud agent shortTitle: Research, plan, iterate intro: "Perform deep research on a repository, create an implementation plan, and make iterative code changes on a branch, then create a pull request when you're ready." -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot contentType: how-tos category: - Author and optimize with Copilot +redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/research-plan-iterate --- ## Introduction @@ -18,13 +20,13 @@ You can use {% data variables.copilot.copilot_cloud_agent_tmp %} to: * **Plan** and refine an approach before {% data variables.product.prodname_copilot_short %} makes changes. * **Iterate** on code changes on a branch, review a diff, and get {% data variables.product.prodname_copilot_short %} to only **create a pull request when you're ready**. -{% data variables.copilot.copilot_coding_agent %} *won't* automatically open a pull request as part of the session. If you *do* want {% data variables.product.prodname_copilot_short %} to open a pull request for your task right away, you can explicitly ask for one in your prompt. For example, by stating **"Create a pull request to ..."**. +{% data variables.copilot.copilot_cloud_agent %} *won't* automatically open a pull request as part of the session. If you *do* want {% data variables.product.prodname_copilot_short %} to open a pull request for your task right away, you can explicitly ask for one in your prompt. For example, by stating **"Create a pull request to ..."**. -> [!NOTE] Deep research, planning, and iterating on code changes before creating a pull request are only available with {% data variables.copilot.copilot_coding_agent %} on {% data variables.product.prodname_dotcom_the_website %}. {% data variables.copilot.copilot_coding_agent_short_cap_c %} integrations (such as Azure Boards, JIRA, Linear, Slack, or Teams) only support creating a pull request directly. +> [!NOTE] Deep research, planning, and iterating on code changes before creating a pull request are only available with {% data variables.copilot.copilot_cloud_agent %} on {% data variables.product.prodname_dotcom_the_website %}. {% data variables.copilot.copilot_cloud_agent_short_cap_c %} integrations (such as Azure Boards, JIRA, Linear, Slack, or Teams) only support creating a pull request directly. ## Performing deep research -You can ask {% data variables.copilot.copilot_coding_agent %} questions about a repository to understand how it works, identify where to make a change, or confirm assumptions before planning and implementation. {% data variables.product.prodname_copilot_short %} starts a **deep research** session to examine the repository and return a grounded answer. +You can ask {% data variables.copilot.copilot_cloud_agent %} questions about a repository to understand how it works, identify where to make a change, or confirm assumptions before planning and implementation. {% data variables.product.prodname_copilot_short %} starts a **deep research** session to examine the repository and return a grounded answer. {% data reusables.copilot.open-agents-panel-or-page %} 1. Ask a question about the repository. @@ -37,7 +39,7 @@ You can ask {% data variables.copilot.copilot_coding_agent %} questions about a ## Creating a plan -You can ask {% data variables.copilot.copilot_coding_agent %} to propose a plan before making changes, simply by prompting the agent. +You can ask {% data variables.copilot.copilot_cloud_agent %} to propose a plan before making changes, simply by prompting the agent. 1. Ask the agent to create a plan. @@ -60,6 +62,6 @@ After research and planning, you can make changes on a branch, review the diff, ## Further reading -* [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr) -* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents) \ No newline at end of file +* [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents) \ No newline at end of file diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs.md similarity index 76% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs.md index d5ae3a779c8d..d5d2fcecc195 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs.md @@ -2,10 +2,11 @@ title: Reviewing a pull request created by GitHub Copilot shortTitle: Review Copilot PRs intro: 'After {% data variables.product.prodname_copilot_short %} creates a pull request, you should review it. You can mention `@copilot` to ask {% data variables.product.prodname_copilot_short %} to make changes, or push changes yourself.' -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/reviewing-a-pull-request-created-by-copilot - /copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot - /copilot/how-tos/agents/copilot-coding-agent/reviewing-a-pull-request-created-by-copilot @@ -17,7 +18,7 @@ category: --- > [!NOTE] -> For an introduction to {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent). +> For an introduction to {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). ## Reviewing {% data variables.product.prodname_copilot_short %}'s changes @@ -33,22 +34,22 @@ Optionally, when submitting a pull request comment (not a review or review comme > [!TIP] > We recommend you batch your review comments instead of submitting them individually. -{% data reusables.copilot.coding-agent.write-access-required %} +{% data reusables.copilot.cloud-agent.write-access-required %} When {% data variables.product.prodname_copilot_short %} starts a new agent session in response to your comment, an eyes emoji (👀) is added as a reaction to the comment, and a "Copilot has started work" event is added to the pull request timeline. -![Screenshot of a pull request timeline with a review comment with the eyes reaction and a "Copilot started work" timeline event.](/assets/images/help/copilot/coding-agent/comment-to-agent-on-pr.png) +![Screenshot of a pull request timeline with a review comment with the eyes reaction and a "Copilot started work" timeline event.](/assets/images/help/copilot/cloud-agent/comment-to-agent-on-pr.png) When {% data variables.product.prodname_copilot_short %} starts a new session on the same pull request, it remembers context from the previous session, allowing it to work faster and more reliably. > [!NOTE] -> If the pull request was created by a {% data variables.copilot.copilot_custom_agent_short %}, when you mention `@copilot` in pull request comments, the same {% data variables.copilot.copilot_custom_agent_short %} will be used to make further changes. This ensures consistency in the agent's specialized configuration throughout the pull request lifecycle. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents). +> If the pull request was created by a {% data variables.copilot.copilot_custom_agent_short %}, when you mention `@copilot` in pull request comments, the same {% data variables.copilot.copilot_custom_agent_short %} will be used to make further changes. This ensures consistency in the agent's specialized configuration throughout the pull request lifecycle. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents). -For more information, see the section "Use comments to iterate on a pull request" in [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#using-comments-to-iterate-on-a-pull-request). +For more information, see the section "Use comments to iterate on a pull request" in [AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results#using-comments-to-iterate-on-a-pull-request). ## Managing {% data variables.product.prodname_actions %} workflow runs -{% data reusables.copilot.coding-agent-workflow-run-approval-default %} For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/configuring-agent-settings). +{% data reusables.copilot.cloud-agent-workflow-run-approval-default %} For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/configuring-agent-settings). ## Giving feedback on {% data variables.product.prodname_copilot_short %}'s work @@ -59,6 +60,6 @@ You can provide feedback on {% data variables.product.prodname_copilot_short %}' ## Further reading -* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices) -* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs) -* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent) +* [AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/troubleshoot-cloud-agent) diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/test-custom-agents.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/test-custom-agents.md similarity index 95% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/test-custom-agents.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/test-custom-agents.md index f3a77308301d..e5b892897fb9 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/test-custom-agents.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/test-custom-agents.md @@ -8,6 +8,8 @@ contentType: how-tos category: - Configure Copilot - Manage Copilot for a team +redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/test-custom-agents --- {% data reusables.copilot.custom-agents-preview-note %} @@ -23,7 +25,7 @@ Before you can test a {% data variables.copilot.copilot_custom_agent_short %}, y ## 1. Create your test {% data variables.copilot.copilot_custom_agent_short %} 1. In your organization or enterprise's `.github-private` repository, create a new directory called `.github/agents`. Agents stored in this directory are only available to members of your organization or enterprise who have access to the `.github-private` repository, and can only be used when they start a task within that repository. -1. In your `.github/agents` directory, create the {% data variables.copilot.agent_profile %} for your test agent. You can create a net-new profile or duplicate an existing profile to test potential updates. For information on configuring an {% data variables.copilot.agent_profile %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents#configuring-an-agent-profile). +1. In your `.github/agents` directory, create the {% data variables.copilot.agent_profile %} for your test agent. You can create a net-new profile or duplicate an existing profile to test potential updates. For information on configuring an {% data variables.copilot.agent_profile %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents#configuring-an-agent-profile). 1. Merge your test {% data variables.copilot.agent_profile %} into the default branch of your repository. ## 2. Test your {% data variables.copilot.copilot_custom_agent_short %} diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions.md similarity index 86% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions.md index 8fe6de681752..fe0c3a19c59e 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions.md @@ -2,10 +2,11 @@ title: Tracking GitHub Copilot's sessions shortTitle: Track Copilot sessions intro: 'You can use the agents panel or page, {% data variables.product.prodname_vscode %}, JetBrains IDEs, Eclipse, the {% data variables.product.prodname_cli %}, Raycast and session logs to track {% data variables.product.prodname_copilot_short %}''s progress and understand its approach.' -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/using-the-copilot-coding-agent-logs - /copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs - /copilot/how-tos/agents/copilot-coding-agent/using-the-copilot-coding-agent-logs @@ -19,7 +20,7 @@ category: ## Introduction -After you give {% data variables.product.prodname_copilot_short %} a task, it works autonomously in the background to complete it. See [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent). +After you give {% data variables.product.prodname_copilot_short %} a task, it works autonomously in the background to complete it. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent). The agents panel, [agents tab](https://github.com/copilot/agents?ref_product=copilot&ref_type=engagement&ref_style=text), the {% data variables.product.prodname_cli %}, and {% data variables.product.prodname_copilot %} extension for Raycast provide an overview of your agent sessions across repositories. You can use them to kick off new tasks and track {% data variables.product.prodname_copilot_short %}'s progress. @@ -35,7 +36,7 @@ To open the [agents tab](https://github.com/copilot/agents?ref_product=copilot&r Each session displays its status. Click on a session to open the session log and overview, where you can monitor the agent's progress, token usage, session count, and session length. -You can start new agent sessions from the tab. See [AUTOTITLE](/copilot/how-tos/agents/copilot-coding-agent/asking-copilot-to-create-a-pull-request). +You can start new agent sessions from the tab. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). ## Tracking agent sessions from the {% data variables.product.prodname_cli %} @@ -52,9 +53,9 @@ To see all of the available options, run `gh agent-task list --help` or `gh agen ## Tracking agent sessions from Raycast -{% data reusables.copilot.coding-agent.raycast-intro %} +{% data reusables.copilot.cloud-agent.raycast-intro %} -{% data reusables.copilot.coding-agent.raycast-setup %} +{% data reusables.copilot.cloud-agent.raycast-setup %} 1. Open Raycast, search for "{% data variables.product.prodname_copilot_short %}," find the **View Tasks** command, then press Enter. 1. Click **Sign in with {% data variables.product.github %}**, then complete the authentication flow. Raycast will re-open. 1. You'll see a list of your tasks. Select a task, then use the following keyboard shortcuts: @@ -65,7 +66,7 @@ To see all of the available options, run `gh agent-task list --help` or `gh agen > [!NOTE] > If you are unable to see some tasks in Raycast, the organization that owns the repository may have enabled {% data variables.product.prodname_oauth_app %} access restrictions. To learn how to request approval for the "{% data variables.product.prodname_copilot %} for Raycast" {% data variables.product.prodname_oauth_app %}, see [AUTOTITLE](/account-and-profile/how-tos/setting-up-and-managing-your-personal-account-on-github/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps). -You can also start new agent sessions from Raycast. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr#asking-copilot-to-create-a-pull-request-from-raycast). +You can also start new agent sessions from Raycast. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr#asking-copilot-to-create-a-pull-request-from-raycast). ## Tracking sessions from {% data variables.product.prodname_vscode %} @@ -77,7 +78,7 @@ For each session listed, you can see its status at a glance, or click on it to n To view the session logs, click on the pull request in the list, then click **View Session**. -You can also start new agent sessions from {% data variables.product.prodname_vscode %}. See [AUTOTITLE](/copilot/how-tos/agents/copilot-coding-agent/asking-copilot-to-create-a-pull-request#asking-copilot-to-create-a-pull-request-from-copilot-chat-in-visual-studio-code). +You can also start new agent sessions from {% data variables.product.prodname_vscode %}. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr#asking-copilot-to-create-a-pull-request-from-copilot-chat-in-visual-studio-code). To directly open agent sessions in {% data variables.product.prodname_vscode_shortname %}, click the **Open in {% data variables.product.prodname_vscode_shortname %}** option on the agents tab. @@ -87,7 +88,7 @@ To directly open agent sessions in {% data variables.product.prodname_vscode_sho ## Tracking sessions from JetBrains IDEs > [!NOTE] -> {% data variables.copilot.copilot_coding_agent %} in JetBrains IDEs is in {% data variables.release-phases.public_preview %}, and subject to change. +> {% data variables.copilot.copilot_cloud_agent %} in JetBrains IDEs is in {% data variables.release-phases.public_preview %}, and subject to change. You can see a list of your running and past agent sessions for a project in JetBrains IDEs with the {% data variables.copilot.copilot_chat %} extension. See [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension?tool=jetbrains). @@ -100,7 +101,7 @@ For each session listed, you can see its status at a glance. Click **Open in Bro ## Tracking sessions from Eclipse > [!NOTE] -> {% data variables.copilot.copilot_coding_agent %} in Eclipse is in {% data variables.release-phases.public_preview %}, and subject to change. +> {% data variables.copilot.copilot_cloud_agent %} in Eclipse is in {% data variables.release-phases.public_preview %}, and subject to change. You can see a list of your running and past agent sessions for a project in Eclipse with the {% data variables.copilot.copilot_chat %} extension. See [AUTOTITLE](/copilot/how-tos/set-up/install-copilot-extension?tool=eclipse). @@ -122,15 +123,15 @@ You can see a list of your running and past pull requests generated by agents in For example, to show only merged tasks, tap **Open** and then, in the dropdown, tap **Merged**. - Screenshot of the status dropdown list with a check mark against 'Open'. + Screenshot of the status dropdown list with a check mark against 'Open'. ## Tracing commits to session logs -Commits from {% data variables.copilot.copilot_coding_agent %} have the following characteristics: +Commits from {% data variables.copilot.copilot_cloud_agent %} have the following characteristics: * Every commit is authored by {% data variables.product.prodname_copilot_short %}, with the human who started the task marked as the co-author. * Each commit message includes a link to the session logs for that commit, so you can understand why {% data variables.product.prodname_copilot_short %} made a change during code review or trace it later for auditing purposes. -* Commits from {% data variables.copilot.copilot_coding_agent %} are signed and appear as "Verified" on {% data variables.product.github %}. +* Commits from {% data variables.copilot.copilot_cloud_agent %} are signed and appear as "Verified" on {% data variables.product.github %}. ## Using the session logs to understand {% data variables.product.prodname_copilot_short %}'s approach @@ -165,7 +166,7 @@ Follow these steps to steer {% data variables.product.prodname_copilot_short %}: You can stop {% data variables.product.prodname_copilot_short %} from continuing to work on a task by clicking **Stop session** in the session log viewer. -![Screenshot of the log viewer with the 'Stop session' button highlighted.](/assets/images/help/copilot/coding-agent/log-stop-session.png) +![Screenshot of the log viewer with the 'Stop session' button highlighted.](/assets/images/help/copilot/cloud-agent/log-stop-session.png) Reasons you might want to stop a session include: @@ -174,5 +175,5 @@ Reasons you might want to stop a session include: ## Further reading -* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices) -* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent) +* [AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/troubleshoot-cloud-agent) diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/troubleshoot-coding-agent.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/troubleshoot-cloud-agent.md similarity index 69% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/troubleshoot-coding-agent.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/troubleshoot-cloud-agent.md index d8cded321709..239e3dd24c58 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/troubleshoot-coding-agent.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/troubleshoot-cloud-agent.md @@ -3,10 +3,11 @@ title: Troubleshooting GitHub Copilot cloud agent shortTitle: Troubleshoot cloud agent allowTitleToDifferFromFilename: true intro: 'Learn how to resolve problems that may occur when you assign tasks to {% data variables.product.prodname_copilot_short %}.' -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' +product: '{% data reusables.gated-features.copilot-cloud-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' versions: feature: copilot redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/troubleshoot-coding-agent - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/troubleshooting-copilot-coding-agent - /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/troubleshooting-copilot-coding-agent - /early-access/copilot/coding-agent/troubleshooting-copilot-coding-agent @@ -26,35 +27,35 @@ You can only assign issues to {% data variables.product.prodname_copilot_short % If you do not already have a subscription for one of these plans, click this button for more information:
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 aria-label="link-external" %} -If you _do_ have {% data variables.copilot.copilot_pro %}, {% data variables.copilot.copilot_pro_plus %}, {% data variables.copilot.copilot_for_business %}, or {% data variables.copilot.copilot_enterprise %}, check that {% data variables.copilot.copilot_coding_agent %} {% ifversion ghec %}is enabled and{% endif %} has not been manually disabled for the repository: +If you _do_ have {% data variables.copilot.copilot_pro %}, {% data variables.copilot.copilot_pro_plus %}, {% data variables.copilot.copilot_for_business %}, or {% data variables.copilot.copilot_enterprise %}, check that {% data variables.copilot.copilot_cloud_agent %} {% ifversion ghec %}is enabled and{% endif %} has not been manually disabled for the repository: {% ifversion ghec %} -* If you are on the {% data variables.copilot.copilot_for_business %} or {% data variables.copilot.copilot_enterprise_short %} plan, your ability to use {% data variables.copilot.copilot_coding_agent %} is controlled by your enterprise and/or organization administrator. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-copilot-for-your-enterprise/adding-copilot-coding-agent-to-enterprise). +* If you are on the {% data variables.copilot.copilot_for_business %} or {% data variables.copilot.copilot_enterprise_short %} plan, your ability to use {% data variables.copilot.copilot_cloud_agent %} is controlled by your enterprise and/or organization administrator. See [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/manage-copilot-cloud-agent). {% endif %} -* For organization-owned repositories, the availability of {% data variables.copilot.copilot_coding_agent %} in the repository is managed by the organization and/or enterprise administrators. See [AUTOTITLE](/enterprise-cloud@latest/copilot/managing-copilot/managing-github-copilot-in-your-organization/adding-copilot-coding-agent-to-organization). +* For organization-owned repositories, the availability of {% data variables.copilot.copilot_cloud_agent %} in the repository is managed by the organization and/or enterprise administrators. See [AUTOTITLE](/enterprise-cloud@latest/copilot/how-tos/administer-copilot/manage-for-organization/add-copilot-cloud-agent). -* For personal repositories, the availability of {% data variables.copilot.copilot_coding_agent %} in the repository is configured in your account settings. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-copilot-coding-agent). +* For personal repositories, the availability of {% data variables.copilot.copilot_cloud_agent %} in the repository is configured in your account settings. See [AUTOTITLE](/copilot/managing-copilot/managing-copilot-as-an-individual-subscriber/managing-your-copilot-plan/managing-copilot-policies-as-an-individual-subscriber#enabling-or-disabling-copilot-cloud-agent). > [!NOTE] -> You can check whether {% data variables.copilot.copilot_coding_agent %} has been enabled for you in the features page of your {% data variables.product.prodname_copilot_short %} settings: [github.com/settings/copilot/features](https://github.com/settings/copilot/features). +> You can check whether {% data variables.copilot.copilot_cloud_agent %} has been enabled for you in the features page of your {% data variables.product.prodname_copilot_short %} settings: [github.com/settings/copilot/features](https://github.com/settings/copilot/features). ## I have an {% data variables.product.prodname_emu %} account and {% data variables.product.prodname_copilot_short %} won't work in my personal repository -{% data reusables.copilot.coding-agent-emu-limitation %} +{% data reusables.copilot.cloud-agent-emu-limitation %} If you have an {% data variables.enterprise.prodname_managed_user %} and try to assign {% data variables.product.prodname_copilot_short %} to an issue in a personal repository, you may see an error message reporting that {% data variables.product.prodname_actions %} are not available for your repository. -To use {% data variables.copilot.copilot_coding_agent %}, you'll need to work with repositories owned by your organization instead of personal repositories. +To use {% data variables.copilot.copilot_cloud_agent %}, you'll need to work with repositories owned by your organization instead of personal repositories. ## {% data variables.product.prodname_copilot_short %} can't create a pull request from {% data variables.copilot.copilot_chat_short %} -If you asked {% data variables.product.prodname_copilot_short %} to create a pull request and it responds that it cannot directly create a pull request, check that {% data variables.copilot.copilot_coding_agent %} is available. +If you asked {% data variables.product.prodname_copilot_short %} to create a pull request and it responds that it cannot directly create a pull request, check that {% data variables.copilot.copilot_cloud_agent %} is available. > [!IMPORTANT] -> {% data reusables.copilot.coding-agent.use-chat-participant-in-vsc %} +> {% data reusables.copilot.cloud-agent.use-chat-participant-in-vsc %} ## I assigned an issue to {% data variables.product.prodname_copilot_short %}, but nothing is happening @@ -66,11 +67,11 @@ If there is a "{% data variables.product.prodname_copilot_short %} started work" ## {% data variables.product.prodname_copilot_short %} won't respond to my pull request comments -{% data reusables.copilot.coding-agent.write-access-required %} +{% data reusables.copilot.cloud-agent.write-access-required %} -If you do have write access, and you mention `@copilot` on a pull request that is assigned to {% data variables.product.prodname_copilot_short %}, the comment is passed to {% data variables.copilot.copilot_coding_agent %}. An eyes emoji (👀) is added to your comment to indicate that {% data variables.copilot.copilot_coding_agent %} has seen your comment. Shortly after, a "{% data variables.product.prodname_copilot_short %} started work" event is added to the pull request timeline. +If you do have write access, and you mention `@copilot` on a pull request that is assigned to {% data variables.product.prodname_copilot_short %}, the comment is passed to {% data variables.copilot.copilot_cloud_agent %}. An eyes emoji (👀) is added to your comment to indicate that {% data variables.copilot.copilot_cloud_agent %} has seen your comment. Shortly after, a "{% data variables.product.prodname_copilot_short %} started work" event is added to the pull request timeline. -If this doesn't happen, {% data variables.product.prodname_copilot_short %} may have been unassigned from the pull request, or you may not have write access. Note that {% data variables.product.prodname_copilot_short %} only responds to mentions in open pull requests. Once a pull request is merged or closed, {% data variables.copilot.copilot_coding_agent %} will not respond to new mentions or comments to better focus on active development work. +If this doesn't happen, {% data variables.product.prodname_copilot_short %} may have been unassigned from the pull request, or you may not have write access. Note that {% data variables.product.prodname_copilot_short %} only responds to mentions in open pull requests. Once a pull request is merged or closed, {% data variables.copilot.copilot_cloud_agent %} will not respond to new mentions or comments to better focus on active development work. ## Based on the agent session logs, {% data variables.product.prodname_copilot_short %} appears to be stuck @@ -84,13 +85,13 @@ If {% data variables.product.prodname_copilot_short %} got stuck while respondin {% data variables.product.prodname_actions %} workflows will not run automatically when {% data variables.product.prodname_copilot_short %} pushes changes to a pull request. -To allow {% data variables.product.prodname_actions %} workflows to run, click the **Approve and run workflows** button in the pull request's merge box. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/reviewing-a-pull-request-created-by-copilot). +To allow {% data variables.product.prodname_actions %} workflows to run, click the **Approve and run workflows** button in the pull request's merge box. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs). ## {% data variables.product.prodname_copilot_short %} is pushing changes which don't pass my CI checks While working on an issue, {% data variables.product.prodname_copilot_short %} has access to its own ephemeral development environment, powered by {% data variables.product.prodname_actions %}, where it can execute automated tests and linters to validate its work before it pushes. -It is most likely to do this if given clear instructions on what to do. The best way to do this is with a `.github/copilot-instructions.md` file. See [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices#adding-custom-instructions-to-your-repository). +It is most likely to do this if given clear instructions on what to do. The best way to do this is with a `.github/copilot-instructions.md` file. See [AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results#adding-custom-instructions-to-your-repository). ## There is a warning from {% data variables.product.prodname_copilot %} about the firewall @@ -100,15 +101,15 @@ Limiting access to the internet helps to manage data exfiltration risks, where s If {% data variables.product.prodname_copilot_short %} tries to make a request which is blocked by the firewall, a warning is added to the pull request body (if {% data variables.product.prodname_copilot_short %} is responding to an issue assignment) or to a comment (if {% data variables.product.prodname_copilot_short %} is responding to a comment). The warning shows the blocked address and the command that tried to make the request. -![Screenshot of a warning from {% data variables.product.prodname_copilot_short %} about being blocked by the firewall.](/assets/images/help/copilot/coding-agent/firewall-warning.png) +![Screenshot of a warning from {% data variables.product.prodname_copilot_short %} about being blocked by the firewall.](/assets/images/help/copilot/cloud-agent/firewall-warning.png) -For more information, see [AUTOTITLE](/copilot/customizing-copilot/customizing-or-disabling-the-firewall-for-copilot-coding-agent). +For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall). ## {% data variables.product.prodname_copilot_short %} is not picking up attached screenshots -The maximum image size allowed by {% data variables.copilot.copilot_coding_agent %} is 3.00 MiB. Images larger than this will be removed from the request. +The maximum image size allowed by {% data variables.copilot.copilot_cloud_agent %} is 3.00 MiB. Images larger than this will be removed from the request. ## Further reading -* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices) -* [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent) +* [AUTOTITLE](/copilot/tutorials/cloud-agent/get-the-best-results) +* [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment) diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/use-hooks.md b/content/copilot/how-tos/use-copilot-agents/cloud-agent/use-hooks.md similarity index 64% rename from content/copilot/how-tos/use-copilot-agents/coding-agent/use-hooks.md rename to content/copilot/how-tos/use-copilot-agents/cloud-agent/use-hooks.md index a3d92f6addc6..aa8e897d9c6b 100644 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/use-hooks.md +++ b/content/copilot/how-tos/use-copilot-agents/cloud-agent/use-hooks.md @@ -7,21 +7,23 @@ versions: contentType: how-tos category: - Configure Copilot +redirect_from: + - /copilot/how-tos/use-copilot-agents/coding-agent/use-hooks --- -{% data reusables.copilot.coding-agent.hooks-intro %} +{% data reusables.copilot.cloud-agent.hooks-intro %} ## Creating a hook in a repository on {% data variables.product.github %} -{% data reusables.copilot.coding-agent.create-hooks-instructions %} +{% data reusables.copilot.cloud-agent.create-hooks-instructions %} ## Troubleshooting -{% data reusables.copilot.coding-agent.troubleshoot-hooks %} +{% data reusables.copilot.cloud-agent.troubleshoot-hooks %} ## Further reading * For more information about configuring hooks, see [AUTOTITLE](/copilot/reference/hooks-configuration) -* For more information about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-coding-agent) +* For more information about {% data variables.copilot.copilot_cloud_agent %}, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about-cloud-agent) * For more information about {% data variables.copilot.copilot_cli %}, see [AUTOTITLE](/copilot/concepts/agents/about-copilot-cli) -* For information about customizing the agent environment, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment) +* For information about customizing the agent environment, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment) diff --git a/content/copilot/how-tos/use-copilot-agents/coding-agent/changing-the-ai-model.md b/content/copilot/how-tos/use-copilot-agents/coding-agent/changing-the-ai-model.md deleted file mode 100644 index e91ded5b4abc..000000000000 --- a/content/copilot/how-tos/use-copilot-agents/coding-agent/changing-the-ai-model.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: Changing the AI model for GitHub Copilot cloud agent -shortTitle: Changing the AI model -allowTitleToDifferFromFilename: true -intro: 'In supported entrypoints, when starting a task with {% data variables.copilot.copilot_coding_agent %}, you can select the model used.' -product: '{% data reusables.gated-features.copilot-coding-agent %}
Sign up for {% data variables.product.prodname_copilot_short %} {% octicon "link-external" height:16 %}' -versions: - feature: copilot -contentType: how-tos -category: - - Author and optimize with Copilot ---- - -> [!NOTE] -> For an overview of {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent). - -## Introduction - -In supported entrypoints, you can select the model used by {% data variables.copilot.copilot_coding_agent %}. - -You may find that different models perform better, or provide more useful responses, depending on the type of tasks you give {% data variables.product.prodname_copilot_short %}. - -> [!NOTE] -> Model selection for {% data variables.copilot.copilot_coding_agent %} is only supported when assigning an issue to {% data variables.product.prodname_copilot_short %} on {% data variables.product.prodname_dotcom_the_website %}, when mentioning `@copilot` in a pull request comment on {% data variables.product.prodname_dotcom_the_website %}, or when starting a task from the agents tab, agents panel, {% data variables.product.prodname_mobile %} or the Raycast launcher. Where a model picker is not available, Auto will be used automatically. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr). - -## Supported models - -The following options are currently available: - -* Auto -{% data reusables.copilot.copilot-coding-agent-auto-models %} -{% data reusables.copilot.copilot-coding-agent-non-auto-models %} - -{% data reusables.copilot.auto-model-option %} - diff --git a/content/copilot/how-tos/use-copilot-agents/copilot-memory.md b/content/copilot/how-tos/use-copilot-agents/copilot-memory.md index 0f70e7fd76b0..3e95891fb99a 100644 --- a/content/copilot/how-tos/use-copilot-agents/copilot-memory.md +++ b/content/copilot/how-tos/use-copilot-agents/copilot-memory.md @@ -13,7 +13,7 @@ category: > [!NOTE] > This feature is currently in {% data variables.release-phases.public_preview %} and is subject to change. -{% data variables.copilot.copilot_memory %} allows {% data variables.product.prodname_copilot_short %} to learn about your codebase, helping {% data variables.copilot.copilot_coding_agent %}, {% data variables.copilot.copilot_code-review_short %}, and {% data variables.copilot.copilot_cli_short %} to work more effectively in a repository. +{% data variables.copilot.copilot_memory %} allows {% data variables.product.prodname_copilot_short %} to learn about your codebase, helping {% data variables.copilot.copilot_cloud_agent %}, {% data variables.copilot.copilot_code-review_short %}, and {% data variables.copilot.copilot_cli_short %} to work more effectively in a repository. For more information, see [AUTOTITLE](/copilot/concepts/agents/copilot-memory). @@ -59,7 +59,7 @@ If the organization belongs to an enterprise, the ability for organization owner If you have an individual {% data variables.product.prodname_copilot_short %} subscription, from a {% data variables.copilot.copilot_pro_short %} or {% data variables.copilot.copilot_pro_plus_short %} plan, {% data variables.copilot.copilot_memory %} is enabled by default. You can disable or re-enable {% data variables.copilot.copilot_memory %} in your personal {% data variables.product.prodname_copilot_short %} settings on {% data variables.product.github %}. -When enabled, {% data variables.copilot.copilot_memory %} will be used in any repository in which you use {% data variables.copilot.copilot_coding_agent %}, {% data variables.copilot.copilot_code-review_short %}, or {% data variables.copilot.copilot_cli_short %}. +When enabled, {% data variables.copilot.copilot_memory %} will be used in any repository in which you use {% data variables.copilot.copilot_cloud_agent %}, {% data variables.copilot.copilot_code-review_short %}, or {% data variables.copilot.copilot_cli_short %}. {% data reusables.user-settings.copilot-settings %} 1. Under "Features", scroll down to the setting for **{% data variables.copilot.copilot_memory %}**. diff --git a/content/copilot/how-tos/use-copilot-agents/index.md b/content/copilot/how-tos/use-copilot-agents/index.md index c5b2bd2ac2ae..b7fbf1d6dc07 100644 --- a/content/copilot/how-tos/use-copilot-agents/index.md +++ b/content/copilot/how-tos/use-copilot-agents/index.md @@ -6,7 +6,7 @@ versions: feature: copilot children: - /manage-agents - - /coding-agent + - /cloud-agent - /request-a-code-review - /copilot-memory redirect_from: diff --git a/content/copilot/how-tos/use-copilot-agents/manage-agents.md b/content/copilot/how-tos/use-copilot-agents/manage-agents.md index 7e7496c5a745..c413fc7b688b 100644 --- a/content/copilot/how-tos/use-copilot-agents/manage-agents.md +++ b/content/copilot/how-tos/use-copilot-agents/manage-agents.md @@ -10,7 +10,7 @@ category: - Author and optimize with Copilot --- -{% data reusables.copilot.coding-agent.agent-management-intro %} +{% data reusables.copilot.cloud-agent.agent-management-intro %} ## 1. Select a repository and choose your agent @@ -34,7 +34,7 @@ category: {% data variables.product.prodname_copilot_short %} will start work on the task and begin pushing changes to a new pull request, where it will automatically add you as a reviewer. -For more information on ways to start new agent tasks, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr). +For more information on ways to start new agent tasks, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-a-pr). ## 2. Monitor agent activity @@ -42,7 +42,7 @@ Once the agent starts working, it will continue to update the session log and ov Each session displays its status. Click on a session to open the session log, where you can monitor the agent's progress, see the tools it's using, and track how long the session has been running. -{% data variables.copilot.copilot_coding_agent %} sessions can also be tracked from the {% data variables.product.prodname_cli %}, {% data variables.product.prodname_mobile %}, {% data variables.product.prodname_vscode %}, Raycast, and JetBrains IDEs. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions). +{% data variables.copilot.copilot_cloud_agent %} sessions can also be tracked from the {% data variables.product.prodname_cli %}, {% data variables.product.prodname_mobile %}, {% data variables.product.prodname_vscode %}, Raycast, and JetBrains IDEs. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/track-copilot-sessions). ## 3. Redirect agents as needed @@ -71,17 +71,17 @@ You can guide the agent in your local development environment on further changes At the bottom of the agent session view, click the **{% octicon "vscode" aria-label="VS Code" %} Open in {% data variables.product.prodname_vscode_shortname %}** button to launch the session directly in {% data variables.product.prodname_vscode_shortname %}. -{% data reusables.copilot.coding-agent.use-latest-vscode %} +{% data reusables.copilot.cloud-agent.use-latest-vscode %} ### {% data variables.copilot.copilot_cli %} 1. At the bottom of the agent session view, click the dropdown list next to **{% octicon "vscode" aria-label="VS Code" %} Open in {% data variables.product.prodname_vscode_shortname %}**. 1. Click **{% octicon "agent" aria-label="Agent" %} Continue in {% data variables.copilot.copilot_cli %}** to copy the `copilot --resume=SESSION-ID` command to your clipboard. - ![Screenshot of the session action dropdown list, "Continue in Copilot CLI" is highlighted with a dark orange outline.](/assets/images/help/copilot/coding-agent/open-agent-session-in-copilot-cli.png) + ![Screenshot of the session action dropdown list, "Continue in Copilot CLI" is highlighted with a dark orange outline.](/assets/images/help/copilot/cloud-agent/open-agent-session-in-copilot-cli.png) 1. In your terminal, paste and run the command to resume the agent session. ## 5. Review and merge agent code -Once the agent completes a session, you can navigate to the pull request to review the changes. From the pull request, you can scan the diff, request further improvements, or approve and merge the changes. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs). +Once the agent completes a session, you can navigate to the pull request to review the changes. From the pull request, you can scan the diff, request further improvements, or approve and merge the changes. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/review-copilot-prs). ## 6. Archive agent sessions diff --git a/content/copilot/how-tos/use-copilot-agents/request-a-code-review/configure-runners.md b/content/copilot/how-tos/use-copilot-agents/request-a-code-review/configure-runners.md index 9b5fa71bb83a..d5b5698612c4 100644 --- a/content/copilot/how-tos/use-copilot-agents/request-a-code-review/configure-runners.md +++ b/content/copilot/how-tos/use-copilot-agents/request-a-code-review/configure-runners.md @@ -37,7 +37,7 @@ To configure self-hosted runners for {% data variables.copilot.copilot_code-revi * `api.githubcopilot.com` * `uploads.github.com` * `user-images.githubusercontent.com` -1. In your `copilot-setup-steps.yml` file, set the `runs-on` attribute to your ARC-managed scale set name. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment#preinstalling-tools-or-dependencies-in-copilots-environment). +1. In your `copilot-setup-steps.yml` file, set the `runs-on` attribute to your ARC-managed scale set name. For more information, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment#preinstalling-tools-or-dependencies-in-copilots-environment). ```yaml # ... diff --git a/content/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review.md b/content/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review.md index b8d019b1f88c..af4667d86ae9 100644 --- a/content/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review.md +++ b/content/copilot/how-tos/use-copilot-agents/request-a-code-review/use-code-review.md @@ -55,9 +55,9 @@ Where possible, {% data variables.product.prodname_copilot_short %}'s feedback i If you're happy with the changes, you can accept a single suggestion from {% data variables.product.prodname_copilot_short %} and commit it, or accept a group of suggestions together in a single commit. For more information, see [AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/incorporating-feedback-in-your-pull-request). -You can also invoke {% data variables.copilot.copilot_coding_agent %} to implement suggested changes. To do this, you must: +You can also invoke {% data variables.copilot.copilot_cloud_agent %} to implement suggested changes. To do this, you must: -* Opt into the {% data variables.release-phases.public_preview %} for {% data variables.copilot.copilot_code-review-tools_short %} and enable {% data variables.copilot.copilot_coding_agent %}. +* Opt into the {% data variables.release-phases.public_preview %} for {% data variables.copilot.copilot_code-review-tools_short %} and enable {% data variables.copilot.copilot_cloud_agent %}. * On review comments from {% data variables.copilot.copilot_code-review %}, click **Implement suggestion**. This creates a draft comment on the pull request, where you can instruct {% data variables.product.prodname_copilot_short %} to address specific feedback. {% data variables.product.prodname_copilot_short %} will create a new pull request against your branch with the suggestions applied. ## Providing feedback on {% data variables.product.prodname_copilot_short %}'s reviews diff --git a/content/copilot/how-tos/use-copilot-for-common-tasks/use-copilot-to-create-or-update-issues.md b/content/copilot/how-tos/use-copilot-for-common-tasks/use-copilot-to-create-or-update-issues.md index fc95d12b7811..6bbf7787ee12 100644 --- a/content/copilot/how-tos/use-copilot-for-common-tasks/use-copilot-to-create-or-update-issues.md +++ b/content/copilot/how-tos/use-copilot-for-common-tasks/use-copilot-to-create-or-update-issues.md @@ -125,7 +125,7 @@ The draft appears in the workbench, where you can review and edit it. To publish ## Assigning issues to {% data variables.product.prodname_copilot_short %} -To assign an issue to {% data variables.product.prodname_copilot_short %}, you need to have {% data variables.copilot.copilot_coding_agent %} enabled. See [AUTOTITLE](/copilot/concepts/coding-agent/about-enabling-coding-agent). +To assign an issue to {% data variables.product.prodname_copilot_short %}, you need to have {% data variables.copilot.copilot_cloud_agent %} enabled. See [AUTOTITLE](/copilot/concepts/agents/cloud-agent/access-management). You can assign the issue during creation in one of two ways: diff --git a/content/copilot/reference/agent-session-filters.md b/content/copilot/reference/agent-session-filters.md index ad46a7e06eed..7b74e5d6ff2f 100644 --- a/content/copilot/reference/agent-session-filters.md +++ b/content/copilot/reference/agent-session-filters.md @@ -14,7 +14,7 @@ The following filters are available for the "Agent sessions" view in your enterp | Filter | Description | Example value | | --- | --- | --- | -| `agent` | Displays activity from a specific agent. | `agent:copilot-coding-agent` | +| `agent` | Displays activity from a specific agent. | `agent:copilot-cloud-agent` | | `organization` | Displays activity within a specific organization. | `organization:octocat-org` | | `repository` | Displays activity within a specific repository. | `repository:octocat-repo` | | `status` | Displays agent sessions with a specific status. | `status:in_progress` | diff --git a/content/copilot/reference/copilot-allowlist-reference.md b/content/copilot/reference/copilot-allowlist-reference.md index 3e18f65c4bb0..c6657a2f4919 100644 --- a/content/copilot/reference/copilot-allowlist-reference.md +++ b/content/copilot/reference/copilot-allowlist-reference.md @@ -41,9 +41,9 @@ Depending on the security policies and editors your organization uses, you may n Every user of the proxy server or firewall also needs to configure their own environment to connect to {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/configuring-github-copilot/configuring-network-settings-for-github-copilot). -## {% data variables.copilot.copilot_coding_agent %} recommended allowlist +## {% data variables.copilot.copilot_cloud_agent %} recommended allowlist -The {% data variables.copilot.copilot_coding_agent %} includes a built-in firewall with a recommended allowlist that is enabled by default. The recommended allowlist allows access to: +The {% data variables.copilot.copilot_cloud_agent %} includes a built-in firewall with a recommended allowlist that is enabled by default. The recommended allowlist allows access to: * Common operating system package repositories (for example, Debian, Ubuntu, Red Hat). * Common container registries (for example, Docker Hub, Azure Container Registry, AWS Elastic Container Registry). @@ -51,7 +51,7 @@ The {% data variables.copilot.copilot_coding_agent %} includes a built-in firewa * Common certificate authorities (to allow SSL certificates to be validated). * Hosts used to download web browsers for the Playwright MCP server. -For more information about configuring the {% data variables.copilot.copilot_coding_agent %} firewall, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-firewall). +For more information about configuring the {% data variables.copilot.copilot_cloud_agent %} firewall, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-firewall). The allowlist allows access to the following hosts: diff --git a/content/copilot/reference/custom-agents-configuration.md b/content/copilot/reference/custom-agents-configuration.md index 0994b0e7d20b..54cef61abcfa 100644 --- a/content/copilot/reference/custom-agents-configuration.md +++ b/content/copilot/reference/custom-agents-configuration.md @@ -9,7 +9,7 @@ category: - Configure Copilot --- -This reference article provides detailed configuration information for {% data variables.copilot.custom_agents_short %}. For general information about creating {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents). +This reference article provides detailed configuration information for {% data variables.copilot.custom_agents_short %}. For general information about creating {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents). {% data reusables.copilot.custom-agents-ide-preview %} @@ -26,9 +26,9 @@ The following table outlines the properties that you can configure for {% data v | `target` | string | Target environment or context for the {% data variables.copilot.copilot_custom_agent_short %} (`vscode` or `github-copilot`). If unset, defaults to both environments. | | `tools` | list of strings, string | List of tool names the {% data variables.copilot.copilot_custom_agent_short %} can use. Supports both a comma separated string and yaml string array. If unset, defaults to all tools. See [Tools](#tools). | | `model` | string | Model to use when this {% data variables.copilot.copilot_custom_agent_short %} executes. If unset, inherits the default model. | -| `disable-model-invocation` | boolean | Disables {% data variables.copilot.copilot_coding_agent %} from automatically using this {% data variables.copilot.copilot_custom_agent_short %} based on task context. When `true`, the agent must be manually selected. Setting `disable-model-invocation: true` is equivalent to `infer: false`. If both are set, `disable-model-invocation` takes precedence. If unset, defaults to `false`. | +| `disable-model-invocation` | boolean | Disables {% data variables.copilot.copilot_cloud_agent %} from automatically using this {% data variables.copilot.copilot_custom_agent_short %} based on task context. When `true`, the agent must be manually selected. Setting `disable-model-invocation: true` is equivalent to `infer: false`. If both are set, `disable-model-invocation` takes precedence. If unset, defaults to `false`. | | `user-invocable` | boolean | Controls whether this {% data variables.copilot.copilot_custom_agent_short %} can be selected by a user. When `false`, the agent cannot be manually selected and can only be accessed programmatically. If unset, defaults to `true`. | -| `infer` | boolean | **{% data variables.release-phases.retired_caps %}**. Use `disable-model-invocation` and `user-invocable` instead. Enables {% data variables.copilot.copilot_coding_agent %} to automatically use this {% data variables.copilot.copilot_custom_agent_short %} based on task context. When `false`, the agent must be manually selected. If unset, defaults to `true`. | +| `infer` | boolean | **{% data variables.release-phases.retired_caps %}**. Use `disable-model-invocation` and `user-invocable` instead. Enables {% data variables.copilot.copilot_cloud_agent %} to automatically use this {% data variables.copilot.copilot_custom_agent_short %} based on task context. When `false`, the agent must be manually selected. If unset, defaults to `true`. | | `mcp-servers` | object | Additional MCP servers and tools that should be used by the {% data variables.copilot.copilot_custom_agent_short %}. **Not used in {% data variables.product.prodname_vscode_shortname %} and other IDE {% data variables.copilot.custom_agents_short %}.** | | `metadata` | object consisting of a name and value pair, both strings | Allows annotation of the agent with useful data. **Not used in {% data variables.product.prodname_vscode_shortname %} and other IDE {% data variables.copilot.custom_agents_short %}.** | @@ -38,14 +38,14 @@ Define the agent's behavior, expertise, and instructions in the Markdown content > [!NOTE] > -> * The `argument-hint` and `handoffs` properties from {% data variables.product.prodname_vscode_shortname %} and other IDE {% data variables.copilot.custom_agents_short %} are currently not supported for {% data variables.copilot.copilot_coding_agent %} on {% data variables.product.prodname_dotcom_the_website %}. They are ignored to ensure compatibility. +> * The `argument-hint` and `handoffs` properties from {% data variables.product.prodname_vscode_shortname %} and other IDE {% data variables.copilot.custom_agents_short %} are currently not supported for {% data variables.copilot.copilot_cloud_agent %} on {% data variables.product.prodname_dotcom_the_website %}. They are ignored to ensure compatibility. > * For more information on {% data variables.copilot.copilot_custom_agent_short %} file structure in {% data variables.product.prodname_vscode_shortname %}, see [{% data variables.copilot.custom_agents_caps_short %} in {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/copilot/customization/custom-agents#_custom-agent-file-structure) in the {% data variables.product.prodname_vscode_shortname %} documentation. ## Tools The {% data variables.copilot.copilot_custom_agent_short %} `tools` property controls which tools are available to your agent, including those from MCP servers. -Your {% data variables.copilot.copilot_custom_agent_short %} will have access to MCP server tools that have been configured in both its {% data variables.copilot.agent_profile %} and/or the repository settings. For more information on configuring MCP servers for cloud agent in a repository, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp). +Your {% data variables.copilot.copilot_custom_agent_short %} will have access to MCP server tools that have been configured in both its {% data variables.copilot.agent_profile %} and/or the repository settings. For more information on configuring MCP servers for cloud agent in a repository, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp). You can configure `tools` using the following approaches: @@ -62,19 +62,19 @@ All unrecognized tool names are ignored, which allows product-specific tools to The following tool aliases are available for {% data variables.copilot.custom_agents_short %}. All aliases are case insensitive: -| Primary alias | Compatible aliases | {% data variables.copilot.copilot_coding_agent_short_cap_c %} mapping | Purpose | +| Primary alias | Compatible aliases | {% data variables.copilot.copilot_cloud_agent_short_cap_c %} mapping | Purpose | | ------------- | -------------------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | | `execute` | `shell`, `Bash`, `powershell` | Shell tools: `bash` or `powershell` | Execute a command in the appropriate shell for the operating system. | | `read` | `Read`, `NotebookRead` | `view` | Read file contents. | | `edit` | `Edit`, `MultiEdit`, `Write`, `NotebookEdit` | Edit tools: e.g. `str_replace`, `str_replace_editor` | Allow LLM to edit. Exact arguments can vary. | | `search` | `Grep`, `Glob` | `search` | Search for files or text in files. | | `agent` | `custom-agent`, `Task` | "{% data variables.copilot.copilot_custom_agent_caps_short %}" tools | Allows a different {% data variables.copilot.copilot_custom_agent_short %} to be invoked to accomplish a task. | -| `web` | `WebSearch`, `WebFetch` | Currently not applicable for {% data variables.copilot.copilot_coding_agent_short %}. | Allows fetching content from URLs and performing a web search | -| `todo` | `TodoWrite` | Currently not applicable for {% data variables.copilot.copilot_coding_agent_short %}. | Creates and manages structured task lists. Not supported in {% data variables.copilot.copilot_coding_agent_short %} today, but supported by {% data variables.product.prodname_vscode_shortname %}. | +| `web` | `WebSearch`, `WebFetch` | Currently not applicable for {% data variables.copilot.copilot_cloud_agent_short %}. | Allows fetching content from URLs and performing a web search | +| `todo` | `TodoWrite` | Currently not applicable for {% data variables.copilot.copilot_cloud_agent_short %}. | Creates and manages structured task lists. Not supported in {% data variables.copilot.copilot_cloud_agent_short %} today, but supported by {% data variables.product.prodname_vscode_shortname %}. | ### Tool names for "out-of-the-box" MCP servers -The following MCP servers are available out-of-box for {% data variables.copilot.copilot_coding_agent %} and can be referenced using namespacing: +The following MCP servers are available out-of-box for {% data variables.copilot.copilot_cloud_agent %} and can be referenced using namespacing: | MCP server name | Available tools | | --------------- | --------------- | @@ -103,18 +103,18 @@ mcp-servers: Prompt with suggestions for behavior and output ``` -The `mcp-servers` property in an {% data variables.copilot.agent_profile %} is a YAML representation of the JSON configuration format used to configure MCP servers for {% data variables.copilot.copilot_coding_agent %}. +The `mcp-servers` property in an {% data variables.copilot.agent_profile %} is a YAML representation of the JSON configuration format used to configure MCP servers for {% data variables.copilot.copilot_cloud_agent %}. -Most sub-properties are the same as the JSON representation. The following sections describe changes from the initial implementation of MCP configuration in {% data variables.copilot.copilot_coding_agent %} that are relevant to {% data variables.copilot.custom_agents_short %}. For more information about the JSON configuration format, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/extend-coding-agent-with-mcp#writing-a-json-configuration-for-mcp-servers). +Most sub-properties are the same as the JSON representation. The following sections describe changes from the initial implementation of MCP configuration in {% data variables.copilot.copilot_cloud_agent %} that are relevant to {% data variables.copilot.custom_agents_short %}. For more information about the JSON configuration format, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/extend-cloud-agent-with-mcp#writing-a-json-configuration-for-mcp-servers). ### MCP server type -For compatibility, the `stdio` type used by Claude Code and {% data variables.product.prodname_vscode_shortname %} is mapped to {% data variables.copilot.copilot_coding_agent_short %}'s `local` type. +For compatibility, the `stdio` type used by Claude Code and {% data variables.product.prodname_vscode_shortname %} is mapped to {% data variables.copilot.copilot_cloud_agent_short %}'s `local` type. ### MCP server environment variables and secrets > [!NOTE] -> If your MCP server requires secrets or environment variables, these must be configured in the {% data variables.product.prodname_copilot_short %} environment in each repository where the {% data variables.copilot.copilot_custom_agent_short %} will be used. For more information on setting up environment variables, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment#setting-environment-variables-in-copilots-environment). +> If your MCP server requires secrets or environment variables, these must be configured in the {% data variables.product.prodname_copilot_short %} environment in each repository where the {% data variables.copilot.copilot_custom_agent_short %} will be used. For more information on setting up environment variables, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/cloud-agent/customize-the-agent-environment#setting-environment-variables-in-copilots-environment). {% data variables.copilot.copilot_custom_agent_caps_short %} MCP configuration supports the same environment variable and secret replacement capabilities as existing repository-level MCP configurations. Similar to repository-level configurations, secrets and variables can be sourced from the "copilot" environment in the repository's settings. The syntax for referencing these values has been expanded to support common patterns used in {% data variables.product.prodname_actions %} and Claude Code. diff --git a/content/copilot/reference/custom-instructions-support.md b/content/copilot/reference/custom-instructions-support.md index ef8217f66bf3..443212ac859e 100644 --- a/content/copilot/reference/custom-instructions-support.md +++ b/content/copilot/reference/custom-instructions-support.md @@ -36,7 +36,7 @@ WRITING NOTE: The following tables have been written using HTML rather than Mark - {% data variables.copilot.copilot_coding_agent %} + {% data variables.copilot.copilot_cloud_agent %}