@lex-tools/codebase-context-dumper

Codebase-Kontext-Dumper MCP-Server

Ein Model Context Protocol (MCP)-Server, der dafür konzipiert ist, Ihren Codebase-Kontext einfach in Large Language Models (LLMs) zu übertragen.

Warum dies verwenden?

Große Kontextfenster in LLMs sind zwar leistungsstark, aber das manuelle Auswählen und Formatieren von Dateien aus einer großen Codebasis ist mühsam. Dieses Tool automatisiert den Prozess durch:

• Rekursives Scannen Ihres Projektverzeichnisses.
• Einschließlich Textdateien aus dem angegebenen Verzeichnisbaum, die nicht durch .gitignore -Regeln ausgeschlossen sind.
• Binärdateien werden automatisch übersprungen.
• Verketten des Inhalts mit eindeutigen Dateipfadmarkierungen.
• Unterstützt Chunking zur Verarbeitung von Codebasen, die größer sind als das Kontextfenster des LLM.
• Nahtlose Integration mit MCP-kompatiblen Clients.

Verwendung (Empfohlen: npx)

Am einfachsten lässt sich dieses Tool über npx verwenden, da hier die neueste Version ohne lokale Installation ausgeführt wird.

Konfigurieren Sie Ihren MCP-Client (z. B. Claude Desktop, VS Code-Erweiterungen) für die Verwendung des folgenden Befehls:

Der MCP-Client kann dann das von diesem Server bereitgestellte Tool dump_codebase_context aufrufen.

Funktionen und Tooldetails

Werkzeug: dump_codebase_context

Liest rekursiv Textdateien aus einem angegebenen Verzeichnis, beachtet dabei .gitignore -Regeln und überspringt Binärdateien. Verkettet Inhalte mit Dateipfad-Headern/-Footern. Unterstützt die Aufteilung der Ausgabe in große Codebasen.

Funktionalität :

• Durchsucht das im base_path angegebene Verzeichnis.
• Respektiert .gitignore -Dateien auf allen Ebenen (einschließlich verschachtelter Dateien und standardmäßig .git ).
• Erkennt und überspringt Binärdateien.
• Liest den Inhalt jeder gültigen Textdatei.
• Fügt dem Inhalt jeder Datei eine Kopfzeile ( --- START: relative/path/to/file --- ) voran und eine Fußzeile ( --- END: relative/path/to/file --- ) an.
• Verkettet alle verarbeiteten Dateiinhalte zu einer einzigen Zeichenfolge.

Eingabeparameter :

• base_path (Zeichenfolge, erforderlich): Der absolute Pfad zum zu scannenden Projektverzeichnis.
• num_chunks (Ganzzahl, optional, Standard: 1): Die Gesamtzahl der Chunks, in die die Ausgabe aufgeteilt werden soll. Muss >= 1 sein.
• chunk_index (Ganzzahl, optional, Standard: 1): Der 1-basierte Index des zurückzugebenden Chunks. Erfordert num_chunks > 1 und chunk_index <= num_chunks .

Ausgabe : Gibt den verketteten (und möglicherweise in Blöcke unterteilten) Textinhalt zurück.

Lokale Installation und Nutzung (Erweitert)

Wenn Sie lieber eine lokale Version ausführen möchten (z. B. für die Entwicklung):

1. Klonen Sie das Repository:
   git clone git@github.com:lex-tools/codebase-context-dumper.git cd codebase-context-dumper
2. Installieren Sie Abhängigkeiten:
   npm install
3. Erstellen Sie den Server:
   npm run build
4. Konfigurieren Sie Ihren MCP-Client so, dass er auf die lokale Build-Ausgabe verweist:
   { "mcpServers": { "codebase-context-dumper": { "command": "/path/to/your/local/codebase-context-dumper/build/index.js" // Adjust path } } }

Beitragen

Beiträge sind willkommen! Weitere Informationen zur Entwicklung, Fehlerbehebung und Veröffentlichung neuer Versionen finden Sie in CONTRIBUTING.md .

Lizenz

Dieses Projekt ist unter der Apache-Lizenz 2.0 lizenziert. Weitere Informationen finden Sie in der Datei LICENSE .