Escolher idioma

Validador de SKILL.md para Agent Skills

Valide a especificação Agent Skills, confira o frontmatter YAML e analise tokens e avisos de compatibilidade com Claude Code no navegador.

Validador de SKILL.mdComo funciona ↓
Processado no navegador. Nenhum dado é enviado para a nuvem.
A especificação exige que name seja idêntico ao nome da pasta do arquivo

Valida a especificação Agent Skills (agentskills.io), recomendações de tamanho e campos específicos do Claude Code. Não avalia a qualidade das instruções.

Mehmet Demiray Publicado Atualizado
Compartilhar

O que é o arquivo SKILL.md no ecossistema de agentes

O formato Agent Skills define uma estrutura padrão para estender as capacidades de agentes autônomos e assistentes como o Claude Code. No centro dessa arquitetura está o arquivo SKILL.md, localizado na raiz da pasta da respectiva habilidade. Esse documento combina um cabeçalho em formato YAML frontmatter no topo e instruções detalhadas em Markdown no corpo do texto.

Quando um agente inicia uma sessão de trabalho, ele não carrega o conteúdo completo de todas as habilidades disponíveis de uma só vez. Em vez disso, o sistema lê apenas os metadados do frontmatter, especificamente o nome e a descrição da habilidade. Com base nessas informações resumidas, o modelo decide se determinada ferramenta é adequada para a tarefa solicitada pelo usuário. O corpo completo do arquivo só é injetado na janela de contexto quando a habilidade é explicitamente acionada.

Essa abordagem em duas etapas economiza tokens e mantém a execução ágil. Caso a sintaxe do frontmatter contenha falhas, o agente não consegue interpretar a habilidade, ignorando sua existência em silêncio. O Validador de SKILL.md permite verificar a integridade estrutural desse arquivo antes da publicação, garantindo que o agente consiga identificar e carregar as instruções sem interrupções.

Regras e limites do frontmatter YAML

O cabeçalho YAML precisa estar posicionado no início absoluto do arquivo, delimitado por três hífens de abertura e três de fechamento. A especificação oficial estabelece restrições estritas para cada campo aceito no frontmatter.

Campo Obrigatório Limite de tamanho Regras de formato
name Sim 64 caracteres Apenas letras minúsculas, números e hífens simples
description Sim 1.024 caracteres Texto claro explicando o que faz e quando usar
compatibility Não 500 caracteres Requisitos de ambiente ou ferramentas externas
license Não Sem limite explícito Nome da licença de código aberto ou proprietária
metadata Não Estrutura aninhada Chaves personalizadas não previstas na especificação
allowed-tools Não Variável Ferramentas permitidas separadas por espaço

O nome definido no campo name precisa coincidir exatamente com o nome da pasta onde o SKILL.md está salvo. Nomes com letras maiúsculas, sublinhados, acentos ou espaços resultam em erro imediato. Erros comuns de sintaxe YAML, como dois-pontos sem aspas em valores de texto ou uso de tabulações em vez de espaços na indentação, impedem a leitura. Se precisar converter configurações estruturadas entre formatos para seus testes, você pode recorrer a um conversor de YAML para JSON ou a um conversor de JSON para YAML.

Como criar uma descrição que ativa o agente com precisão

A causa mais frequente de uma habilidade nunca ser executada pelo agente não é um erro de código, mas sim uma descrição vaga no frontmatter. Como o modelo consulta apenas o campo description para decidir qual ferramenta selecionar, esse texto funciona como o gatilho de ativação da habilidade.

Uma descrição eficiente deve responder a duas perguntas centrais: o que a ferramenta faz e em quais circunstâncias exatas ela deve ser utilizada. A especificação recomenda incluir termos explícitos como "use when", "useful for" ou expressões contextuais diretas em português ou inglês, dependendo do idioma padrão de suas interações.

O Validador de SKILL.md emite um aviso quando a descrição contém menos de 60 caracteres, pois textos excessivamente curtos raramente fornecem o contexto semântico necessário para o modelo de linguagem.

Exemplo fraco: description: Executa testes no projeto.

Exemplo recomendado: description: Executa a suíte de testes unitários e de integração com pytest. Use when the user asks to run tests, check test coverage, or validate changes before committing code.

A descrição recomendada especifica a ferramenta subjacente e orienta o raciocínio do modelo sobre os momentos exatos em que a ativação é pertinente.

Orçamento de contexto e organização do corpo em Markdown

Após o fechamento do frontmatter, o corpo do SKILL.md contém as instruções operacionais que o agente deve seguir. Para evitar o consumo excessivo da janela de contexto, a especificação sugere manter o corpo do documento abaixo de 500 linhas, o que equivale a um teto estimado em torno de 5.000 tokens.

A estimativa básica utiliza a proporção de 4 caracteres por token para textos em alfabeto latino. Em idiomas com outros alfabetos, a contagem real de tokens costuma ser maior. Manter o texto conciso e direto reduz custos de inferência e evita que o modelo perca o foco em instruções complexas.

Boas práticas de estruturação do corpo:

  1. Utilize títulos bem delimitados em Markdown para permitir que o modelo localize rapidamente as etapas relevantes da tarefa.
  2. Evite textos temporários como marcadores de tarefas pendentes ou termos fictícios de preenchimento.
  3. Quando o procedimento exigir documentação volumosa, manuais extensos ou esquemas de banco de dados, armazene esses dados em arquivos complementares dentro de uma pasta references/.
  4. Mantenha os links para arquivos de apoio sempre relativos e com profundidade de apenas um nível, como references/guia.md, evitando caminhos absolutos no sistema de arquivos.

