O que to-skills faz?
Gere habilidades de agente de IA (SKILL.md) a partir de documentação de API TypeScript — Plugin TypeDoc + CLI + Docusaurus/VitePress
Visão Geral
pradeepmouli/to-skills é uma ferramenta poderosa que transforma sua documentação TypeScript (criada com TypeDoc) em um arquivo SKILL.md pronto para uso por agentes de IA como Claude Code e Codex. Em vez de escrever manualmente como um agente deve interagir com sua API, você pode gerar automaticamente descrições, exemplos e instruções diretamente dos seus comentários JSDoc.
Funcionalidades
- Plugin TypeDoc: Integra-se perfeitamente ao seu pipeline de documentação TypeScript.
- CLI: Ferramenta de linha de comando para geração rápida.
- Suporte a Docusaurus/VitePress: Funciona com frameworks de documentação populares.
- Atualização automática: Mantenha seu SKILL.md sincronizado com o código.
Instalação
npm install -g pradeepmouli/to-skills
Ou localmente no seu projeto:
npm install --save-dev pradeepmouli/to-skills
Uso
Como Plugin TypeDoc
Adicione o plugin ao seu arquivo de configuração do TypeDoc:
// tsdoc.json
{
"plugins": ["pradeepmouli/to-skills"],
"theme": "default"
}
Execute o TypeDoc normalmente e o SKILL.md será gerado na saída.
Como CLI
to-skills --input ./docs --output ./SKILL.md
Integração com Docusaurus e VitePress
Para projetos que usam Docusaurus ou VitePress, o plugin pode ser configurado para extrair informações das páginas de documentação e gerar um SKILL.md consolidado.
Exemplo
Dado o seguinte código TypeScript com JSDoc:
/**
* Soma dois números.
* @param a - Primeiro número.
* @param b - Segundo número.
* @returns A soma de a e b.
*/
export function add(a: number, b: number): number {
return a + b;
}
A ferramenta gera um SKILL.md com:
- Nome da função
- Descrição
- Parâmetros
- Tipo de retorno
- Exemplo de uso (se fornecido no JSDoc)
Licença
MIT