코드 인덱스 MCP

코드 인덱스 MCP는 대규모 언어 모델(LLM)이 프로젝트 디렉토리에서 코드를 인덱싱, 검색 및 분석할 수 있도록 하는 모델 컨텍스트 프로토콜 서버입니다.

특징

• 프로젝트 파일 구조 색인 및 탐색
• 코드에서 특정 패턴 검색
• 자세한 파일 요약을 받으세요
• 코드 구조 및 복잡성 분석
• 다양한 프로그래밍 언어 지원
• 프로젝트 설정의 영구 저장

설치

이 프로젝트에서는 환경 관리 및 종속성 설치에 uv를 사용합니다.

1. Python 3.10 이상이 설치되어 있는지 확인하세요.
2. uv 설치(권장):지엑스피1
3. 코드 받기:
   # Clone the repository git clone https://github.com/your-username/code-index-mcp.git

용법

서버를 직접 실행

UV는 프로젝트 구성에 따라 모든 종속성 설치를 자동으로 처리합니다.

Claude Desktop과 통합

Code Index MCP를 Claude Desktop과 쉽게 통합할 수 있습니다.

1. UV가 설치되어 있는지 확인하세요(위의 설치 섹션 참조)
2. Claude Desktop 구성 파일을 찾거나 만듭니다.
   • Windows: %APPDATA%\Claude\claude_desktop_config.json
   • macOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json
3. 다음 구성을 추가합니다(실제 경로로 바꾸세요):Windows의 경우 :
   { "mcpServers": { "code-indexer": { "command": "uv", "args": [ "--directory", "C:\\Users\\username\\path\\to\\code-index-mcp", "run", "run.py" ] } } }
   macOS/Linux의 경우 :
   { "mcpServers": { "code-indexer": { "command": "uv", "args": [ "--directory", "/home/username/path/to/code-index-mcp", "run", "run.py" ] } } }
   참고 : --directory 옵션은 uv가 올바른 프로젝트 디렉토리에서 실행되고 모든 종속성을 제대로 로드할 수 있도록 보장하므로 중요합니다.
4. 코드 인덱서를 사용하여 코드 프로젝트를 분석하려면 Claude Desktop을 다시 시작하세요.

수동 종속성 설치가 필요하지 않습니다. UV는 서버를 실행할 때 모든 종속성을 자동으로 처리합니다.

기본 워크플로

1. 프로젝트 경로 설정 (필수 첫 번째 단계):
   • 처음 사용 시 분석할 프로젝트 경로를 설정해야 합니다.
   • Claude 명령을 통해: "프로젝트를 분석하고 프로젝트 경로를 설정하는 데 도움이 필요합니다."
   • 전체 프로젝트 디렉토리 경로를 제공하세요
2. 코드 검색 :
   • 특정 키워드 또는 패턴 검색: "프로젝트에서 '함수 이름'을 검색하세요"
   • 파일 유형별 필터링: "모든 .py 파일에서 'import' 검색"
3. 파일 분석 :
   • 특정 파일 분석: "src/main.py 파일 분석"
   • 파일 요약 가져오기: "utils/helpers.js에 있는 함수 목록을 주세요"
4. 프로젝트 탐색 :
   • 프로젝트 구조 보기: "이 프로젝트의 구조를 보여주세요"
   • 특정 패턴과 일치하는 파일 찾기: "모든 test_*.py 파일 찾기"

기술적 세부 사항

영구 저장소

모든 인덱스 및 설정 데이터는 프로젝트 디렉토리 내의 .code_indexer 폴더에 저장됩니다.

• config.json : 프로젝트 구성 정보
• file_index.pickle : 파일 인덱스 데이터
• content_cache.pickle : 파일 콘텐츠 캐시

이렇게 하면 프로젝트 전체를 사용할 때마다 다시 인덱싱할 필요가 없습니다.

UV를 사용한 종속성 관리

코드 인덱스 MCP는 종속성 관리를 위해 UV를 사용하며, 이는 다음과 같은 여러 가지 이점을 제공합니다.

• 프로젝트 요구 사항에 따른 자동 종속성 해결
• 더 빠른 패키지 설치 및 환경 설정
• 잠금 파일을 통한 일관된 종속성 버전

지원되는 파일 유형

현재 인덱싱 및 분석이 지원되는 파일 유형은 다음과 같습니다.

• 파이썬(.py)
• JavaScript/TypeScript(.js, .ts, .jsx, .tsx)
• 자바(.java)
• C/C++(.c, .cpp, .h, .hpp)
• C#(.cs)
• 고(.go)
• 루비(.rb)
• PHP(.php)
• 스위프트(.swift)
• 코틀린(.kt)
• 녹(.rs)
• 스칼라(.scala)
• 셸(.sh, .bash)
• HTML/CSS(.html, .css, .scss)
• 마크다운(.md)
• JSON(.json)
• XML(.xml)
• YAML(.yml, .yaml)

보안 고려 사항

• 파일 경로 검증은 디렉토리 탐색 공격을 방지합니다.
• 절대 경로 접근은 허용되지 않습니다.
• 프로젝트 경로는 기본값 없이 명시적으로 설정해야 합니다.
• .code_indexer 폴더에는 인덱싱 데이터가 커밋되는 것을 방지하기 위한 .gitignore 파일이 포함되어 있습니다.

기여하다

새로운 기능을 추가하거나 버그를 수정하기 위한 이슈나 풀 리퀘스트를 통한 기여를 환영합니다.

중국어 설명서는 README_zh.md를 참조하세요.