MCP Git Explorer

MCP Git Explorer

site icon
2025.04.16 0
PythonGit 仓库分析代码库管理开发效率
MCP Git Explorer 是一个基于 Model Context Protocol (MCP) 的服务,主要用于获取远程 Git 仓库的内容并将其转换为结构化的文本文件。它可以帮助用户快速克隆和分析 Git 仓库,生成仓库内容的结构化表示,并估算代码库的大小和令牌数量。支持公共仓库和需要令牌认证的私有 GitLab 仓库。
View on GitHub

Overview

基本能力

产品定位

MCP Git Explorer 是一个用于分析和获取 Git 仓库内容的工具,特别适用于开发者在需要快速了解代码库结构和内容时使用。

核心功能

  • 克隆和分析 Git 仓库
  • 生成仓库内容的结构化文本表示
  • 快速估算代码库大小和令牌数量
  • 支持公共仓库和私有 GitLab 仓库(需令牌认证)
  • 使用 OpenAI 的 tiktoken 库进行令牌计数
  • 尊重 .gitignore 和 .repomixignore 模式
  • 跳过二进制文件和空文本文件
  • 与 Claude 的 Model Context Protocol 集成

适用场景

  • 快速了解 Git 仓库的结构和内容
  • 在分析大型代码库前估算其大小
  • 自动化获取和分析代码库内容

工具列表

  • 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 令牌

常见问题解答

  • 如何访问私有 GitLab 仓库? 通过提供 GitLab 个人访问令牌(--gitlab-token YOUR_TOKEN 或设置环境变量 GIT_EXPLORER_GITLAB_TOKEN
  • 如何快速估算代码库大小? 使用 estimate_codebase 工具

使用教程

使用依赖

无特殊依赖,直接安装即可。

安装教程

从 PyPI 安装

pip install mcp-git-explorer

使用 uv 安装

uv pip install mcp-git-explorer

直接执行(无需安装)

uvx mcp-git-explorer

调试方式

作为命令行工具运行

# 基本用法
mcp-git-explorer

# 使用 SSE 传输
mcp-git-explorer --transport sse

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

开发环境运行

# 直接运行
python -m mcp_git_explorer.cli

# 通过 MCP CLI 运行
mcp dev mcp_git_explorer/cli.py

# 通过 uvx 运行
uvx mcp-git-explorer

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。