GitHub Repository MCP Server

GitHub 仓库 MCP 服务

此 Model Context Protocol（MCP）服务允许 AI 模型将 GitHub 仓库内容用作上下文。它提供工具，可获取文件内容、仓库结构和整个仓库，供 AI 交互使用。

功能

• 获取整个仓库的内容作为上下文
• 获取仓库中的指定文件内容
• 获取仓库结构（文件列表）
• 按扩展名筛选文件
• 排除指定路径
• 限制返回的文件数量

安装

# clone the repository
git clone https://github.com/shanksxz/github-mcp.git
cd github-mcp

# install dependencies
npm install

# build the project
npm run build

用法

设置 GitHub 身份验证

此服务无需身份验证即可访问公开仓库，但 GitHub API 对未经身份验证的请求设有严格的速率限制（每小时 60 次请求）。若要将此限制提高到每小时 5000 次请求，请设置 GITHUB_TOKEN 环境变量：

# create a file called gh.sh and add the following line:
export GITHUB_TOKEN=your_github_personal_access_token
# make the file executable
chmod +x gh.sh
# run the file
./gh.sh

你可以在 GitHub 开发者设置中创建个人访问令牌。

与 Cursor 搭配使用

按照以下步骤将此服务与 Cursor 搭配使用：

1. 打开 Cursor 设置
2. 搜索“MCP”
3. 点击“Add a new MCP Server”
4. 输入以下信息：
   • 名称：github-repo-context（或任意名称）
   • 类型：Command
   • 命令：/path/to/your-local-repo-setup/gh.sh
5. 点击“Save”
6. 点击服务名称旁的切换开关，启用该服务
7. 现在，你应该可以在项目中使用此服务

此服务通过 stdin/stdout 按照 MCP 协议进行通信。

可用工具

此服务提供以下工具：

1. get-repo-context：获取 GitHub 仓库中的所有文件，作为上下文使用

   • 参数：
     • owner：GitHub 仓库所有者／组织名称
     • repo：GitHub 仓库名称
     • maxFiles（可选）：要包含的最大文件数（默认值：50）
     • fileExtensions（可选）：要包含的文件扩展名（例如，['js', 'ts', 'md']）
     • excludePaths（可选）：要排除的路径（默认值：['node_modules', 'dist', 'build']）

2. get-file-content：获取 GitHub 仓库中指定文件的内容

   • 参数：
     • owner：GitHub 仓库所有者／组织名称
     • repo：GitHub 仓库名称
     • path：仓库中文件的路径

3. get-repo-structure：获取 GitHub 仓库的结构

   • 参数：
     • owner：GitHub 仓库所有者／组织名称
     • repo：GitHub 仓库名称

示例

与支持 MCP 的 AI 模型集成后，你可以使用如下命令：

Get the structure of the repository tensorflow/tensorflow

随后，AI 会使用 get-repo-structure 工具获取并显示仓库结构。