Skip to content

Document plugin formats and environment variables #9634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alexdioso wants to merge 3 commits into
base: main
Choose a base branch
from
+15 −0
Open

Document plugin formats and environment variables #9634

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a9e6c4c
Document plugin formats and environment variables
alexdioso Apr 8, 2026
7fffee9
Apply suggestion from @Copilot
ntrogh Apr 13, 2026
e8a35bd
Apply suggestion from @Copilot
ntrogh Apr 13, 2026
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
15 changes: 15 additions & 0 deletions docs/copilot/customization/agent-plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,21 @@ Once installed, plugin-provided customizations appear alongside your locally def
> [!CAUTION]
> Plugins can include hooks and MCP servers that run code on your machine. Review the plugin contents and publisher before installing, especially for plugins from community marketplaces.

## Plugin formats
The plugin format is auto-selected based on the plugin file path (relative to the plugin root).
Copy link
Copy Markdown
Contributor

@ntrogh ntrogh Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The plugin format is auto-selected based on the plugin file path (relative to the plugin root).
VS Code auto-detects the plugin format by checking for format-specific manifest paths. Copilot format is used as the default when no other format markers are found.

| Plugin format | Plugin file path(s) |
|---------------|------------------|
| Claude | `.claude-plugin/plugin.json` |
| Copilot | `plugin.json`, `.github/plugin/plugin.json` |
Copy link
Copy Markdown
Contributor

@ntrogh ntrogh Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Copilot | `plugin.json`, `.github/plugin/plugin.json` |

| OpenPlugin | `.plugin/plugin.json` |

### Plugin environment variables
Copy link
Copy Markdown
Contributor

@ntrogh ntrogh Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Plugin environment variables
### Plugin environment variables
Some plugin formats provide a root token that you can use in hook commands and MCP server configurations to reference files within the plugin directory. VS Code expands the token at runtime and also sets it as an environment variable in the hook or server process.

| Plugin format | Plugin root |
|---------------|------------------|
| Claude | `${CLAUDE_PLUGIN_ROOT}` |
| Copilot | (Not Defined) |
Copy link
Copy Markdown
Contributor

@ntrogh ntrogh Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| Copilot | (Not Defined) |
| Copilot | (Not defined) |

| OpenPlugin | `${PLUGIN_ROOT}` |

## Hooks in plugins

Plugins can include [hooks](/docs/copilot/customization/hooks.md) that run shell commands at agent lifecycle points. Plugin hooks work alongside your workspace and user-level hooks. When a plugin is enabled, its hooks fire in addition to any other hooks configured for the same event.
Expand Down