Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ To configure your {% data variables.copilot.agent_profile %}:
1. If creating an organization or enterprise level agent on {% data variables.product.github %}, you can use the `mcp-servers` property to optionally configure MCP servers that will be available only to this agent to extend its capabilities.
1. If you are creating and using the {% data variables.copilot.agent_profile %} in {% data variables.product.prodname_vscode_shortname %}, JetBrains IDEs, Eclipse, or Xcode, you can also use the `model` property to control which AI model the agent should use.
1. Optionally, set the `target` property to either `vscode` or `github-copilot` if you want to only use the agent in a specific environment. The agent will be available in both environments if you omit the property.
1. Write the agent's prompt. Define the agent's behavior, expertise, and instructions in the Markdown content below the YAML frontmatter.
1. Write the agent's prompt. Define the agent's behavior, expertise, and instructions in the Markdown content below the YAML frontmatter. The prompt can be a maximum of 30,000 characters.

## Example {% data variables.copilot.agent_profiles %}

Expand Down
6 changes: 4 additions & 2 deletions content/copilot/reference/custom-agents-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ This reference article provides detailed configuration information for {% data v

## YAML frontmatter properties

The following table outlines the properties that are supported in repository-level {% data variables.copilot.agent_profiles %}, organization or enterprise level {% data variables.copilot.agent_profiles %}, and in {% data variables.product.prodname_vscode_shortname %}.
The following table outlines the properties that are supported in repository-level {% data variables.copilot.agent_profiles %}, organization or enterprise level {% data variables.copilot.agent_profiles %}, and in {% data variables.product.prodname_vscode_shortname %}. The configuration file's name (minus `.md` or `.agent.md`) is used for deduplication between levels so that the lowest level configuration takes precedence.

{% rowheaders %}

| Property | Type | Purpose | Repository | Organization / enterprise | {% data variables.product.prodname_vscode_shortname %}, JetBrains IDEs, Eclipse, and Xcode |
| ------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | ------------------------- | ------------------ |
| `name` | string | Unique name for the {% data variables.copilot.copilot_custom_agent_short %}. Optional, if unset defaults to the filename (without `.md` or `.agent.md` suffix). <br/> Lowest level configuration takes precedence when there is a naming conflict. | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
| `name` | string | Display name for the {% data variables.copilot.copilot_custom_agent_short %}. Optional. | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
| `description` | **Required** string | Description of the {% data variables.copilot.copilot_custom_agent_short %}'s purpose and capabilities | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
| `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. | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
| `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). | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} |
Expand All @@ -31,6 +31,8 @@ The following table outlines the properties that are supported in repository-lev

{% endrowheaders %}

Define the agent's behavior, expertise, and instructions in the Markdown content below the YAML frontmatter. The prompt can be a maximum of 30,000 characters.

