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
5 changes: 3 additions & 2 deletions content/copilot/concepts/agents/about-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: About {% data variables.product.prodname_copilot %} plugins
shortTitle: Plugins
allowTitleToDifferFromFilename: true
intro: 'Plugins are installable packages that extend {% data variables.product.prodname_copilot_short %} with reusable agents, skills, hooks, and integrations.'
product: '{% data reusables.gated-features.copilot-cli %}<br><br>{% data reusables.gated-features.copilot-cloud-agent %}<br><a href="https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=button" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Sign up for {% data variables.product.prodname_copilot_short %}</span> {% octicon "link-external" height:16 %}</a>'
product: '{% data reusables.gated-features.copilot-cli %}<br><br>{% data reusables.gated-features.copilot-cloud-agent %}<br><br>{% data reusables.gated-features.github-app %}<br><a href="https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=button" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Sign up for {% data variables.product.prodname_copilot_short %}</span> {% octicon "link-external" height:16 %}</a>'
versions:
feature: copilot
contentType: concepts
Expand All @@ -16,7 +16,7 @@ redirect_from:
- /copilot/concepts/agents/copilot-cli/about-cli-plugins
---

Plugins provide a way to distribute custom {% data variables.product.prodname_copilot_short %} functionality. You can use a plugin to add a preconfigured set of capabilities to {% data variables.product.prodname_copilot_short %}, including {% data variables.copilot.copilot_cli_short %} and {% data variables.copilot.copilot_cloud_agent %}.
Plugins provide a way to distribute custom {% data variables.product.prodname_copilot_short %} functionality. You can use a plugin to add a preconfigured set of capabilities to {% data variables.product.prodname_copilot_short %}, including {% data variables.copilot.copilot_cli_short %}, {% data variables.copilot.copilot_cloud_agent %}, and the {% data variables.copilot.github_copilot_app %}.

## What is a plugin?

Expand Down Expand Up @@ -84,6 +84,7 @@ How you install a plugin depends on which client you're using:

* In {% data variables.copilot.copilot_cli_short %}, you can install plugins imperatively using the `copilot plugin install` command or the `/plugin install` slash command, or declaratively by adding the plugin to the `enabledPlugins` field of either a user-level `~/.copilot/settings.json` file or a repository-level `.github/copilot/settings.json` file. See [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/plugins-finding-installing).
* In {% data variables.copilot.copilot_cloud_agent %}, you install plugins declaratively by adding them to the `enabledPlugins` field of the repository's `.github/copilot/settings.json` file. To install plugins from a marketplace that isn't registered by default, you can also add the marketplace to the `extraKnownMarketplaces` field in the same file.
* In the {% data variables.copilot.github_copilot_app %}, click **Customize**, then click **Plugins** to browse marketplaces and install plugins.

Enterprise administrators can define plugin standards that apply to users on the enterprise's {% data variables.product.prodname_copilot_short %} plan, including specifying additional marketplaces and plugins that are automatically installed. See [AUTOTITLE](/copilot/concepts/agents/about-enterprise-plugin-standards).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,53 @@ category:

Tailor the {% data variables.copilot.github_copilot_app %} to your workflows so your agents follow your conventions, use your preferred tools, and apply the right expertise to every task.

The **Customize** tab in the app sidebar allows you to discover and manage MCP servers, plugins, skills, and canvases in one place. From this tab, you can:

* Explore featured customizations as a starting point if you do not already know which customization you need.
* Browse by customization type.
* Find MCP servers by viewing trending options or browsing by category.
* Review customizations already available for you to use in the **Installed** view.

## Setting global and repository instructions

You can set global instructions in the app settings under **General**.
You can add instructions that apply globally or only to a specific repository.

### Setting global instructions

Global instructions apply to every session across all projects.

1. Open the app settings.
1. Click **Sessions**.
1. Under "Instructions," edit "App instructions."

### Setting repository-specific instructions

Repository-specific instructions apply to every session for the selected repository.

You can set repository-specific instructions in the app settings, under the repository name in the "Projects" section.
1. Open the app settings.
1. Under "Projects," click the repository.
1. Edit the "Instructions" field.

