GitHub MCP Server

GitHub MCP Server

tangochuy

开发者工具
访问服务器

README

GitHub MCP 服务器

GitHub MCP 服务器是一个 模型上下文协议 (MCP) 服务器，提供与 GitHub API 的无缝集成，为开发者和工具启用高级自动化和交互功能。

在 VS Code 中使用 Docker 安装 在 VS Code Insiders 中使用 Docker 安装

使用场景

  • 自动化 GitHub 工作流程和流程。
  • 从 GitHub 仓库提取和分析数据。
  • 构建与 GitHub 生态系统交互的 AI 驱动工具和应用程序。

前提条件

  1. 要在容器中运行服务器，您需要安装 Docker。
  2. 安装 Docker 后，您还需要确保 Docker 正在运行。
  3. 最后，您需要 创建一个 GitHub 个人访问令牌。 MCP 服务器可以使用许多 GitHub API，因此请启用您认为可以授予 AI 工具的权限（要了解有关访问令牌的更多信息，请查看文档）。

安装

在 VS Code 中使用

要快速安装，请使用此 README 顶部的一键安装按钮之一。

对于手动安装，请将以下 JSON 代码块添加到 VS Code 中的用户设置 (JSON) 文件中。 您可以通过按 Ctrl + Shift + P 并键入 Preferences: Open User Settings (JSON) 来执行此操作。

或者，您可以将其添加到工作区中名为 .vscode/mcp.json 的文件中。 这将允许您与他人共享配置。

请注意，.vscode/mcp.json 文件中不需要 mcp 键。

{
  "mcp": {
    "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}"
        }
      }
    }
  }
}

有关在 VS Code 的 代理模式文档 中使用 MCP 服务器工具的更多信息。

在 Claude Desktop 中使用

{
  "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>"
      }
    }
  }
}

从源代码构建

如果您没有 Docker，可以使用 go 在 cmd/github-mcp-server 目录中构建二进制文件，并使用 github-mcp-server stdio 命令，并将 GITHUB_PERSONAL_ACCESS_TOKEN 环境变量设置为您的令牌。

GitHub Enterprise Server

可以使用标志 --gh-host 和环境变量 GH_HOST 来设置 GitHub Enterprise Server 主机名。

i18n / 覆盖描述

可以通过在与二进制文件相同的目录中创建一个 github-mcp-server-config.json 文件来覆盖工具的描述。

该文件应包含一个 JSON 对象，其中工具名称作为键，新描述作为值。 例如：

{
  "TOOL_ADD_ISSUE_COMMENT_DESCRIPTION": "an alternative description",
  "TOOL_CREATE_BRANCH_DESCRIPTION": "Create a new branch in a GitHub repository"
}

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

此标志将保留您所做的任何翻译/覆盖，同时添加自上次导出以来已添加到二进制文件的任何新翻译。

./github-mcp-server --export-translations
cat github-mcp-server-config.json

您还可以使用 ENV 变量来覆盖描述。 环境变量名称与 JSON 文件中的键相同，前缀为 GITHUB_MCP_ 且全部大写。

例如，要覆盖 TOOL_ADD_ISSUE_COMMENT_DESCRIPTION 工具，您可以设置以下环境变量：

export GITHUB_MCP_TOOL_ADD_ISSUE_COMMENT_DESCRIPTION="an alternative description"

工具

用户

  • get_me - 获取已验证用户的详细信息
    • 无需参数