O corpo não deve conter menos de 20 palavras, garantindo que o agente receba orientações suficientes para executar o trabalho planejado.

Campos padrão da especificação versus extensões do Claude Code

Ao escrever habilidades para agentes de inteligência artificial, é fundamental compreender a diferença entre os campos universais da especificação Agent Skills e os campos estendidos suportados por ferramentas específicas, como o Claude Code.

A especificação oficial padroniza campos centrais como name, description, license, compatibility, metadata e o experimental allowed-tools. O campo allowed-tools deve ser fornecido como uma string de texto com itens separados por espaço, e não como uma lista YAML com hífens.

Por outro lado, extensões específicas do Claude Code, tais como model, hooks ou chaves de controle de execução em nível de sistema, são válidas apenas nesse ambiente particular. Outros agentes e plataformas compatíveis com o padrão Agent Skills ignoram essas propriedades sem interromper a execução.

Para garantir a máxima portabilidade entre diferentes plataformas e ferramentas de automação, quaisquer chaves customizadas que não pertençam à especificação padrão devem ser agrupadas sob a chave estruturada metadata. Caso você construa agentes personalizados que acessem serviços externos via webhooks ou APIs seguras, lembre-se de configurar a autenticação por meio de chaves dedicadas com um gerador de chave de autenticação para bots web.

Como interpretar o relatório do Validador de SKILL.md

O relatório gerado pelo Validador de SKILL.md categoriza as constatações em três níveis distintos de gravidade: erros, avisos e notas.

  • Erros: indicam violações diretas da especificação formal. Incluem cabeçalho YAML ausente ou malformatado, nomes com caracteres proibidos ou superiores a 64 caracteres, descrições ausentes ou que ultrapassam 1.024 caracteres, e corpo do documento vazio. O arquivo só é considerado válido quando o total de erros for zero.
  • Avisos: apontam desvios das diretrizes recomendadas de boas práticas. Exemplos comuns são descrições com menos de 60 caracteres, corpo com mais de 500 linhas ou cerca de 5.000 tokens, presença de termos como tarefas pendentes ou links para caminhos aninhados demais.
  • Notas: fornecem observações informativas sobre compatibilidade, como a presença de chaves exclusivas do Claude Code ou a ausência de gatilhos textuais de ativação na descrição.

O processamento do Validador de SKILL.md ocorre de forma totalmente local no seu navegador web. Nenhum código, roteiro interno de projeto ou instrução é enviado a servidores remotos. A ferramenta avalia a sintaxe e a conformidade com as regras formais, mas não valida a existência física de arquivos vinculados em disco nem avalia a qualidade subjetiva do raciocínio contido nas instruções.

As que mais respondemos.

Como validar um arquivo SKILL.md com esta ferramenta?

Cole o conteúdo completo do seu arquivo SKILL.md no editor e informe opcionalmente o nome da pasta do skill. O Validador de SKILL.md analisa o frontmatter YAML e o corpo das instruções instantaneamente no seu navegador, exibindo erros de especificação, avisos e notas sem enviar dados para servidores externos.

Quais campos são obrigatórios no frontmatter do SKILL.md?

A especificação do Agent Skills exige apenas dois campos no cabeçalho YAML: name e description. O campo name aceita até 64 caracteres, restrito a letras minúsculas, números e hífens simples. O campo description permite até 1.024 caracteres. Campos como compatibility e license são opcionais.

Por que o agente de inteligência artificial não carrega ou ignora meu skill?

O motivo mais comum é uma descrição vaga ou curta demais. Os agentes utilizam o campo description para decidir quando acionar as instruções. Se a descrição tiver menos de 60 caracteres ou não explicar o momento exato de uso, o modelo dificilmente selecionará o skill. Falhas na sintaxe YAML também impedem o reconhecimento. Para conferir estruturas de dados complexas, você pode usar o conversor de YAML para JSON.

Meu arquivo usa campos como model ou hooks; isso é considerado um erro?

Não, o validador classifica esses campos como notas informativas. Propriedades como model e hooks são extensões específicas do Claude Code e funcionam normalmente nesse ambiente, embora sejam ignoradas por outros agentes que seguem estritamente a especificação padrão do Agent Skills.

Um arquivo com avisos ainda é considerado válido?

Sim, um arquivo é considerado válido quando não apresenta nenhum erro impeditivo. Avisos indicam desvios das boas práticas recomendadas, como descrições muito curtas, textos com mais de 500 linhas ou marcações temporárias de texto. O skill funcionará na maioria dos agentes, mas aplicar as melhorias garante maior compatibilidade.

O que significa o erro de YAML inválido no cabeçalho?

Esse erro ocorre quando o bloco superior contém falhas de formatação, como tabulações no lugar de espaços, dois-pontos sem aspas no texto ou recuo incorreto de itens. O Validador de SKILL.md aponta a linha exata da ocorrência. Caso monte suas configurações a partir de outros formatos, o conversor de JSON para YAML auxilia na estruturação correta do código.

O conteúdo do meu skill é enviado para algum servidor?

Não, toda a validação do Validador de SKILL.md é executada localmente no seu próprio navegador web. Nenhum trecho de código, instrução interna ou fluxo de trabalho inserido no campo de texto é transmitido, salvo ou compartilhado.

Como é calculado o limite estimado de tokens do skill?

O cálculo adota uma estimativa de quatro caracteres por token, sugerindo um limite de referência próximo de 5.000 tokens para evitar sobrecarga no contexto do modelo. A contagem real pode variar conforme o tokenizador de cada arquitetura de inteligência artificial.