GitMCP 프로젝트 상세 소개

🚀 프로젝트 개요

GitMCP는 무료 오픈소스 원격 모델 컨텍스트 프로토콜(MCP) 서버로, 모든 GitHub 프로젝트(저장소 또는 GitHub Pages)를 문서 허브로 변환할 수 있습니다. 이를 통해 Cursor와 같은 AI 도구는 LLM이 이전에 접하지 못한 내용이라도 최신 문서와 코드에 접근할 수 있어 코드 환각 현상을 원활하게 제거합니다.

핵심 기능

• 😎 모든 GitHub 프로젝트의 최신 문서: AI 어시스턴트에게 GitHub 프로젝트 문서 및 코드에 대한 원활한 접근을 제공하며, AI가 필요로 하는 정확한 내용을 찾도록 돕는 스마트 검색 기능이 내장되어 있습니다.
• 🧠 환각 제거: GitMCP를 사용하면 AI 어시스턴트가 정확하고 관련성 높은 답변을 제공할 수 있습니다.
• ☁️ 제로 구성: GitMCP는 클라우드에서 실행되므로, IDE에 GitMCP URL을 MCP 서버로 추가하기만 하면 됩니다.
• 💬 임베디드 채팅: 브라우저 내 채팅을 통해 저장소 문서와 직접 대화할 수 있습니다.
• ✅ 개방형, 무료 및 비공개: 완전한 오픈소스로 무료로 사용할 수 있으며, 개인 정보를 수집하거나 쿼리를 저장하지 않으며 자체 호스팅을 지원합니다.

🛠️ 작동 방식

GitMCP는 AI 어시스턴트와 GitHub 저장소를 연결하기 위해 모델 컨텍스트 프로토콜(MCP) 표준을 사용하며, 이 표준은 AI 도구가 외부 소스에서 추가 정보를 요청할 수 있도록 합니다.

워크플로우:

1. AI 어시스턴트에게 GitMCP URL을 제공합니다 (예: gitmcp.io/microsoft/typescript).
2. GitMCP는 문서 가져오기, 스마트 검색, 코드 검색 등의 도구를 노출합니다.
3. AI 어시스턴트에게 문서/코드 관련 질문을 합니다.
4. AI 어시스턴트가 GitMCP에 도구 사용 요청을 보냅니다 (사용자 승인 필요).
5. GitMCP는 AI의 요청을 실행하고 필요한 데이터를 반환합니다.
6. AI 어시스턴트는 정보를 수신하고 환각 없이 더 정확하고 근거 있는 응답을 생성합니다.

📋 지원되는 문서 형식

GitMCP는 현재 다음 문서를 우선순위에 따라 지원합니다:

1. llms.txt - AI에 최적화된 프로젝트 문서 버전
2. README.md
3. /root 디렉토리의 기타 문서

🔧 구성 방법

URL 형식 선택

연결하려는 내용에 따라 다음 URL 형식 중 하나를 선택하십시오:

• GitHub 저장소: gitmcp.io/{owner}/{repo}
• GitHub Pages 웹사이트: {owner}.gitmcp.io/{repo}
• 범용 도구 (모든 저장소 지원, 동적): gitmcp.io/docs

AI 도구 구성 예시

Cursor 구성

~/.cursor/mcp.json 파일을 업데이트합니다:

{
  "mcpServers": {
    "gitmcp": {
      "url": "https://gitmcp.io/{owner}/{repo}"
    }
  }
}

Claude Desktop 구성

설정 > 개발자 > 구성 편집에서 구성을 대체합니다:

{
  "mcpServers": {
    "gitmcp": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://gitmcp.io/{owner}/{repo}"
      ]
    }
  }
}

Windsurf 구성

~/.codeium/windsurf/mcp_config.json 파일을 업데이트합니다:

{
  "mcpServers": {
    "gitmcp": {
      "serverUrl": "https://gitmcp.io/{owner}/{repo}"
    }
  }
}

🔨 사용 가능한 도구

1. 문서 가져오기 (fetch_documentation)

GitHub 저장소에서 주요 문서를 가져와 관련 문서(예: llms.txt)를 검색하여 AI에 프로젝트 개요를 제공합니다.

적용 시나리오: 프로젝트 목적, 기능 또는 시작 가이드에 대한 일반적인 질문

