插件为兼容的 Copilot 界面打包自定义项。 插件格式、组件和支持的位置因界面而异。 使用计划在其中安装插件的平台的文档。
插件清单
插件由 plugin.json 清单描述。 Agent Plugins 为兼容的平台定义可移植的插件格式。 清单文件位于插件目录的根目录中,并声明代理插件架构描述。 对于代理插件 1.0,请使用 https://agent-plugins.org/schemas/1.0.0/plugin.schema.json。
Copilot CLI 还识别 1.1.0 模式。
共享代理插件格式定义某些组件的标准位置。 对这些组件的支持可能因表面而异:
| 组分 | 代理插件位置 | 备注 |
|---|---|---|
| 技能 | skills/ | 兼容的界面可以在此位置识别技能。 |
| MCP 服务器 | ||
mcp.json 在插件根目录中 | 兼容的界面可以在此位置发现 MCP 服务器配置。 | |
| Surface 专用组件 | 命名空间目录,如 com.github.copilot/ | 可用性和支持的组件取决于表面。 |
代理插件 1.0 目录可以使用以下结构:
my-plugin/
├── plugin.json
├── skills/
│ └── deploy/
│ └── SKILL.md
├── mcp.json
└── com.github.copilot/
├── agents/
│ └── helper.agent.md
├── commands/
├── rules/
├── hooks/
│ └── hooks.json
└── lsp.json
清单 plugin.json 声明代理插件模式。
skills/ 和根 mcp.json 位置由 Agent 插件定义。 该com.github.copilot/目录包含特定于 Copilot 的组件,而非可移植的 Agent Plugins 组件。 图面从此目录加载哪些组件,取决于该图面。 有关Copilot CLI,请参阅GitHub Copilot CLI 插件参考。
Copilot CLI 还支持旧 Copilot 插件格式。 它使用不同的组件发现行为和可配置的组件路径。 有关清单字段、验证、文件位置和特定于 CLI 的行为,请参阅 GitHub Copilot CLI 插件参考。
Visual Studio Code 在 代理插件编写参考中记录其插件编写格式和支持的行为。 不要假定一个界面上支持的组件或清单行为在另一个界面上受支持。
应用市场目录
目录清单 marketplace.json 提供有关市场的元数据,并在其顶级 plugins 数组中列出插件。 每个插件条目都可以包括其名称、说明、版本和源。 源位置标识插件文件所在的位置。 对于 Copilot CLI,marketplace.json 是唯一必需的商城组件。 其他表面可以有其他要求。
市场平台名称来自其 name 字段,而不是来自仓库名称。 插件标识符将插件名称与市场名称组合在一起:
PLUGIN-NAME@MARKETPLACE-NAME
当设置引用它们时,使应用市场和插件名称保持稳定。 更改市场名称会更改这些设置使用的插件标识符。
目录字段和支持的文件位置可能因平台而异。 有关 Copilot CLI 的完整市场目录字段和位置,请参阅 GitHub Copilot CLI 插件参考。 有关在存储库中 GitHub 发布目录的步骤,请参阅 在 GitHub 上创建和共享插件市场。
使用插件
添加市场后,其插件可供浏览。 安装插件会将其添加到画布。 启用插件可在该界面上的会话中使用其组件。 有关特定于表面的说明,请参阅: