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 许可证。