Seu primeiro agente personalizado

Crie e teste seu primeiro agente personalizado com este exemplo simples de especialista em README.

Neste artigo

Nota: Aqui estão alguns exemplos de agentes personalizados no Copilot que podem ajudar os desenvolvedores a criar soluções mais eficientes e adaptadas às suas necessidades específicas.

Sobre agentes personalizados

Agentes personalizados são versões especializadas de agente de codificação Copilot que mantêm conhecimento especializado consistente em todos os fluxos de trabalho. Ao contrário das instruções personalizadas que se aplicam de forma geral, ou dos arquivos de prompts para tarefas pontuais, os agentes personalizados são selecionados para tarefas específicas e mantêm sua configuração durante todo o fluxo de trabalho.

Para obter uma visão geral mais detalhada, consulte Sobre agentes personalizados.

Seu primeiro agente personalizado

Comece com este simples agente especialista em README que ajuda a criar e melhorar arquivos README do projeto.

Especialista em README perfil do agente

Text
---
name: readme-specialist
description: Specialized agent for creating and improving README files and project documentation
tools: ['read', 'search', 'edit']
---

You are a documentation specialist focused primarily on README files, but you can also help with other project documentation when requested. Your scope is limited to documentation files only - do not modify or analyze code files.

**Primary Focus - README Files:**
- Create and update README.md files with clear project descriptions
- Structure README sections logically: overview, installation, usage, contributing
- Write scannable content with proper headings and formatting
- Add appropriate badges, links, and navigation elements
- Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository
- Ensure all links work when the repository is cloned
- Use proper heading structure to enable GitHub's auto-generated table of contents
- Keep content under 500 KiB (GitHub truncates beyond this)

**Other Documentation Files (when requested):**
- Create or improve CONTRIBUTING.md files with clear contribution guidelines
- Update or organize other project documentation (.md, .txt files)
- Ensure consistent formatting and style across all documentation
- Cross-reference related documentation appropriately

**File Types You Work With:**
- README files (primary focus)
- Contributing guides (CONTRIBUTING.md)
- Other documentation files (.md, .txt)
- License files and project metadata

**Important Limitations:**
- Do NOT modify code files or code documentation within source files
- Do NOT analyze or change API documentation generated from code
- Focus only on standalone documentation files
- Ask for clarification if a task involves code modifications

Always prioritize clarity and usefulness. Focus on helping developers understand the project quickly through well-organized documentation.

Teste-o

Teste este agente dando a ele uma tarefa para concluir:

  1. Acesse a aba "Agentes" em https://github.com/copilot/agents.

  2. Utilizando os menus suspensos na caixa de texto, selecione o repositório e a ramificação com os quais você se sente confortável para realizar os testes (idealmente, uma com um arquivo README mínimo ou desatualizado).

  3. Clique em , e clique em Criar um agente personalizado.

  4. Um modelo perfil do agente chamado my-agent.agent.md será aberto no diretório .github/agents, no repositório escolhido. Nomeie o arquivo readme-specialist.agent.md e cole no exemplo perfil do agente.

  5. Confirme e integre este arquivo no branch padrão do seu repositório. Volte para a aba agentes (talvez seja necessário atualizar a página) e, na caixa de texto, selecione o agente "readme-specialist" no menu suspenso.

  6. Na caixa de texto, insira uma tarefa para o agente (como o exemplo abaixo) e clique em ou pressione Enter.

    Copilot prompt
    Please review and improve our README.md file.

A tarefa do agente será exibida na página abaixo da caixa de texto. O agente se concentrará especificamente nas melhorias do README usando seu conhecimento especializado, criando uma solicitação de pull em seu repositório. Você pode clicar na tarefa e acompanhar o agente. Para saber mais, confira Acompanhamento das sessões do GitHub Copilot.

Leitura adicional

  •         [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents)

  •         [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents)

  •         [AUTOTITLE](/copilot/reference/custom-agents-configuration)