在 VS Code 中配置、连接和使用 GitHub MCP 服务器

已完成

在本单元中,你将了解如何在 Visual Studio Code 中设置和使用 GitHub MCP 服务器,以便可以直接将 AI 支持的工作流引入开发环境。 学习内容:

  • 如何使用 OAuth 或个人访问令牌进行设置 (PAT)

  • 使用 Docker 进行可选本地设置,以便进行更多控制

  • 如何将 GitHub MCP 服务器与 Copilot Chat 配合使用,实现 AI 支持的工作效率

  • 常见故障排除步骤

在 VS Code 中设置 GitHub MCP 服务器

使用 OAuth

了解 GitHub MCP Server 可以执行的作后,让我们逐步了解如何在 Visual Studio Code 中设置它,以便可以立即开始使用它。 这样,即可将首选 AI 支持的工作流直接集成到编码环境中,而无需进行复杂的设置。

  1. 在 Visual Studio Code 中,按 Ctrl+Shift+P(Windows/Linux)或 Cmd+Shift+P(Mac)打开命令面板。
  2. 键入 MCP:添加服务器,然后按 Enter。
  3. 从列表中选择“HTTP”(HTTP 或 Server-Sent 事件)。
  4. “服务器 URL ”字段中,输入 https://api.githubcopilot.com/mcp/,然后按 Enter。
  5. 当系统提示输入 服务器 ID 时,可以按 Enter 以使用默认 ID 或键入自定义 ID(如果愿意)。
  6. 选择要保存 MCP 服务器配置的位置。 你可以将其添加到用户设置,以便在所有项目或当前项目的工作区设置中使用。
  7. 将出现提示,要求使用 OAuth 通过 GitHub 授权。 如果系统提示,请选择 “允许 ”并登录到 GitHub 帐户。

设置后,GitHub MCP 服务器将准备好在 VS Code 中与项目一起使用。 现在可以开始使用 AI 驱动的工具和工作流,在编辑器中直接自动执行任务、管理问题和分析代码,帮助你专注于工作,而 GitHub MCP 服务器处理后台的繁重工作。

使用个人访问令牌

若要使用个人访问令牌(PAT)进行高级控制,可以按照以下步骤作:

  1. 使用存储库和读取创建 PAT:GitHub 帐户中的包范围。

  2. 你将按照上述相同步骤作,但在出现提示时取消 OAuth。

  3. 在配置文件中,添加:

    "headers": {
      "Authorization": "Bearer ${input:github_token}"
    }
    
  4. 接下来,添加输入提示以安全地输入令牌:

    "inputs": [
      {
        "id": "github_token",
        "type": "promptString",
        "description": "GitHub Personal Access Token",
        "password": true
      }
    ]
    
  5. 最后,在 VS Code 中重启 MCP 服务器,并在出现提示时输入 PAT。

  6. MCP 服务器现在将配置为使用 PAT 进行授权。

使用 Docker 设置本地 MCP 服务器(可选)

如果企业使用具有 PAT 限制的 GitHub Enterprise Server,则只能访问组织策略允许的 API 范围。 如果所有终结点都受到限制,MCP 服务器将不可用,请检查管理员是否不确定。

对于本地使用,MCP 服务器需要 Docker 并使用个人访问令牌(PAT)进行身份验证。 此设置不支持 OAuth。

  1. 首先,需要确认是否已在系统上安装并运行 Docker。

  2. 接下来,生成具有所需范围的 PAT。

  3. 使用以下配置在本地运行服务器:

    {
      "inputs": [
        {
          "type": "promptString",
          "id": "github_token",
          "description": "GitHub Personal Access Token",
          "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}"
          }
        }
      }
    }
    
  4. 重启 MCP 服务器,并在系统提示完成设置时输入 PAT。

Troubleshooting

如果在使用 GitHub MCP 服务器时遇到问题,下面是一些实际检查:

  • 确认已登录到 VS Code 中的 GitHub 帐户。
  • 如果使用 PAT,请确保它具有正确的范围并正确输入。
  • 仔细检查配置中是否有任何拼写错误或缺少的字段。
  • 如果使用 Docker,请确保已安装并主动运行。
  • 请尝试重启 VS Code 或 MCP 服务器以解决临时连接问题。