> [!NOTE]
> The `model`, `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. 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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ If you manage multiple organizations with an enterprise account, you can help me

## Adding a public organization profile README

>[!NOTE] Public organizations are not available with {% data variables.product.prodname_emus %}.

The content of public `README.md` will appear on your organization's public profile.

1. If your organization does not already have a public `.github` repository, create a public `.github` repository.
Expand Down
76 changes: 2 additions & 74 deletions src/audit-logs/data/fpt/organization.json
Original file line number Diff line number Diff line change
Expand Up @@ -1318,78 +1318,6 @@
"custom_instructions"
]
},
{
"action": "copilot.knowledge_base_created",
"description": "A knowledge base was created in the organization.",
"docs_reference_links": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases",
"fields": [
"actor",
"actor_id",
"user_agent",
"request_id",
"knowledge_base_name",
"org_id",
"org",
"action",
"_document_id",
"@timestamp",
"created_at",
"operation_type",
"business",
"business_id",
"actor_is_bot",
"request_access_security_header"
],
"docs_reference_titles": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases"
},
{
"action": "copilot.knowledge_base_deleted",
"description": "A knowledge base was deleted from the organization.",
"docs_reference_links": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases",
"fields": [
"actor",
"actor_id",
"user_agent",
"request_id",
"knowledge_base_name",
"org_id",
"org",
"action",
"_document_id",
"@timestamp",
"created_at",
"operation_type",
"business",
"business_id",
"actor_is_bot",
"request_access_security_header"
],
"docs_reference_titles": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases"
},
{
"action": "copilot.knowledge_base_updated",
"description": "A knowledge base was updated in the organization.",
"docs_reference_links": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases",
"fields": [
"actor",
"actor_id",
"user_agent",
"request_id",
"knowledge_base_name",
"org_id",
"org",
"action",
"_document_id",
"@timestamp",
"created_at",
"operation_type",
"business",
"business_id",
"actor_is_bot",
"request_access_security_header"
],
"docs_reference_titles": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases"
},
{
"action": "copilot.plan_changed",
"description": "The plan for GitHub Copilot was updated.",
Expand Down Expand Up @@ -5015,7 +4943,7 @@
{
"action": "org.allow_third_party_access_requests_from_outside_collaborators_enabled",
"description": "Third-party application access for outside collaborators was enabled for the organization.",
"docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests#enabling-or-disabling-integration-access-requests",
"docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests-and-installations#enabling-or-disabling-app-access-requests",
"fields": [
"actor",
"actor_id",
Expand All @@ -5029,7 +4957,7 @@
"created_at",
"operation_type"
],
"docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests#enabling-or-disabling-integration-access-requests"
"docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests-and-installations#enabling-or-disabling-app-access-requests"
},
{
"action": "org.archive",
Expand Down
72 changes: 0 additions & 72 deletions src/audit-logs/data/ghec/enterprise.json
Original file line number Diff line number Diff line change
Expand Up @@ -4233,78 +4233,6 @@
"operation_type"
]
},
{
"action": "copilot.knowledge_base_created",
"description": "A knowledge base was created in the organization.",
"docs_reference_links": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases",
"fields": [
"actor",
"actor_id",
"user_agent",
"request_id",
"knowledge_base_name",
"org_id",
"org",
"action",
"_document_id",
"@timestamp",
"created_at",
"operation_type",
"business",
"business_id",
"actor_is_bot",
"request_access_security_header"
],
"docs_reference_titles": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases"
},
{
"action": "copilot.knowledge_base_deleted",
"description": "A knowledge base was deleted from the organization.",
"docs_reference_links": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases",
"fields": [
"actor",
"actor_id",
"user_agent",
"request_id",
"knowledge_base_name",
"org_id",
"org",
"action",
"_document_id",
"@timestamp",
"created_at",
"operation_type",
"business",
"business_id",
"actor_is_bot",
"request_access_security_header"
],
"docs_reference_titles": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases"
},
{
"action": "copilot.knowledge_base_updated",
"description": "A knowledge base was updated in the organization.",
"docs_reference_links": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases",
"fields": [
"actor",
"actor_id",
"user_agent",
"request_id",
"knowledge_base_name",
"org_id",
"org",
"action",
"_document_id",
"@timestamp",
"created_at",
"operation_type",
"business",
"business_id",
"actor_is_bot",
"request_access_security_header"
],
"docs_reference_titles": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases"
},
{
"action": "copilot.plan_changed",
"description": "The plan for GitHub Copilot was updated.",
Expand Down
76 changes: 2 additions & 74 deletions src/audit-logs/data/ghec/organization.json
Original file line number Diff line number Diff line change
Expand Up @@ -1318,78 +1318,6 @@
"custom_instructions"
]
},
{
"action": "copilot.knowledge_base_created",
"description": "A knowledge base was created in the organization.",
"docs_reference_links": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases",
"fields": [
"actor",
"actor_id",
"user_agent",
"request_id",
"knowledge_base_name",
"org_id",
"org",
"action",
"_document_id",
"@timestamp",
"created_at",
"operation_type",
"business",
"business_id",
"actor_is_bot",
"request_access_security_header"
],
"docs_reference_titles": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases"
},
{
"action": "copilot.knowledge_base_deleted",
"description": "A knowledge base was deleted from the organization.",
"docs_reference_links": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases",
"fields": [
"actor",
"actor_id",
"user_agent",
"request_id",
"knowledge_base_name",
"org_id",
"org",
"action",
"_document_id",
"@timestamp",
"created_at",
"operation_type",
"business",
"business_id",
"actor_is_bot",
"request_access_security_header"
],
"docs_reference_titles": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases"
},
{
"action": "copilot.knowledge_base_updated",
"description": "A knowledge base was updated in the organization.",
"docs_reference_links": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases",
"fields": [
"actor",
"actor_id",
"user_agent",
"request_id",
"knowledge_base_name",
"org_id",
"org",
"action",
"_document_id",
"@timestamp",
"created_at",
"operation_type",
"business",
"business_id",
"actor_is_bot",
"request_access_security_header"
],
"docs_reference_titles": "copilot/github-copilot-enterprise/copilot-chat-in-github/managing-copilot-knowledge-bases"
},
{
"action": "copilot.plan_changed",
"description": "The plan for GitHub Copilot was updated.",
Expand Down Expand Up @@ -5015,7 +4943,7 @@
{
"action": "org.allow_third_party_access_requests_from_outside_collaborators_enabled",
"description": "Third-party application access for outside collaborators was enabled for the organization.",
"docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests#enabling-or-disabling-integration-access-requests",
"docs_reference_links": "/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests-and-installations#enabling-or-disabling-app-access-requests",
"fields": [
"actor",
"actor_id",
Expand All @@ -5029,7 +4957,7 @@
"created_at",
"operation_type"
],
"docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests#enabling-or-disabling-integration-access-requests"
"docs_reference_titles": "/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests-and-installations#enabling-or-disabling-app-access-requests"
},
{
"action": "org.archive",
Expand Down
Loading
Loading