@lex-tools/codebase-context-dumper

codebase-context-dumper Сервер MCP

Сервер протокола контекста модели (MCP), предназначенный для простого переноса контекста вашей кодовой базы в большие языковые модели (LLM).

Зачем это использовать?

Большие контекстные окна в LLMs — это мощно, но ручной выбор и форматирование файлов из большой кодовой базы — утомительно. Этот инструмент автоматизирует процесс следующим образом:

• Рекурсивное сканирование каталога вашего проекта.
• Включение текстовых файлов из указанного дерева каталогов, которые не исключены правилами .gitignore .
• Автоматический пропуск двоичных файлов.
• Объединение содержимого с четкими маркерами пути к файлу.
• Поддержка фрагментации для обработки кодовых баз, размер которых превышает окно контекста LLM.
• Полная интеграция с MCP-совместимыми клиентами.

Использование (рекомендуется: npx)

Самый простой способ использовать этот инструмент — через npx , который запускает последнюю версию без необходимости локальной установки.

Настройте свой клиент MCP (например, Claude Desktop, расширения VS Code) для использования следующей команды:

После этого клиент MCP сможет вызвать инструмент dump_codebase_context , предоставляемый этим сервером.

Характеристики и сведения об инструментах

Инструмент: dump_codebase_context

Рекурсивно считывает текстовые файлы из указанного каталога, соблюдая правила .gitignore и пропуская двоичные файлы. Объединяет содержимое с заголовками/нижними колонтитулами пути к файлу. Поддерживает разбиение вывода на фрагменты для больших кодовых баз.

Функциональность :

• Сканирует каталог, указанный в base_path .
• Учитывает файлы .gitignore на всех уровнях (включая вложенные и .git по умолчанию).
• Обнаруживает и пропускает двоичные файлы.
• Считывает содержимое каждого допустимого текстового файла.
• Добавляет заголовок ( --- START: relative/path/to/file --- ) и нижний колонтитул ( --- END: relative/path/to/file --- ) к содержимому каждого файла.
• Объединяет все обработанное содержимое файла в одну строку.

Входные параметры :

• base_path (строка, обязательно): абсолютный путь к каталогу проекта для сканирования.
• num_chunks (целое число, необязательно, по умолчанию: 1): Общее количество фрагментов, на которые нужно разделить вывод. Должно быть >= 1.
• chunk_index (целое число, необязательно, по умолчанию: 1): Индекс возвращаемого фрагмента, начинающийся с 1. Требует num_chunks > 1 и chunk_index <= num_chunks .

Вывод : возвращает объединенное (и потенциально разбитое на фрагменты) текстовое содержимое.

Локальная установка и использование (расширенная)

Если вы предпочитаете запустить локальную версию (например, для разработки):

1. Клонируйте репозиторий:
   git clone git@github.com:lex-tools/codebase-context-dumper.git cd codebase-context-dumper
2. Установить зависимости:
   npm install
3. Сборка сервера:
   npm run build
4. Настройте клиент MCP так, чтобы он указывал на локальный вывод сборки:
   { "mcpServers": { "codebase-context-dumper": { "command": "/path/to/your/local/codebase-context-dumper/build/index.js" // Adjust path } } }

Внося вклад

Вклады приветствуются! Подробности о разработке, отладке и выпуске новых версий см. на сайте CONTRIBUTING.md.

Лицензия

Этот проект лицензирован по Apache License 2.0. Подробности смотрите в файле LICENSE .