## Adding agent skills

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. Any skills configured for your repositories or {% data variables.product.prodname_copilot_short %} CLI are automatically available in the {% data variables.copilot.github_copilot_app %}. You can also add and manage skills in the app settings under **Skills**.
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. Any skills configured for your repositories or {% data variables.product.prodname_copilot_short %} CLI are automatically available in the {% data variables.copilot.github_copilot_app %}. To add or manage skills, click **Customize** in the app sidebar, then click **Skills**.

For more information about agent skills, see [AUTOTITLE](/copilot/concepts/agents/about-agent-skills).

For a {% data variables.product.github %}-provided built-in skills reference, see [AUTOTITLE](/copilot/reference/github-copilot-app-reference/built-in-skills).

## Configuring MCP servers

MCP servers connect the agent to external tools and data sources. Any MCP servers configured for your repositories or {% data variables.product.prodname_copilot_short %} CLI are automatically available in the {% data variables.copilot.github_copilot_app %}. You can also add and manage additional MCP servers in the app settings under **MCP Servers**. The app includes a catalog of popular servers, or you can add a custom server.
MCP servers connect the agent to external tools and data sources. Any MCP servers configured for your repositories or {% data variables.product.prodname_copilot_short %} CLI are automatically available in the {% data variables.copilot.github_copilot_app %}.

To discover and install an MCP server:

1. Click **Customize** in the app sidebar.
1. Click **MCP**.
1. Explore featured or trending servers, browse by category, or add a custom server.
1. Select a server and follow the prompts to install it.

To view or manage MCP servers that are already installed, click **Installed**.

For more information about MCP, see [AUTOTITLE](/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers).