2. 문서 검색 (search_documentation)

AI가 특정 검색 쿼리를 통해 저장소 문서에서 검색하도록 하며, 모든 문서를 로드하는 대신 스마트 검색을 사용하여 관련 부분을 찾습니다.

적용 시나리오: 프로젝트 내 특정 기능, 함수 또는 개념에 대한 구체적인 질문

3. 링크 내용 가져오기 (fetch_link_content)

AI가 문서에 언급된 링크에서 정보를 가져오도록 돕고, 해당 링크의 내용을 검색하여 AI가 읽기 쉬운 형식으로 변환합니다.

적용 시나리오: 문서가 질문 답변에 도움이 되는 외부 정보를 참조할 때

4. 코드 검색 (search_code)

GitHub의 코드 검색 기능을 사용하여 저장소의 실제 코드에서 검색하며, AI가 특정 코드 예시 또는 구현 세부 정보를 찾도록 돕습니다.

적용 시나리오: 구현 예시 또는 문서에 포함되지 않은 기술 세부 정보가 필요할 때

📊 뱃지 통합

GitMCP는 사용자가 IDE 또는 브라우저를 통해 문서에 빠르게 접근할 수 있도록 저장소 뱃지를 제공하며, GitMCP를 통해 문서에 접근한 횟수를 표시합니다.

뱃지 추가

README.md에 다음 코드를 추가합니다:

[![GitMCP](https://img.shields.io/endpoint?url=https://gitmcp.io/badge/OWNER/REPO)](https://gitmcp.io/OWNER/REPO)

뱃지 사용자 정의 매개변수

매개변수	설명	기본값	예시
color	뱃지 값의 색상	aquamarine	?color=green
label	뱃지 라벨	GitMCP	Documentation

🛡️ 개인 정보 보호 및 보안

• 개인 정보 보호 약속: GitMCP는 사용자 개인 정보를 깊이 중요하게 생각하며, 인증이 필요 없고 어떠한 개인 식별 정보도 접근하거나 저장하지 않습니다.
• 쿼리 미저장: 프록시가 전송하는 어떠한 쿼리도 저장하지 않습니다.
• 오픈소스 투명성: 오픈소스 프로젝트로서, 사용자 환경에 독립적으로 배포할 수 있습니다.
• 요청 시 접근: 공개적으로 사용 가능한 콘텐츠에만 접근하며, 사용자 쿼리 시에만 접근합니다.
• 규칙 준수: GitHub Pages 웹사이트에 접근하기 전에 robots.txt 규칙을 확인하고 웹사이트 소유자가 설정한 지침을 따릅니다.

🚦 사용 제한

GitMCP는 쿼리될 때만 콘텐츠에 접근하며, 저장소를 자동으로 크롤링하지 않습니다. GitHub Pages 웹사이트의 경우, robots.txt 규칙을 확인하고 준수하여 웹사이트 소유자가 옵트아웃할 수 있도록 합니다. GitMCP는 GitHub 프로젝트 또는 그 내용에 대한 데이터를 영구적으로 저장하지 않습니다.

💻 개발 및 기여

로컬에서 실행

# 저장소 복제
git clone https://github.com/idosal/git-mcp.git
cd git-mcp

# 의존성 설치
pnpm install

# 로컬 개발 실행
npm run dev # 또는 pnpm dev

MCP 검사기 도구

# MCP 검사기 도구 설치
npx @modelcontextprotocol/inspector

검사기 인터페이스에서:

• 전송 유형을 SSE로 설정합니다.
• GitMCP URL을 입력합니다 (예: http://localhost:5173/docs).
• "연결"을 클릭합니다.

📄 라이선스

본 프로젝트는 Apache License 2.0 라이선스에 따라 허가됩니다.

⚠️ 면책 조항

GitMCP는 "있는 그대로" 제공되며, 어떠한 종류의 보증도 제공하지 않습니다. 서비스의 신뢰성과 보안을 보장하기 위해 노력하지만, 사용 중 발생할 수 있는 어떠한 손해나 문제에 대해서도 책임을 지지 않습니다. GitMCP를 통해 접근하는 GitHub 프로젝트는 각 소유자의 약관 및 조건에 따릅니다. GitMCP는 GitHub 또는 언급된 어떠한 AI 도구와도 관련이 없습니다.