@lex-tools/codebase-context-dumper

Servidor MCP de volcador de contexto de código base

Un servidor de Protocolo de Contexto de Modelo (MCP) diseñado para volcar fácilmente el contexto de su base de código en Modelos de Lenguaje Grandes (LLM).

¿Por qué usar esto?

Las ventanas de contexto grandes en los LLM son potentes, pero seleccionar y formatear manualmente archivos de una base de código extensa resulta tedioso. Esta herramienta automatiza el proceso mediante:

• Escaneando recursivamente el directorio de su proyecto.
• Incluye archivos de texto del árbol de directorios especificado que no estén excluidos por las reglas .gitignore .
• Omitir automáticamente archivos binarios.
• Concatenar el contenido con marcadores de ruta de archivo claros.
• Admite fragmentación para gestionar bases de código más grandes que la ventana de contexto de LLM.
• Integración perfecta con clientes compatibles con MCP.

Uso (recomendado: npx)

La forma más sencilla de utilizar esta herramienta es a través de npx , que ejecuta la última versión sin necesidad de una instalación local.

Configure su cliente MCP (por ejemplo, Claude Desktop, extensiones de VS Code) para usar el siguiente comando:

El cliente MCP podrá entonces invocar la herramienta dump_codebase_context proporcionada por este servidor.

Características y detalles de la herramienta

Herramienta: dump_codebase_context

Lee recursivamente archivos de texto de un directorio específico, respetando las reglas de .gitignore y omitiendo archivos binarios. Concatena el contenido con los encabezados y pies de página de las rutas de archivo. Permite fragmentar la salida para bases de código extensas.

Funcionalidad :

• Escanea el directorio proporcionado en base_path .
• Respeta los archivos .gitignore en todos los niveles (incluidos los anidados y .git por defecto).
• Detecta y omite archivos binarios.
• Lee el contenido de cada archivo de texto válido.
• Antepone un encabezado ( --- START: relative/path/to/file --- ) y añade un pie de página ( --- END: relative/path/to/file --- ) al contenido de cada archivo.
• Concatena todo el contenido del archivo procesado en una sola cadena.

Parámetros de entrada :

• base_path (cadena, obligatoria): la ruta absoluta al directorio del proyecto a escanear.
• num_chunks (entero, opcional, valor predeterminado: 1): El número total de fragmentos en los que se dividirá la salida. Debe ser >= 1.
• chunk_index (entero, opcional, valor predeterminado: 1): El índice basado en 1 del fragmento que se va a devolver. Requiere que num_chunks > 1 y chunk_index <= num_chunks .

Salida : Devuelve el contenido de texto concatenado (y potencialmente fragmentado).

Instalación y uso local (avanzado)

Si prefiere ejecutar una versión local (por ejemplo, para desarrollo):

1. Clonar el repositorio:
   git clone git@github.com:lex-tools/codebase-context-dumper.git cd codebase-context-dumper
2. Instalar dependencias:
   npm install
3. Construir el servidor:
   npm run build
4. Configure su cliente MCP para que apunte a la salida de compilación local:
   { "mcpServers": { "codebase-context-dumper": { "command": "/path/to/your/local/codebase-context-dumper/build/index.js" // Adjust path } } }

Contribuyendo

¡Agradecemos sus contribuciones! Consulte CONTRIBUTING.md para obtener más información sobre el desarrollo, la depuración y el lanzamiento de nuevas versiones.

Licencia

Este proyecto está licenciado bajo la Licencia Apache 2.0. Consulte el archivo de LICENCIA para más detalles.