Pular para o conteúdo
Skillpedia
Escrita40 mil · #5076

create-agentsmd

Cria um arquivo de documentação para descrever os agentes de IA em um projeto. Isso ajuda a entender quais agentes existem e como eles funcionam.

O que ela faz

Este agente cria um arquivo chamado AGENTS.md para o seu projeto. Esse arquivo serve como um guia detalhado para outros agentes de IA, explicando como o projeto funciona, como configurá-lo, testá-lo e outras informações técnicas importantes.

Quando usar

  • ✓Quando você precisa documentar as instruções técnicas de um projeto para agentes de IA.
  • ✓Ao iniciar um novo projeto e querer fornecer um guia claro para futuras colaborações com IA.
  • ✓Para organizar e centralizar informações de desenvolvimento que são específicas para ferramentas de IA.

Exemplo do que pedir para a IA

“Crie um arquivo AGENTS.md para este projeto, incluindo informações sobre como instalar dependências, rodar o servidor de desenvolvimento e executar testes.”

Quer saber mais? Abra as seções abaixo.

Como usar

O jeito mais fácil: copie a mensagem abaixo e cole no Claude, ChatGPT, Cursor ou outra IA. Ela lê a skill e segue as instruções.

Link da skill

https://github.com/github/awesome-copilot/blob/main/skills/create-agentsmd/SKILL.md

Mensagem pronta para colar

Use esta skill para me ajudar: https://github.com/github/awesome-copilot/blob/main/skills/create-agentsmd/SKILL.md Leia o arquivo SKILL.md desse link e siga as instruções dele na minha tarefa.
Como funciona

Ele analisa as informações do seu projeto, como scripts no package.json e ferramentas usadas, para gerar um arquivo Markdown estruturado. Esse arquivo contém seções como 'Visão Geral do Projeto', 'Comandos de Configuração' e 'Fluxo de Desenvolvimento'.

Instalação

Jeito mais fácil: copie o link da skill e cole no Claude, ChatGPT ou Cursor pedindo para seguir as instruções.

No terminal (Claude Code, Codex, Cursor), na pasta do projeto:

npx skills add github/awesome-copilot --skill create-agentsmd

Ou baixe só o arquivo:

curl -L https://raw.githubusercontent.com/github/awesome-copilot/main/skills/create-agentsmd/SKILL.md -o SKILL.md
Conteúdo técnico (SKILL.md)

Tradução do texto original do autor no GitHub. Os comandos e códigos estão como no original.

Crie um arquivo AGENTS.md de alta qualidade

Você é um agente de código. Sua tarefa é criar um arquivo AGENTS.md completo e preciso na raiz deste repositório, seguindo as orientações públicas em https://agents.md/.

AGENTS.md é um formato aberto projetado para fornecer aos agentes de codificação o contexto e as instruções de que precisam para trabalhar efetivamente em um projeto.

O que é AGENTS.md?

AGENTS.md é um arquivo Markdown que serve como um "README para agentes" - um local dedicado e previsível para fornecer contexto e instruções que ajudem os agentes de codificação de IA a trabalhar em seu projeto. Ele complementa o README.md contendo contexto técnico detalhado que os agentes de codificação precisam, mas que pode poluir um README focado em humanos.

Princípios Chave

  • Focado no Agente: Contém instruções técnicas detalhadas para ferramentas automatizadas
  • Complementa o README.md: Não substitui a documentação humana, mas adiciona contexto específico para agentes
  • Localização Padronizada: Colocado na raiz do repositório (ou nas raízes de subprojetos para monorepos)
  • Formato Aberto: Usa Markdown padrão com estrutura flexível
  • Compatibilidade com Ecossistema: Funciona em mais de 20 ferramentas e agentes de codificação de IA diferentes

Estrutura do Arquivo e Diretrizes de Conteúdo

1. Configuração Necessária

  • Crie o arquivo como AGENTS.md na raiz do repositório
  • Use formatação Markdown padrão
  • Sem campos obrigatórios - estrutura flexível baseada nas necessidades do projeto

2. Seções Essenciais a Incluir

Visão Geral do Projeto

  • Breve descrição do que o projeto faz
  • Visão geral da arquitetura, se complexa
  • Principais tecnologias e frameworks utilizados