Expand All @@ -49,15 +79,26 @@ For more information, see [AUTOTITLE](/copilot/concepts/agents/cloud-agent/about

## Adding plugins

Plugins are installable packages that add a preconfigured set of capabilities, such as skills, hooks, and {% data variables.copilot.custom_agents_short %}, extending {% data variables.copilot.github_copilot_app %}'s functionality.
Plugins are installable packages that add a preconfigured set of capabilities, such as skills, hooks, {% data variables.copilot.custom_agents_short %}, MCP servers, and canvas extensions, extending the functionality of the {% data variables.copilot.github_copilot_app %}.

The **Plugins** view shows plugins from the marketplaces configured in the app. You can filter the list by marketplace or add a custom marketplace.

To browse and install a plugin:

1. Click **Customize** in the app sidebar, then click **Plugins**.
1. Optionally, use the marketplace dropdown to filter the available plugins.
1. Find the plugin you want to use, then click **Install**.

To add a custom marketplace:

To browse and install plugins, open app settings, then click **Plugins**.
1. In the **Plugins** view, click the {% octicon "gear" aria-label="The marketplace settings icon" %} icon next to the marketplace dropdown.
1. Follow the prompts to add the {% data variables.product.github %} repository or Git URL that hosts the marketplace.

For more information, see [AUTOTITLE](/copilot/concepts/agents/about-plugins).

## Working with canvas extensions

Use canvas extensions to build shared, agent-driven artifacts and interfaces for team or personal workflows. In a session, use `/create-canvas` to scaffold a canvas extension, then iterate on the canvas with the agent. For more information, see [AUTOTITLE](/copilot/how-tos/github-copilot-app/working-with-canvas-extensions).
Use canvas extensions to build shared, agent-driven artifacts and interfaces for team or personal workflows. You can find canvases under **Canvas** in **Customize**, or use `/create-canvas` in a session to create your own. For more information, see [AUTOTITLE](/copilot/how-tos/github-copilot-app/working-with-canvas-extensions).

## Organization and enterprise management

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ The sidebar gives you access to the main areas of the app:

* **[My work](https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fmywork)** — Browse and filter issues and pull requests from your repositories, check CI status, and leave reviews.
* **[Automations](https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fautomations)** — Saved agent tasks that run on a schedule or on demand.
* **Customize** — Discover and manage plugins, skills, MCP servers, and canvases.
* **Search** — Search across your repositories directly from the app.
* **Sessions** — Active agent sessions, grouped by project.
* **Chats** — General conversations that do not require a dedicated branch or workspace.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ https://github.com/copilot/app/launch?open=ghapp%3A%2F%2Fplugins%2Finstall%3Fsou

### Plugin parameters

Plugin links open Settings > Plugins with a form pre-filled. They do not install a plugin or add a marketplace until the user confirms in the app.
Plugin links open the **Plugins** view in **Customize** with a form pre-filled. They do not install a plugin or add a marketplace until the user confirms in the app.

| Link | Parameter | Required | Notes |
| --- | --- | --- | --- |
Expand Down Expand Up @@ -244,5 +244,5 @@ The following app links can be wrapped in the hosted launcher. Query strings and
| `ghapp://repo/OWNER/REPO` | Repository setup | Shows a confirmation before cloning or opening repository setup. |
| `ghapp://session/new` | New session | Shows a confirmation before creating a session. Use query parameters to provide the repository, pull request, branch, prompt, or session mode. See [Session parameters](#session-parameters). |
| `ghapp://session/new/OWNER/REPO` | New session for a repository | Shows a confirmation before creating a session for the repository. See [Session parameters](#session-parameters). |
| `ghapp://plugins/install` | Plugin install form | Shows a confirmation, then opens Settings > Plugins with the install form pre-filled. See [Plugin parameters](#plugin-parameters). |
| `ghapp://plugins/marketplace/add` | Plugin marketplace form | Shows a confirmation, then opens Settings > Plugins with the marketplace form pre-filled. See [Plugin parameters](#plugin-parameters). |
| `ghapp://plugins/install` | Plugin install form | Shows a confirmation, then opens the **Plugins** view in the **Customize** tab with the install form pre-filled. See [Plugin parameters](#plugin-parameters). |
| `ghapp://plugins/marketplace/add` | Plugin marketplace form | Shows a confirmation, then opens the **Plugins** view in the **Customize** tab with the marketplace form pre-filled. See [Plugin parameters](#plugin-parameters). |
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ category:

A canvas extension is a shared, interactive surface for a work artifact, such as a plan, triage board, browser session, release checklist, dashboard, incident, or spreadsheet.

A canvas extension can be included in a plugin alongside other capabilities, such as skills or MCP servers.

While chat is useful for defining intent and discussing tasks, most work happens in work surfaces such as a terminal, a browser, a document, or a dashboard. Canvases allow you to collaborate with the agent directly in those work surfaces.

Canvases are bidirectional: the agent can update the canvas while it works, and you can edit on that same surface. When you create a canvas, the agent generates capabilities based on your prompt and workflow. As you iterate, you can ask it to add, remove, or revise those capabilities. Once created, canvases open in the app's right side panel.
Expand Down Expand Up @@ -43,6 +45,18 @@ Canvas extensions can be customized to fit your needs or your team's needs acros
* **Markdown canvases:** Build a persistent markdown file for planning your day, prioritizing issues and pull requests, launching and monitoring agent sessions, and keeping related work in one editable surface.
* **Document canvases:** Open, edit, and collaborate on documents, spreadsheets, slide decks, and other artifacts directly in the app.

## Discovering canvases

The **Canvas** view provides a curated list of featured canvases. Some canvases are delivered through plugins, which you must install before you can use the canvas in a session. For example, installing the Azure DevOps plugin gives you access to a canvas for planning and managing Azure DevOps work.

1. In the app sidebar, click **Customize**.
1. Click **Canvas**.
1. Browse the featured canvases.
1. If a canvas requires a plugin, click **Install plugin**.
1. Click **New session** to open a session with the canvas.

You can also click **Installed** to view all installed customizations, including the canvases available for you to use.

## Creating a canvas

You can create a new canvas from within a session using the `/create-canvas` skill.
Expand All @@ -61,7 +75,7 @@ The agent will build the canvas and open it in the right side panel once complet

## How canvas extensions are structured

Each canvas extension lives in its own directory under either `.github/extensions` (project scope) or `~/.copilot/extensions` (user scope).
Canvas extensions that you create in the app or install directly live in their own directory under either `.github/extensions` (project scope) or `~/.copilot/extensions` (user scope).

Although implementations can vary, a canvas extension commonly includes:

Expand Down
Loading