问题

  • get_issue - 获取仓库中 issue 的内容

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • issue_number: Issue 编号（数字，必需）

  • get_issue_comments - 获取 GitHub issue 的评论

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • issue_number: Issue 编号（数字，必需）

  • create_issue - 在 GitHub 仓库中创建一个新 issue

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • title: Issue 标题（字符串，必需）
    • body: Issue 正文内容（字符串，可选）
    • assignees: 要分配给此 issue 的用户名（字符串数组，可选）
    • labels: 要应用于此 issue 的标签（字符串数组，可选）

  • add_issue_comment - 向 issue 添加评论

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • issue_number: Issue 编号（数字，必需）
    • body: 评论文本（字符串，必需）

  • list_issues - 列出和过滤仓库 issue

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • state: 按状态过滤（'open'、'closed'、'all'）（字符串，可选）
    • labels: 要过滤的标签（字符串数组，可选）
    • sort: 按（'created'、'updated'、'comments'）排序（字符串，可选）
    • direction: 排序方向（'asc'、'desc'）（字符串，可选）
    • since: 按日期过滤（ISO 8601 时间戳）（字符串，可选）
    • page: 页码（数字，可选）
    • perPage: 每页结果数（数字，可选）

  • update_issue - 更新 GitHub 仓库中的现有 issue

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • issue_number: 要更新的 Issue 编号（数字，必需）
    • title: 新标题（字符串，可选）
    • body: 新描述（字符串，可选）
    • state: 新状态（'open' 或 'closed'）（字符串，可选）
    • labels: 新标签（字符串数组，可选）
    • assignees: 新受让人（字符串数组，可选）
    • milestone: 新里程碑编号（数字，可选）

  • search_issues - 搜索 issue 和 pull request

    • query: 搜索查询（字符串，必需）
    • sort: 排序字段（字符串，可选）
    • order: 排序顺序（字符串，可选）
    • page: 页码（数字，可选）
    • perPage: 每页结果数（数字，可选）

Pull Requests

  • get_pull_request - 获取特定 pull request 的详细信息

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • pullNumber: Pull request 编号（数字，必需）

  • list_pull_requests - 列出和过滤仓库 pull request

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • state: PR 状态（字符串，可选）
    • sort: 排序字段（字符串，可选）
    • direction: 排序方向（字符串，可选）
    • perPage: 每页结果数（数字，可选）
    • page: 页码（数字，可选）

  • merge_pull_request - 合并 pull request

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • pullNumber: Pull request 编号（数字，必需）
    • commit_title: 合并提交的标题（字符串，可选）
    • commit_message: 合并提交的消息（字符串，可选）
    • merge_method: 合并方法（字符串，可选）

  • get_pull_request_files - 获取 pull request 中更改的文件列表

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • pullNumber: Pull request 编号（数字，必需）

  • get_pull_request_status - 获取 pull request 的所有状态检查的组合状态

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • pullNumber: Pull request 编号（数字，必需）

  • update_pull_request_branch - 使用来自基本分支的最新更改更新 pull request 分支

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • pullNumber: Pull request 编号（数字，必需）
    • expectedHeadSha: pull request 的 HEAD ref 的预期 SHA（字符串，可选）

  • get_pull_request_comments - 获取 pull request 上的评论

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • pullNumber: Pull request 编号（数字，必需）

  • get_pull_request_reviews - 获取 pull request 上的 review

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • pullNumber: Pull request 编号（数字，必需）

  • create_pull_request_review - 在 pull request review 上创建 review

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • pullNumber: Pull request 编号（数字，必需）
    • body: Review 评论文本（字符串，可选）
    • event: Review 操作（'APPROVE'、'REQUEST_CHANGES'、'COMMENT'）（字符串，必需）
    • commitId: 要 review 的提交的 SHA（字符串，可选）
    • comments: 用于在 pull request 更改上放置评论的行特定评论对象数组（数组，可选）
      • 对于内联评论：提供 path、position（或 line）和 body
      • 对于多行评论：提供 path、start_line、line、可选 side/start_side 和 body

  • create_pull_request - 创建一个新的 pull request

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • title: PR 标题（字符串，必需）
    • body: PR 描述（字符串，可选）
    • head: 包含更改的分支（字符串，必需）
    • base: 要合并到的分支（字符串，必需）
    • draft: 创建为草稿 PR（布尔值，可选）
    • maintainer_can_modify: 允许维护者编辑（布尔值，可选）

  • add_pull_request_review_comment - 向 pull request 添加 review 评论或回复现有评论

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • pull_number: Pull request 编号（数字，必需）
    • body: review 评论的文本（字符串，必需）
    • commit_id: 要评论的提交的 SHA（字符串，必需，除非使用 in_reply_to）
    • path: 需要评论的文件的相对路径（字符串，必需，除非使用 in_reply_to）
    • line: 评论应用于的 pull request diff 中 blob 的行（数字，可选）
    • side: 要评论的 diff 的一侧（LEFT 或 RIGHT）（字符串，可选）
    • start_line: 对于多行评论，范围的第一行（数字，可选）
    • start_side: 对于多行评论，diff 的起始侧（LEFT 或 RIGHT）（字符串，可选）
    • subject_type: 评论的目标级别（行或文件）（字符串，可选）
    • in_reply_to: 要回复的 review 评论的 ID（数字，可选）。 指定后，只需要正文，其他参数将被忽略。

  • update_pull_request - 更新 GitHub 仓库中的现有 pull request

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • pullNumber: 要更新的 Pull request 编号（数字，必需）
    • title: 新标题（字符串，可选）
    • body: 新描述（字符串，可选）
    • state: 新状态（'open' 或 'closed'）（字符串，可选）
    • base: 新基本分支名称（字符串，可选）
    • maintainer_can_modify: 允许维护者编辑（布尔值，可选）

