Skip to main content

Sobre plug-ins GitHub Copilot

Os plugins são pacotes instaláveis que ampliam Copilot com agentes, habilidades, ganchos e integrações reutilizáveis.

Quem pode usar esse recurso?

GitHub Copilot CLI está disponível com todos os Copilot planos. Se você receber Copilot de uma organização, a Copilot CLI política deverá ser habilitada nas configurações da organização.

Copilot cloud agent está disponível para todos os planos Copilot pagos.

O agente está disponível em todos os repositórios armazenados em GitHub, exceto nos repositórios de propriedade de contas de usuário gerenciadas e onde foi explicitamente desativado.

GitHub Copilot app está disponível para todos os Copilot planos.
Sign up for Copilot

Os plug-ins fornecem uma maneira de distribuir a funcionalidade personalizada Copilot . Você pode usar um plug-in para adicionar um conjunto pré-configurado de recursos a Copilot, incluindo Copilot CLI, Copilot cloud agente a GitHub Copilot app.

O que é um plug-in?

  • Um pacote distribuível que estende a funcionalidade de Copilot.
  • Um pacote de componentes em uma única unidade instalável.

O que os plug-ins contêm

Um plug-in pode conter alguns ou todos os componentes a seguir. Os locais desses componentes dependem do formato de plug-in:

  • Agentes personalizados – assistentes de IA especializados (*.agent.md arquivos em agents/)
  • Habilidades – funcionalidades discretas que podem ser chamadas (subdiretórios de habilidades skills/, contendo um SKILL.md arquivo)
  • Ganchos – manipuladores de eventos que interceptam o comportamento do agente (um arquivo hooks.json no diretório raiz do plug-in ou em hooks/)
  • Configurações do servidor MCP — integrações do Protocolo de Contexto de Modelo
  • Configurações do servidor LSP – integrações do Protocolo do Servidor de Idiomas (um lsp.json arquivo na raiz do plug-in ou em .github/)

Formatos de plug-in

Copilot dá suporte a dois formatos de plug-in:

  • Agent Plugins 1.0 é um formato portátil para compartilhar habilidades e configurações de servidor MCP entre clientes compatíveis. Para usar esse formato, defina $schema como https://agent-plugins.org/schemas/1.0.0/plugin.schema.json``plugin.json . As habilidades são descobertas a partir de skills/, e a configuração do servidor MCP é descoberta a partir de mcp.json na raiz do plug-in. Esses locais não podem ser configurados no manifesto. Escolha Plugins de agente 1.0 quando quiser tornar as habilidades e os servidores MCP portáteis.
  • Os Copilot plug-ins herdados não declaram os plug-ins $schemado agente. Eles usam os campos existentes do manifesto e o comportamento de descoberta de componentes, incluindo caminhos de componentes configuráveis e a configuração de MCP em .mcp.json, .github/mcp.json ou no campo de manifesto mcpServers. Escolha o formato herdado quando precisar de caminhos de componente configuráveis ou se estiver mantendo um plug-in específico existente Copilot.

Para um novo plug-in, use o Agent Plug-ins 1.0, a menos que você exija caminhos de componente configuráveis. Use o formato herdado principalmente para plug-ins herdados existentes.

Há suporte para ambos os formatos. Adicionar $schema altera a forma como Copilot interpreta o manifesto e descobre componentes. Plugins sem $schema continuam a ser carregados como plugins legados.

Como os plug-ins são estruturados

Um plug-in é um diretório com uma estrutura específica e um arquivo de plugin.json manifesto. O Agent Plugins 1.0 requer o manifesto na raiz do plugin. Plugins legados oferecem suporte a locais adicionais de manifesto. O manifesto fornece ao plug-in um nome e metadados. Dependendo do formato, ele também pode apontar para componentes. Junto com o manifesto, o diretório pode conter agentes, habilidades, ganchos, configurações de servidor MCP e configurações de servidor LSP.

Estrutura dos plug-ins do agente 1.0

O Agent Plugins 1.0 armazena habilidades e servidores MCP em locais padrão para que clientes compatíveis possam descobri-los. Outros componentes, incluindo agentes, ganchos, comandos e servidores LSP, são específicos do cliente. Copilot lê esses componentes do com.github.copilot diretório. Outros clientes ignoram esse diretório, assim o mesmo plugin pode combinar habilidades compartilhadas e servidores MCP com componentes específicos de Copilot.

Um diretório do Agent Plug-ins 1.0 pode ter esta aparência:

