GitHub MCP Server Setup Guide

GitHub MCP 服务设置指南

本仓库演示如何设置和使用 GitHub Model Context Protocol（MCP）服务，以支持 AI 辅助开发工作流。

什么是 MCP？

Model Context Protocol（MCP）使 AI 助手能够通过标准化接口与外部系统和 API 交互。GitHub MCP 服务专门允许 AI 模型执行 GitHub 操作，例如：

• 创建和管理仓库
• 管理文件和内容
• 处理议题和拉取请求
• 访问仓库信息
• 以及更多操作！

设置说明

前提条件

• 系统已安装 Node.js
• 拥有 GitHub 账户
• 拥有具备相应权限的 GitHub Personal Access Token（PAT）

第 1 步：创建 GitHub Personal Access Token

1. 前往 GitHub Settings → Developer Settings → Personal Access Tokens
2. 创建具有以下权限的新细粒度令牌：
   • Repository：读写（Administration、Contents、Issues、Pull requests）
   • User：只读
3. 安全保存令牌——配置时需要用到

第 2 步：设置 MCP 配置

1. 在用户目录中创建名为 mcp.json 的配置文件（例如，~/.cursor/mcp.json 或 C:\Users\YourUsername\.cursor\mcp.json）
2. 添加以下配置：

{
  "mcpServers": {
    "github": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-github"
      ],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "your_github_pat_here"
      }
    }
  }
}

3. 将 your_github_pat_here 替换为你的 GitHub Personal Access Token

第 3 步：测试 MCP 服务

1. 安装支持 MCP 的兼容 AI 编码助手（例如 Cursor）
2. 请助手执行 GitHub 操作，例如：
   • 创建仓库
   • 获取文件内容
   • 创建议题
   • 创建拉取请求

使用示例

以下是你可以通过 GitHub MCP 执行的一些操作示例：

• 创建新仓库：Create a new GitHub repository named "my-project"
• 向仓库推送代码：Push this file to my repository
• 创建议题：Create an issue titled "Fix navigation bug" in my repository
• 获取仓库内容：Show me the contents of the main.js file from my repository

故障排除

• 权限错误：确保你的 GitHub PAT 具备所尝试执行的操作所需的权限
• 连接问题：检查 MCP 服务是否已正确配置并正在运行
• 令牌过期：GitHub PAT 可能会过期——检查是否需要重新生成

资源

• Model Context Protocol（MCP）文档
• GitHub API 文档
• NPM 包：@modelcontextprotocol/server-github

---

注意：请始终妥善保管 GitHub Personal Access Token，切勿将其提交到公开仓库。