作者：Naomi Clarkson
编译：小兰

GitHub MCP Server是什么，及其重要性

GitHub MCP Server[1] 是一个强大的工具，它通过模型上下文协议（MCP）提供了与 GitHub API 的无缝集成。

GitHub MCP Server 充当了像 GitHub Copilot 这样的 AI 工具与 GitHub API 之间的桥梁，允许开发者利用 AI 辅助进行仓库管理、代码分析、问题跟踪以及许多其他与 GitHub 相关的任务。

无论您是希望提高生产力的个人开发者，还是寻求简化 GitHub 操作的开发团队的一部分，GitHub MCP Server 都提供了宝贵的自动化和集成可能性。

安装先决条件

在开始安装 GitHub MCP Server 之前，您需要确保已具备必要的先决条件：

1. Docker 安装：由于 GitHub MCP Server 在容器中运行，您需要在系统上安装 Docker。Docker 提供了 GitHub MCP Server 依赖的容器化平台，以确保在不同环境中的一致部署。
2. GitHub 个人访问令牌 (PAT)：MCP 服务器与 GitHub API 交互，因此您需要创建一个 GitHub 个人访问令牌（Personal Access Token）。此令牌应具有您计划通过 MCP 服务器执行的 GitHub 操作所需的适当权限。具体权限取决于您的用例，但常见的权限包括仓库访问、问题管理和拉取请求交互。
3. 理解 GitHub API：虽然不是严格要求，但对 GitHub API 的基本熟悉将帮助您充分利用 GitHub MCP Server 的功能。

安装方法

有几种方法可以安装和设置 GitHub MCP Server，具体取决于您偏好的开发环境和用例：

方法一：在 VS Code 中使用 GitHub MCP Server

Visual Studio Code 提供了与 GitHub MCP Server 集成的最直接方法之一。以下是设置步骤：

1. 如果 GitHub MCP Server 仓库中提供了一键安装选项，您可以使用它们。
2. 对于手动安装，将以下 JSON 配置添加到您的 VS Code 用户设置文件（可以通过按 Ctrl + Shift + P 并输入 "Preferences: Open User Settings (JSON)" 来访问）：

{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "github_token",
        "description": "GitHub 个人访问令牌",
        "password": true
      }
    ],
    "servers": {
      "github": {
        "command": "docker",
        "args": [
          "run",
          "-i",
          "--rm",
          "-e",
          "GITHUB_PERSONAL_ACCESS_TOKEN",
          "ghcr.io/github/github-mcp-server"
        ],
        "env": {
          "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}"
        }
      }
    }
  }
}

3. 或者，您可以在工作区中创建一个 .vscode/mcp.json 文件，以便与您的团队共享配置。在这种情况下，配置中不需要 mcp 键。

方法二：在 Claude Desktop 中使用 GitHub MCP Server

如果您正在使用 Claude Desktop，可以使用以下 JSON 配置 GitHub MCP Server：

