MCP Git Ingest

MCP Git Ingest

site icon
2025.01.26 133
PythonGitHub 仓库分析代码结构解析开发效率
mcp-git-ingest 是一个基于 Model Context Protocol (MCP) 的服务,主要用于读取 GitHub 仓库的结构和重要文件。它提供了两个核心工具:`github_directory_structure` 用于获取仓库的目录结构,`github_read_important_files` 用于读取指定文件的内容。该服务适用于开发者在代码分析、项目理解和自动化工具集成等场景中使用。
View on GitHub

Overview

基本能力

产品定位

mcp-git-ingest 是一个用于读取 GitHub 仓库结构和文件的 MCP 服务,旨在帮助开发者快速了解和分析代码仓库的内容。

核心功能

  1. github_directory_structure:生成 GitHub 仓库的目录结构树状图。
  2. github_read_important_files:读取并返回指定文件的内容。
  3. 错误处理:提供健壮的错误处理机制,确保临时文件的清理。
  4. 性能优化:通过哈希命名临时目录和检查现有仓库来优化性能。

适用场景

  1. 代码仓库分析和理解。
  2. 自动化工具集成,如 CI/CD 流程中的代码检查。
  3. 教育和培训,帮助新手快速了解项目结构。

工具列表

  1. github_directory_structure:生成仓库的目录结构。
  2. github_read_important_files:读取仓库中的指定文件内容。

常见问题解答

  1. 如何安装依赖?
  2. 需要 Python 3.8+ 和 gitpython 库。
  3. 如何运行服务?
  4. 使用 uvx 命令启动服务。

使用教程

使用依赖

pip install gitpython fastmcp

安装教程

uvx --from git+https://github.com/adhikasp/mcp-git-ingest mcp-git-ingest

调试方式

llm read https://github.com/adhikasp/mcp-git-ingest and determine how the code technically works

许可证

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