my-plugin/
├── plugin.json               # Required manifest
├── skills/                   # Skills (optional)
│   └── deploy/
│       └── SKILL.md
├── mcp.json                  # MCP server config (optional)
└── com.github.copilot/       # Copilot components (optional)
    ├── agents/
    │   └── helper.agent.md
    ├── commands/
    ├── rules/
    ├── hooks/
    │   └── hooks.json
    └── lsp.json

O manifesto deve incluir o Agent Plugins 1.0 $schema. Para campos compatíveis de nível superior do manifesto, requisitos de nomenclatura e locais dos componentes, consulte campos do manifesto do Agent Plugins 1.0.

Estrutura de plugin legada

Um diretório legado de plugin Copilot pode ser assim:

my-plugin/
├── plugin.json           # Required manifest
├── agents/               # Custom agents (optional)
│   └── helper.agent.md
├── skills/               # Skills (optional)
│   └── deploy/
│       └── SKILL.md
├── hooks.json            # Hook configuration (optional)
├── .mcp.json             # MCP server config (optional)
└── lsp.json              # LSP server config (optional)

Para obter o conjunto completo de campos que você pode incluir no manifesto, consulte referência de plugin da CLI GitHub Copilot. Para obter orientações passo a passo sobre como criar um plug-in, consulte Criando um plug-in para GitHub Copilot CLI.

Por que usar plug-ins?

Os plug-ins oferecem os seguintes benefícios:

  • Reutilização entre projetos
  • Padronização da configuração da equipe Copilot
  • Compartilhar conhecimentos de domínio (por exemplo, fornecendo as habilidades de um especialista em Rails ou um especialista em Kubernetes)
  • Encapsular configurações complexas do servidor MCP

Onde posso obter plug-ins?

Você pode instalar plug-ins de:

  • Um mercado online
  • Um repositório
  • Um caminho local

Um marketplace é um local onde os desenvolvedores podem publicar, descobrir, instalar e gerenciar plug-ins. É um pouco como uma loja de aplicativos, mas para plug-ins.

Exemplos de marketplaces incluem:

Como você instala um plug-in depende de qual cliente você está usando:

  • Em Copilot CLI, você pode instalar plug-ins de forma imperativa usando o comando copilot plugin install ou o comando de barra /plugin install, ou de forma declarativa adicionando o plug-in ao campo enabledPlugins de um arquivo ~/.copilot/settings.json no nível do usuário ou de um arquivo .github/copilot/settings.json no nível do repositório. Consulte Localizando e instalando plug-ins para GitHub Copilot CLI.
  • No Copilot cloud agent, você instala plugins declarativamente ao adicioná-los ao campo enabledPlugins do arquivo .github/copilot/settings.json do repositório. Para instalar plug-ins de um marketplace que não está registrado por padrão, você também pode adicionar o marketplace ao extraKnownMarketplaces campo no mesmo arquivo.
  • Na caixa GitHub Copilot app, clique em Personalizar e clique em Plug-ins para procurar marketplaces e instalar plug-ins.

Os administradores corporativos podem definir padrões de plug-in que se aplicam aos usuários no plano da Copilot empresa, incluindo a especificação de marketplaces e plug-ins adicionais que são instalados automaticamente. Consulte Sobre os padrões de plug-in gerenciados pela empresa.

Como funcionam os marketplaces de plug-in

Um marketplace de plug-ins é um registro de plug-ins dos quais você pode navegar e instalar. Um marketplace pode ser hospedado em um repositório no GitHub.com, em qualquer outro serviço online de hospedagem Git ou no seu sistema de arquivos local ou compartilhado.

Um marketplace é definido por um marketplace.json arquivo, que fornece metadados sobre o marketplace e lista os plug-ins que ele disponibiliza. Cada entrada na matriz do plugins marketplace descreve um plug-in, incluindo seu nome, descrição, versão e o caminho para o diretório do plug-in.

Como os plug-ins em um marketplace são versionados, os marketplaces facilitam descobrir, instalar e atualizar plug-ins, além de compartilhá-los com uma equipe. Para obter orientações passo a passo sobre como criar um marketplace, consulte Criando um marketplace de plugin para GitHub Copilot CLI.

Plug-ins comparados com a configuração manual

Qualquer funcionalidade que você possa adicionar com um plug-in, você também pode adicionar configurando Copilot manualmente, por exemplo, adicionando perfis de agente personalizados ou servidores MCP. No entanto, os plug-ins fornecem várias vantagens em relação à configuração manual:

CaracterísticaConfiguração manual em um repositórioPlug-in
ScopeRepositório únicoQualquer projeto
SharingCopiar/colar manualmenteComando de instalação ou entrada enabledPlugins
VersioningHistórico do GitVersões do Marketplace
DiscoveryPesquisando repositóriosNavegação no Marketplace

Leitura adicional