仓库

  • create_or_update_file - 在仓库中创建或更新单个文件

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • path: 文件路径（字符串，必需）
    • message: 提交消息（字符串，必需）
    • content: 文件内容（字符串，必需）
    • branch: 分支名称（字符串，可选）
    • sha: 如果更新，则为文件 SHA（字符串，可选）

  • list_branches - 列出 GitHub 仓库中的分支

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • page: 页码（数字，可选）
    • perPage: 每页结果数（数字，可选）

  • push_files - 在单个提交中推送多个文件

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • branch: 要推送到的分支（字符串，必需）
    • files: 要推送的文件，每个文件都有路径和内容（数组，必需）
    • message: 提交消息（字符串，必需）

  • search_repositories - 搜索 GitHub 仓库

    • query: 搜索查询（字符串，必需）
    • sort: 排序字段（字符串，可选）
    • order: 排序顺序（字符串，可选）
    • page: 页码（数字，可选）
    • perPage: 每页结果数（数字，可选）

  • create_repository - 创建一个新的 GitHub 仓库

    • name: 仓库名称（字符串，必需）
    • description: 仓库描述（字符串，可选）
    • private: 仓库是否为私有（布尔值，可选）
    • autoInit: 使用 README 自动初始化（布尔值，可选）

  • get_file_contents - 获取文件或目录的内容

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • path: 文件路径（字符串，必需）
    • ref: Git 引用（字符串，可选）

  • fork_repository - Fork 一个仓库

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • organization: 目标组织名称（字符串，可选）

  • create_branch - 创建一个新分支

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • branch: 新分支名称（字符串，必需）
    • sha: 用于创建分支的 SHA（字符串，必需）

  • list_commits - 获取仓库中分支的提交列表

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • sha: 分支名称、标签或提交 SHA（字符串，可选）
    • path: 仅包含此文件路径的提交（字符串，可选）
    • page: 页码（数字，可选）
    • perPage: 每页结果数（数字，可选）

  • get_commit - 获取仓库中提交的详细信息

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • sha: 提交 SHA、分支名称或标签名称（字符串，必需）
    • page: 页码，用于提交中的文件（数字，可选）
    • perPage: 每页结果数，用于提交中的文件（数字，可选）

搜索

  • search_code - 搜索 GitHub 仓库中的代码

    • query: 搜索查询（字符串，必需）
    • sort: 排序字段（字符串，可选）
    • order: 排序顺序（字符串，可选）
    • page: 页码（数字，可选）
    • perPage: 每页结果数（数字，可选）

  • search_users - 搜索 GitHub 用户

    • query: 搜索查询（字符串，必需）
    • sort: 排序字段（字符串，可选）
    • order: 排序顺序（字符串，可选）
    • page: 页码（数字，可选）
    • perPage: 每页结果数（数字，可选）

代码扫描

  • get_code_scanning_alert - 获取代码扫描警报

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • alertNumber: 警报编号（数字，必需）

  • list_code_scanning_alerts - 列出仓库的代码扫描警报

    • owner: 仓库所有者（字符串，必需）
    • repo: 仓库名称（字符串，必需）
    • ref: Git 引用（字符串，可选）
    • state: 警报状态（字符串，可选）
    • severity: 警报严重性（字符串，可选）

资源

