@lex-tools/codebase-context-dumper

코드베이스-컨텍스트-덤퍼 MCP 서버

코드베이스 컨텍스트를 대규모 언어 모델(LLM)로 쉽게 덤프하도록 설계된 모델 컨텍스트 프로토콜(MCP) 서버입니다.

왜 이것을 사용해야 하나요?

LLM의 넓은 컨텍스트 창은 강력하지만, 방대한 코드베이스에서 파일을 수동으로 선택하고 서식을 지정하는 것은 번거롭습니다. 이 도구는 다음과 같은 방법으로 프로세스를 자동화합니다.

• 프로젝트 디렉토리를 재귀적으로 스캔합니다.
• .gitignore 규칙에 의해 제외되지 않은 지정된 디렉토리 트리의 텍스트 파일을 포함합니다.
• 자동으로 바이너리 파일을 건너뜁니다.
• 명확한 파일 경로 표시로 콘텐츠를 연결합니다.
• LLM의 컨텍스트 창보다 큰 코드베이스를 처리하기 위한 청킹 지원.
• MCP 호환 클라이언트와 완벽하게 통합됩니다.

사용법 (권장: npx)

이 도구를 사용하는 가장 쉬운 방법은 npx 사용하는 것인데, 이를 사용하면 로컬에 설치할 필요 없이 최신 버전을 실행할 수 있습니다.

다음 명령을 사용하여 MCP 클라이언트(예: Claude Desktop, VS Code 확장 프로그램)를 구성하세요.

지엑스피1

그러면 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 라이선스 2.0에 따라 라이선스가 부여됩니다. 자세한 내용은 라이선스 파일을 참조하세요.