{
  "mcpServers": {
    "github": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "GITHUB_PERSONAL_ACCESS_TOKEN",
        "ghcr.io/github/github-mcp-server"
      ],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

方法三：从源代码构建 GitHub MCP Server

对于不喜欢使用 Docker 的用户，可以从源代码构建 GitHub MCP Server：

1. 使用 Go 编程语言在 cmd/github-mcp-server 目录中构建二进制文件。
2. 运行 github-mcp-server stdio 命令，并将 GITHUB_PERSONAL_ACCESS_TOKEN 环境变量设置为您的令牌。

适用于企业环境的 GitHub MCP Server

如果您使用的是 GitHub Enterprise Server 而不是 GitHub.com[2]，您可以通过以下方式配置 GitHub MCP Server 以连接到您的企业实例：

1. 运行 GitHub MCP Server 时使用 -gh-host 标志，或者
2. 将 GH_HOST 环境变量设置为您的 GitHub Enterprise Server 主机名。

这种灵活性使 GitHub MCP Server 成为拥有自托管 GitHub 实例的组织的可行选择，确保您所有的 GitHub 操作都保留在组织的基础设施内。

自定义 GitHub MCP Server：国际化和描述

GitHub MCP Server 允许自定义工具描述，这对于国际化或仅仅为了使工具更易于理解您的特定用例非常有用：

1. 在与二进制文件相同的目录中创建一个 github-mcp-server-config.json 文件。

2. 以 JSON 格式为工具添加自定义描述。例如：

{
  "TOOL_ADD_ISSUE_COMMENT_DESCRIPTION": "一个替代描述",
  "TOOL_CREATE_BRANCH_DESCRIPTION": "在 GitHub 仓库中创建一个新分支"
}

3. 您还可以通过使用 -export-translations 标志运行二进制文件来导出当前的翻译。

4. 环境变量也可用于覆盖，使用命名约定 GITHUB_MCP_TOOL_NAME_DESCRIPTION（全大写）。

GitHub MCP Server 提供了许多用于与仓库交互的工具。以下是一些最有用的工具：

创建和管理文件

GitHub MCP Server 允许您使用以下工具以编程方式在仓库中创建和更新文件：

• create_or_update_file：在仓库中创建或更新单个文件，需要仓库所有者、仓库名称、文件路径、提交消息和文件内容等参数。
• push_files：在单个提交中推送多个文件，非常适合批量文件操作。
• get_file_contents：从仓库中检索文件或目录的内容。

进行分支管理

通过 GitHub MCP Server 的工具，Git 分支操作得以简化：

• create_branch：从仓库中指定的 SHA 创建一个新分支。
• list_commits：获取仓库中分支的提交历史。

进行仓库操作

GitHub MCP Server 提供了全面的仓库管理功能：

• create_repository：创建一个新的 GitHub 仓库，可选择描述、可见性和初始化选项。
• fork_repository：创建现有仓库的分支（fork）。
• search_repositories：根据特定的查询参数在 GitHub 上搜索仓库。

进行 Issue 和 Pull Request 工作流

GitHub 的协作功能可通过 MCP Server 的专用工具访问：

进行 Issue 管理

• create_issue：在仓库中创建新 Issue。
• get_issue：检索特定 Issue 的详细信息。
• list_issues：列出并筛选仓库中的 Issue。
• update_issue：使用新信息更新现有 Issue。
• add_issue_comment：向 Issue 添加评论以进行讨论和澄清。
• search_issues：根据查询参数在仓库中搜索 Issue。

处理 Pull Request

• create_pull_request：在分支之间创建新的 Pull Request。
• get_pull_request：检索特定 Pull Request 的详细信息。
• list_pull_requests：列出并筛选仓库中的 Pull Request。
• merge_pull_request：合并已批准的 Pull Request。
• get_pull_request_files：显示 Pull Request 中更改的文件。
• get_pull_request_status：获取 Pull Request 上所有检查的组合状态。
• update_pull_request_branch：使用基础分支的最新更改更新 Pull Request 分支。
• create_pull_request_review：在 Pull Request 上创建审查，包括评论和批准状态。

GitHub MCP Server 超越了基本的仓库操作，包含了高级功能：

进行代码扫描

对于启用了代码扫描的仓库，GitHub MCP Server 提供了以下工具：

• get_code_scanning_alert：检索特定代码扫描警报的详细信息。
• list_code_scanning_alerts：列出仓库中所有的代码扫描警报，并提供筛选选项。

进行GitHub 搜索

GitHub MCP Server 提供了强大的 GitHub 搜索功能：

• search_code：在 GitHub 仓库中搜索代码。
• search_users：搜索 GitHub 用户。
• search_issues：在仓库中搜索 Issue 和 Pull Request。

GitHub MCP Server 的实际用例

GitHub MCP Server 支持许多实际应用：

1. 自动化仓库维护：设置工作流，自动创建分支、提交更改并为日常维护任务创建 Pull Request。
2. Issue 管理自动化：根据特定的触发器或计划自动创建、更新和评论 Issue。
3. AI 辅助代码审查：利用带有 GitHub MCP Server 的 AI 工具分析 Pull Request，提出改进建议，甚至自动批准简单的更改。
4. 仓库分析：从仓库中提取数据进行分析和可视化，例如跟踪代码更改、Issue 解决时间和贡献者活动。
5. 自定义 GitHub 工作流：创建与其它系统集成的专用工作流，将 GitHub 操作与您更广泛的开发生态系统连接起来。

常见问题与解决方案

在使用 GitHub MCP Server 时，您可能会遇到一些常见问题：

1. 身份验证失败：确保您的 GitHub 个人访问令牌具有必要的权限且未过期。
2. Docker 相关问题：验证 Docker 在您的系统上是否正常运行，以及您是否有权限运行 Docker 命令。
3. 速率限制：GitHub API 有速率限制；如果您发出大量请求，可能会达到这些限制。考虑在您的应用程序逻辑中实现速率限制处理。
4. 配置问题：仔细检查您的配置文件是否存在语法错误或缺少参数。

引用链接

[1] GitHub MCP Server: https://github.com/github/github-mcp-server
[2] GitHub.com: http://github.com/