仓库内容

  • 获取仓库内容 检索仓库在特定路径的内容。

    • 模板: repo://{owner}/{repo}/contents{/path*}
    • 参数:
      • owner: 仓库所有者（字符串，必需）
      • repo: 仓库名称（字符串，必需）
      • path: 文件或目录路径（字符串，可选）

  • 获取特定分支的仓库内容 检索仓库在给定分支的特定路径的内容。

    • 模板: repo://{owner}/{repo}/refs/heads/{branch}/contents{/path*}
    • 参数:
      • owner: 仓库所有者（字符串，必需）
      • repo: 仓库名称（字符串，必需）
      • branch: 分支名称（字符串，必需）
      • path: 文件或目录路径（字符串，可选）

  • 获取特定提交的仓库内容 检索仓库在给定提交的特定路径的内容。

    • 模板: repo://{owner}/{repo}/sha/{sha}/contents{/path*}
    • 参数:
      • owner: 仓库所有者（字符串，必需）
      • repo: 仓库名称（字符串，必需）
      • sha: 提交 SHA（字符串，必需）
      • path: 文件或目录路径（字符串，可选）

  • 获取特定标签的仓库内容 检索仓库在给定标签的特定路径的内容。

    • 模板: repo://{owner}/{repo}/refs/tags/{tag}/contents{/path*}
    • 参数:
      • owner: 仓库所有者（字符串，必需）
      • repo: 仓库名称（字符串，必需）
      • tag: 标签名称（字符串，必需）
      • path: 文件或目录路径（字符串，可选）

  • 获取特定 Pull Request 的仓库内容 检索仓库在给定 pull request 的特定路径的内容。

    • 模板: repo://{owner}/{repo}/refs/pull/{prNumber}/head/contents{/path*}
    • 参数:
      • owner: 仓库所有者（字符串，必需）
      • repo: 仓库名称（字符串，必需）
      • prNumber: Pull request 编号（字符串，必需）
      • path: 文件或目录路径（字符串，可选）

库用法

此模块导出的 Go API 目前应被视为不稳定，并且可能会发生重大更改。 将来，我们可能会提供稳定性； 如果有任何用例可以体现其价值，请提交 issue。

许可证

本项目根据 MIT 开源许可证的条款获得许可。 有关完整条款，请参阅 MIT。

推荐服务器

Playwright MCP Server

Playwright MCP Server

一个模型上下文协议服务器，它使大型语言模型能够通过结构化的可访问性快照与网页进行交互，而无需视觉模型或屏幕截图。

官方
精选
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

一个由人工智能驱动的工具，可以从自然语言描述生成现代化的用户界面组件，并与流行的集成开发环境（IDE）集成，从而简化用户界面开发流程。

官方
精选
本地
TypeScript
MCP Package Docs Server

MCP Package Docs Server

促进大型语言模型高效访问和获取 Go、Python 和 NPM 包的结构化文档，通过多语言支持和性能优化来增强软件开发。

精选
本地
TypeScript
Claude Code MCP

Claude Code MCP

一个实现了 Claude Code 作为模型上下文协议（Model Context Protocol, MCP）服务器的方案，它可以通过标准化的 MCP 接口来使用 Claude 的软件工程能力（代码生成、编辑、审查和文件操作）。

精选
本地
JavaScript
@kazuph/mcp-taskmanager

@kazuph/mcp-taskmanager

用于任务管理的模型上下文协议服务器。它允许 Claude Desktop（或任何 MCP 客户端）在基于队列的系统中管理和执行任务。

精选
本地
JavaScript
mermaid-mcp-server

mermaid-mcp-server

一个模型上下文协议 (MCP) 服务器，用于将 Mermaid 图表转换为 PNG 图像。

精选
JavaScript
Jira-Context-MCP

Jira-Context-MCP

MCP 服务器向 AI 编码助手（如 Cursor）提供 Jira 工单信息。

精选
TypeScript
Linear MCP Server

Linear MCP Server

一个模型上下文协议（Model Context Protocol）服务器，它与 Linear 的问题跟踪系统集成，允许大型语言模型（LLM）通过自然语言交互来创建、更新、搜索和评论 Linear 问题。

精选
JavaScript
Sequential Thinking MCP Server

Sequential Thinking MCP Server

这个服务器通过将复杂问题分解为顺序步骤来促进结构化的问题解决，支持修订，并通过完整的 MCP 集成来实现多条解决方案路径。

精选
Python
Curri MCP Server

Curri MCP Server

通过管理文本笔记、提供笔记创建工具以及使用结构化提示生成摘要，从而实现与 Curri API 的交互。

官方
本地
JavaScript