Comandos de Configuração

  • Instruções de instalação
  • Passos para configuração do ambiente
  • Comandos de gerenciamento de dependências
  • Configuração de banco de dados, se aplicável

Fluxo de Desenvolvimento

  • Como iniciar o servidor de desenvolvimento
  • Comandos de build
  • Configuração de watch/hot-reload
  • Especificidades do gerenciador de pacotes (npm, pnpm, yarn, etc.)

Instruções de Teste

  • Como executar testes (unitários, de integração, e2e)
  • Localização e convenções de nomenclatura de arquivos de teste
  • Requisitos de cobertura
  • Padrões ou frameworks de teste específicos utilizados
  • Como executar um subconjunto de testes ou focar em áreas específicas

Diretrizes de Estilo de Código

  • Convenções específicas da linguagem
  • Regras de linting e formatação
  • Padrões de organização de arquivos
  • Convenções de nomenclatura
  • Padrões de importação/exportação

Build e Implantação

  • Comandos de build e saídas
  • Configurações de ambiente
  • Passos e requisitos de implantação
  • Informações do pipeline de CI/CD

3. Seções Opcionais, mas Recomendadas

Considerações de Segurança

  • Requisitos de testes de segurança
  • Gerenciamento de segredos
  • Padrões de autenticação
  • Modelos de permissão

Instruções de Monorepo (se aplicável)

  • Como trabalhar com múltiplos pacotes
  • Dependências entre pacotes
  • Build/teste seletivo
  • Comandos específicos de pacotes

Diretrizes de Pull Request

  • Requisitos de formato do título
  • Verificações necessárias antes da submissão
  • Processo de revisão
  • Convenções de mensagens de commit

Depuração e Solução de Problemas

  • Problemas comuns e soluções
  • Padrões de logging
  • Configuração de depuração
  • Considerações de desempenho

Exemplo de Template

Use este como um template inicial e personalize com base no projeto específico:

# AGENTS.md

## Project Overview

[Brief description of the project, its purpose, and key technologies]

## Setup Commands

- Install dependencies: `[package manager] install`
- Start development server: `[command]`
- Build for production: `[command]`

## Development Workflow

- [Development server startup instructions]
- [Hot reload/watch mode information]
- [Environment variable setup]

## Testing Instructions

- Run all tests: `[command]`
- Run unit tests: `[command]`
- Run integration tests: `[command]`
- Test coverage: `[command]`
- [Specific testing patterns or requirements]

## Code Style

- [Language and framework conventions]
- [Linting rules and commands]
- [Formatting requirements]
- [File organization patterns]

## Build and Deployment

- [Build process details]
- [Output directories]
- [Environment-specific builds]
- [Deployment commands]

## Pull Request Guidelines

- Title format: [component] Brief description
- Required checks: `[lint command]`, `[test command]`
- [Review requirements]

## Additional Notes

- [Any project-specific context]
- [Common gotchas or troubleshooting tips]
- [Performance considerations]

Exemplo de Trabalho do agents.md

Aqui está um exemplo real do site agents.md:

# Arquivo AGENTS.md de Amostra

## Dicas de ambiente de desenvolvimento


…
Perguntas frequentes

O que é um arquivo AGENTS.md?

É um arquivo de documentação no formato Markdown que contém instruções técnicas detalhadas para agentes de IA trabalharem em um projeto. Pense nele como um 'manual do proprietário' para robôs programadores.

Por que usar um AGENTS.md em vez de um README.md normal?

O README.md é geralmente para humanos. O AGENTS.md é focado em fornecer detalhes técnicos específicos que os agentes de IA precisam para entender e modificar o código, sem poluir a documentação para pessoas.

Preciso preencher todas as seções sugeridas?

Não, você pode adaptar o arquivo às necessidades do seu projeto. O importante é incluir as informações essenciais para que os agentes de IA possam trabalhar de forma eficaz.

Detalhes

Descrição original do autor

Prompt for generating an AGENTS.md file for a repository

repo: github/awesome-copilot

Popularidade

Estrelas no GitHub
40 mil
Posição no ranking
#5076
Licença
MIT
Atualizada em
15/10/2026

Essa skill é útil?

0

Entre para votar.

Comentários

  • …

Mais skills deste repositório

Skills parecidas