使用说明

项目简介

Gitingest-MCP 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在帮助大型语言模型 (LLM) 客户端快速获取 GitHub 仓库的相关信息。通过 Gitingest-MCP，LLM 可以方便地理解和分析代码仓库，从而更好地服务于代码相关的应用场景，例如代码理解、代码生成、代码检索等。

主要功能点

仓库摘要: 提供 GitHub 仓库的概括性信息，包括仓库名称、文件列表、预估 tokens 数量以及 README.md 的内容摘要。
目录结构: 获取 GitHub 仓库的目录树结构，帮助 LLM 理解项目的文件组织方式。
文件内容: 检索并返回 GitHub 仓库中指定文件的内容，使 LLM 可以深入分析代码细节。

安装步骤

克隆仓库

git clone https://github.com/puravparab/Gitingest-MCP
cd Gitingest-MCP

安装依赖 确保已安装 'uv' 包管理器 (可以使用 'pip install uv')，然后在仓库目录下运行：
```
uv sync
```

服务器配置

为了让 MCP 客户端（如 Claude Desktop, Cline, Cursor 等）连接到 Gitingest-MCP 服务器，您需要在客户端的配置文件中添加以下服务器配置信息。通常，配置文件是一个 JSON 文件。

以下配置信息指示 MCP 客户端如何启动 Gitingest-MCP 服务器：

{
  "mcpServers": {
    "gitingest-mcp": {
      "command": "<path to uv>/uvx",
      "args": [
        "--from",
        "git+https://github.com/puravparab/gitingest-mcp",
        "gitingest-mcp"
      ]
    }
  }
}

配置参数说明：

'"gitingest-mcp"': 服务器名称，您可以自定义，用于在 MCP 客户端中标识该服务器。
'"command": "<path to uv>/uvx"': 启动服务器的命令。 '<path to uv>/uvx' 需要替换为您实际 'uvx' 可执行文件的路径。'uvx' 是 'uv' 包管理器提供的可执行文件，用于运行 Python 应用。
'"args"': 启动服务器命令的参数列表。
- '"--from", "git+https://github.com/puravparab/gitingest-mcp"': 指定从 GitHub 仓库安装 Gitingest-MCP 服务器。
- '"gitingest-mcp"': 指定要安装和运行的服务器项目名称。

重要提示：

您需要将 '<path to uv>/uvx' 替换为 'uvx' 的实际路径。 'uvx' 通常位于您的 Python 虚拟环境或 'uv' 安装目录中。
具体的 MCP 客户端配置文件位置请参考您使用的客户端软件的文档。例如，Claude Desktop 的配置文件通常位于 '~/Library/Application\ Support/Claude/claude_desktop_config.json' (macOS)。

基本使用方法

Gitingest-MCP 服务器提供了以下工具 (Tools)，您可以在 MCP 客户端中调用这些工具来获取 GitHub 仓库信息：

'git_summary': 获取仓库摘要信息。
- 参数:
  - 'owner' (字符串): GitHub 组织或用户名。
  - 'repo' (字符串): 仓库名称。
  - 'branch' (字符串, 可选): 分支名称，默认为主分支。
'git_tree': 获取仓库目录结构。
- 参数:
  - 'owner' (字符串): GitHub 组织或用户名。
  - 'repo' (字符串): 仓库名称。
  - 'branch' (字符串, 可选): 分支名称，默认为主分支。
'git_files': 获取指定文件的内容。
- 参数:
  - 'owner' (字符串): GitHub 组织或用户名。
  - 'repo' (字符串): 仓库名称。
  - 'file_paths' (字符串列表): 文件路径列表，指定要获取内容的文件。
  - 'branch' (字符串, 可选): 分支名称，默认为主分支。

使用示例 (在 MCP 客户端中调用 'git_summary' 工具):

假设您想获取 'puravparab/Gitingest-MCP' 仓库的摘要信息，您可以在 MCP 客户端中发起如下工具调用请求 (具体的请求格式取决于您使用的 MCP 客户端)：

{
  "method": "call_tool",
  "params": {
    "tool_name": "git_summary",
    "tool_args": {
      "owner": "puravparab",
      "repo": "Gitingest-MCP"
    }
  }
}

服务器会返回包含仓库摘要信息的 JSON-RPC 响应。其他工具的使用方法类似，只需根据需要调整 'tool_name' 和 'tool_args' 即可。

关键词