MCP Git Explorer

🚀 MCP Git 瀏覽器

MCP Git 瀏覽器是一個簡單的 MCP（模型上下文協議）服務器，它能夠獲取遠程 Git 倉庫的內容，並將其以結構化的文本形式展示出來，為用戶提供便捷的倉庫內容查看體驗。

🚀 快速開始

MCP Git 瀏覽器可幫助你輕鬆克隆和分析 Git 倉庫，生成結構化文本表示，還能快速估算代碼庫大小和令牌數量等。以下是不同使用方式的介紹。

✨ 主要特性

• 可克隆和分析 Git 倉庫。
• 能生成倉庫內容的結構化文本表示。
• 無需獲取所有內容，即可快速估算代碼庫大小和令牌數量。
• 支持公共倉庫以及使用令牌身份驗證的私人 GitLab 倉庫。
• 使用 OpenAI 的 tiktoken 庫進行分詞計數。
• 尊重 .gitignore 和 .repomixignore 模式。
• 會忽略二進制文件和空文本文件。
• 可與 Claude 的模型上下文協議集成。

📦 安裝指南

從 PyPI 安裝

pip install mcp-git-explorer

使用 uv 安裝

uv pip install mcp-git-explorer

直接使用 uvx 運行（無需安裝）

uvx mcp-git-explorer

💻 使用示例

基礎用法

作為命令行工具

# 基本用法
mcp-git-explorer

# 使用 SSE 傳輸
mcp-git-explorer --transport sse

# 提供 GitLab 令牌
mcp-git-explorer --gitlab-token YOUR_TOKEN

環境變量

• GIT_EXPLORER_GITLAB_TOKEN：你的 GitLab 個人訪問令牌，用於訪問私人倉庫。

高級用法

在 Claude 中使用

MCP Git 瀏覽器賦予 Claude 以下能力：

1. 無需手動下載和上傳文件即可探索 Git 倉庫。
2. 訪問整個倉庫內容，並自動進行分詞計數。
3. 橫跨倉庫結構和文件內容進行導航。
4. 在決定獲取完整內容之前，快速評估倉庫大小。

使用場景

• 當你希望快速檢查倉庫的大小和結構（特別是在處理大型倉庫時）以確定是否值得獲取全部內容時，使用 estimate_codebase。
• 當你需要分析實際代碼和文件內容時，使用 get_codebase。

可用工具

• get_codebase(repo_url: str, use_token: bool = True) -> str：克隆並分析一個 Git 倉庫，返回完整的文件內容。
• estimate_codebase(repo_url: str, use_token: bool = True) -> str：快速分析提供倉庫統計信息，包括文件數量、結構和令牌估算。
• check_gitlab_token_status() -> str：檢查是否配置了 GitLab 令牌。

📚 詳細文檔

開發

設置環境

# 克隆倉庫
git clone https://github.com/jmiedzinski/mcp-git-explorer.git
cd mcp-git-explorer

# 安裝開發依賴
uv pip install -e ".[dev]"

本地運行

# 直接運行
python -m mcp_git_explorer.cli

# 使用 MCP CLI 運行
mcp dev mcp_git_explorer/cli.py

# 使用 uvx 運行
uvx mcp-git-explorer

📄 許可證

本項目採用 MIT 許可證。