项目简介

MCP Git Repo Browser 是一个基于 Model Context Protocol (MCP) 的服务器实现,它允许大型语言模型 (LLM) 通过标准化的 MCP 协议访问和分析 Git 仓库。该服务器提供工具,使 LLM 能够获取仓库的目录结构以及读取指定文件的内容,从而增强 LLM 在代码理解、分析和生成等方面的能力。

主要功能点

  • 浏览 Git 仓库目录结构:提供 'git_directory_structure' 工具,LLM 可以通过提供 Git 仓库 URL,获取该仓库的目录结构树形文本表示。
  • 读取 Git 仓库文件内容:提供 'git_read_important_files' 工具,LLM 可以指定 Git 仓库 URL 和文件路径列表,服务器将返回这些文件的内容,方便 LLM 理解代码细节。

安装步骤

  1. 克隆仓库: 使用 Git 命令克隆 'mcp-git-repo-browser' 仓库到本地:

    git clone https://github.com/razorback16/mcp-git-repo-browser
    cd mcp-git-repo-browser
  2. 安装依赖: 在项目根目录下运行 npm 命令安装项目依赖:

    npm install

服务器配置

要将此 MCP 服务器集成到 MCP 客户端,需要在客户端的配置文件中添加以下服务器配置信息。请根据实际情况修改配置中的路径。

{
    "mcpServers": {
        "mcp-git-repo-browser": {
            "command": "node",
            "args": ["/path/to/mcp-git-repo-browser/src/index.js"]
        }
    }
}
  • 'mcpServers': 定义 MCP 服务器配置的顶级键。
  • 'mcp-git-repo-browser': 为该 Git 仓库浏览器服务器定义的名称,客户端配置中引用此名称。
  • 'command': 启动服务器的命令,这里使用 'node' 运行 Node.js 程序。
  • 'args': 启动服务器命令的参数,指向服务器入口文件 'src/index.js' 的绝对路径。请将 '/path/to/mcp-git-repo-browser' 替换为实际的项目路径,例如 '/Users/yourname/mcp-git-repo-browser/src/index.js'。

注意:请确保将 '/path/to/mcp-git-repo-browser' 替换为 'mcp-git-repo-browser' 仓库在您本地文件系统中的实际绝对路径。

基本使用方法

  1. 启动服务器: 在克隆的项目根目录下,运行以下命令启动 MCP 服务器:

    node src/index.js

    服务器将在标准输入/输出 (stdio) 上运行,并等待 MCP 客户端连接。

  2. 配置并启动 MCP 客户端: 配置您的 MCP 客户端,使其能够连接到名为 'mcp-git-repo-browser' 的服务器。客户端启动后,将自动与该服务器建立连接。

  3. LLM 调用工具: 在 LLM 应用中,可以使用 MCP 协议调用服务器提供的 'git_directory_structure' 和 'git_read_important_files' 工具,并传递必要的参数(如仓库 URL 和文件路径)。服务器将处理请求并将结果返回给 LLM 客户端。

例如,要获取仓库目录结构,LLM 可以调用 'git_directory_structure' 工具并提供 Git 仓库的 URL 作为参数。服务器将返回该仓库的目录树结构文本。

信息

分类

开发者工具