Repomix
Empacota repositórios de código em um único arquivo compatível com IA usando a ferramenta repomix.
Documentação
Servidor MCP Repomix
Um servidor Model Context Protocol (MCP) que fornece acesso à ferramenta repomix para empacotar repositórios em arquivos amigáveis para IA.
Segurança
- Caminhos de entrada: O servidor restringe o acesso a arquivos ao diretório a partir do qual foi iniciado. Qualquer tentativa de acessar arquivos fora deste diretório (como
/etc/) será negada. - Arquivos de saída: Toda a saída é gravada no diretório temporário do sistema e limpa automaticamente após o conteúdo ser retornado.
- URLs remotas: URLs de repositórios remotos ainda são permitidas para processamento.
Instalação
npm install
npm run build
Uso
Claude Code
claude mcp add --scope user repomix node /path/to/repomix-mcp/dist/index.js
Claude Desktop
Adicione este servidor à configuração do seu cliente MCP no seu claude_desktop_config.json:
{
"mcpServers": {
"repomix": {
"command": "node",
"args": ["/path/to/repomix-mcp/dist/index.js"]
}
}
}
Ferramentas Disponíveis
Ambas as ferramentas aceitam os mesmos parâmetros:
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição | Exemplos |
|---|---|---|---|---|
path | string | Não | Caminho do diretório para empacotar | /path/to/repo |
style | enum | Não | Estilo de formato de saída | xml, markdown, plain |
compress | boolean | Não | Comprimir a saída para reduzir a contagem de tokens | true, false |
include | string | Não | Arquivos a incluir (padrão glob) | *.md,*.ts,*.js, *.py, src/**/*.go |
ignore | string | Não | Arquivos a excluir (padrão glob) | *test*,*spec*,dist/**,build/** |
remote | string | Não | URL do repositório remoto para processar | https://github.com/user/repo |
repomix-estimate
Estime o tamanho da saída do repomix sem recuperar o conteúdo. Use isso primeiro para verificar se a saída caberá na sua janela de contexto.
Retorna:
- Tamanho do arquivo em KB/MB
- Contagem estimada de tokens (~4 caracteres por token)
- Se a compactação está habilitada
Saída do repomix-estimate
Repomix output size estimate:
- Size: 5.27 KB (0.01 MB)
- Estimated tokens: ~1,349
- Compression: disabled
Use the repomix tool with these same parameters to retrieve the actual content.
repomix
Empacota um repositório em um único arquivo amigável para IA. Retorna o conteúdo do arquivo gerado.
Melhor prática: Sempre use repomix-estimate primeiro para verificar o tamanho da saída, depois use repomix com parâmetros apropriados (especialmente compress=true para repositórios grandes).
Exemplo de uso no Claude:
- Primeiro verifique o tamanho:
use repomix-estimate tool - Se o tamanho for razoável:
use repomix tool - Se for muito grande, tente com compactação:
use repomix-estimate tool with compress=true - Em seguida, recupere:
use repomix tool with compress=true
Fluxo de trabalho: Sempre estime primeiro, depois recupere apenas se o tamanho atender às suas necessidades.
Saída do repomix (primeiras 15 linhas)
This file is a merged representation of a subset of the codebase, containing specifically included files, combined into a single document by Repomix.
<file_summary>
This section contains a summary of this file.
<purpose>
This file contains a packed representation of the entire repository's contents.
It is designed to be easily consumable by AI systems for analysis, code review,
or other automated processes.
</purpose>
<file_format>
The content is organized as follows:
1. This summary section
2. Repository information