项目简介

MCP GitHub Repository Server 是一个实现了 Model Context Protocol (MCP) 的服务器，它允许用户通过标准化的 MCP 协议访问 GitHub 仓库的内容。这个服务器可以作为 AI 助手的后端，使其能够浏览和读取 GitHub 仓库中的文件。

主要功能点

通过 URI 访问 GitHub 仓库中的任何文件。
列出仓库内容并浏览目录结构。
支持访问特定分支的文件。
以纯文本格式提供文件内容。

安装步骤

确保已安装 Node.js 和 npm。
克隆仓库到本地： 'git clone https://github.com/loglmhq/mcp-server-github-repo.git'
进入仓库目录： 'cd mcp-server-github-repo'
安装依赖： 'npm install'
构建项目： 'npm run build'

服务器配置

为了让 MCP 客户端（例如 Claude Desktop）连接到此服务器，您需要在客户端的配置文件中添加以下服务器配置信息。以 Claude Desktop 为例，配置文件通常位于： - MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json' - Windows: '%APPDATA%/Claude/claude_desktop_config.json'

在 'mcpServers' 字段中添加如下配置：

{
  "mcpServers": {
    "github-repo-server": {
      "command": "/path/to/mcp-server-github-repo/build/index.js",
      "args": [],
      "serverName": "github-repo-server"
    }
  }
}

配置参数说明:

'command': 指向编译后的服务器程序入口文件 'index.js' 的路径。请根据实际情况修改为服务器在您本地文件系统中的绝对路径。
'args': 启动服务器时需要传递的命令行参数，此服务器不需要命令行参数，所以为空数组。
'serverName': MCP 服务器的名称，可以自定义，用于在客户端中标识和引用该服务器。

环境变量配置: 在运行服务器之前，您需要设置以下环境变量：

'GITHUB_PERSONAL_ACCESS_TOKEN': 您的 GitHub 个人访问令牌，用于 API 鉴权。需要具有 'repo' 权限。
'GITHUB_OWNER': 要访问的 GitHub 仓库的所有者用户名或组织名。
'GITHUB_REPO': 要访问的 GitHub 仓库名称。
'GITHUB_BRANCH' (可选): 要访问的 GitHub 仓库分支名，默认为主分支。

您可以通过多种方式设置环境变量，例如在终端中直接 export，或者在 '.env' 文件中配置。

基本使用方法

配置好环境变量。
启动 MCP 服务器。在仓库根目录下执行： 'node build/index.js' (或者直接运行配置的 'command' 路径)。
在 MCP 客户端中配置并连接到该服务器。客户端可以通过 'ListResources' 请求列出仓库资源，通过 'ReadResource' 请求读取文件内容。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息