项目介绍
技术文档摘要
GitHub MCP 服务器
GitHub API 的 MCP 服务器，支持文件操作、仓库管理、搜索功能等。
功能
- 自动分支创建：在创建或更新文件或推送更改时，如果不存在，则会自动创建分支
- 全面错误处理：常见问题的清晰错误消息
- 保留 Git 历史记录：操作保持正确的 Git 历史记录，无需强制推送
- 批量操作：支持单个文件和多个文件的操作
- 高级搜索：支持代码、问题/拉取请求和用户的搜索
工具
-
create_or_update_file- 在仓库中创建或更新单个文件
- 输入参数：
owner（字符串）：仓库所有者（用户名或组织）repo（字符串）：仓库名称path（字符串）：创建或更新文件的路径content（字符串）：文件内容message（字符串）：提交信息branch（字符串）：要创建或更新文件的分支sha（可选字符串）：被替换文件的 SHA（用于更新）
- 返回值：文件内容和提交详情
-
push_files- 在单次提交中推送多个文件
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称branch（字符串）：要推送的分支files（数组）：要推送的文件，每个文件包含path和contentmessage（字符串）：提交信息
- 返回值：更新后的分支引用
-
search_repositories- 搜索 GitHub 仓库
- 输入参数：
query（字符串）：搜索查询page（可选数字）：分页的页面编号perPage（可选数字）：每页结果数（最大 100）
- 返回值：仓库搜索结果
-
create_repository- 创建新的 GitHub 仓库
- 输入参数：
name（字符串）：仓库名称description（可选字符串）：仓库描述private（可选布尔值）：是否为私有仓库autoInit（可选布尔值）：初始化时包含 README
- 返回值：创建的仓库详情
-
get_file_contents- 获取文件或目录的内容
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称path（字符串）：文件/目录路径branch（可选字符串）：获取内容的分支
- 返回值：文件/目录内容
-
create_issue- 创建新问题
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称title（字符串）：问题标题body（可选字符串）：问题描述assignees（可选字符串数组）：分配给的用户名labels（可选字符串数组）：添加的标签milestone（可选数字）：里程碑编号
- 返回值：创建的问题详情
-
create_pull_request- 创建新的拉取请求
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称title（字符串）：拉取请求标题body（可选字符串）：拉取请求描述head（字符串）：包含更改的分支base（字符串）：要合并到的分支draft（可选布尔值）：作为草稿拉取请求创建maintainer_can_modify（可选布尔值）：允许维护者编辑
- 返回值：创建的拉取请求详情
-
fork_repository- 分叉仓库
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称organization（可选字符串）：分叉到的组织
- 返回值：分叉的仓库详情
-
create_branch- 创建新的分支
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称branch（字符串）：新分支名称from_branch（可选字符串）：源分支（默认为仓库默认分支）
- 返回值：创建的分支引用
-
list_issues- 列出并过滤仓库中的问题
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称state（可选字符串）：按状态过滤（'open', 'closed', 'all'）labels（可选字符串数组）：按标签过滤sort（可选字符串）：排序字段（'created', 'updated', 'comments'）direction（可选字符串）：排序方向（'asc', 'desc'）since（可选字符串）：按日期过滤（ISO 8601 时间戳）page（可选数字）：页面编号per_page（可选数字）：每页结果数
- 返回值：问题详情数组
-
update_issue- 更新现有问题
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称issue_number（数字）：要更新的问题编号title（可选字符串）：新标题body（可选字符串）：新描述state（可选字符串）：新状态（'open' 或 'closed'）labels（可选字符串数组）：新标签assignees（可选字符串数组）：新分配人milestone（可选数字）：新里程碑编号
- 返回值：更新的问题详情
-
add_issue_comment- 向问题添加评论
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称issue_number（数字）：要评论的问题编号body（字符串）：评论文本
- 返回值：创建的评论详情
-
search_code- 跨 GitHub 仓库搜索代码
- 输入参数：
q（字符串）：使用 GitHub 代码搜索语法的搜索查询sort（可选字符串）：排序字段（仅 'indexed'）order（可选字符串）：排序顺序（'asc' 或 'desc'）per_page（可选数字）：每页结果数（最大 100）page（可选数字）：页面编号
- 返回值：带有仓库上下文的代码搜索结果
-
search_issues- 搜索问题和拉取请求
- 输入参数：
q（字符串）：使用 GitHub 问题搜索语法的搜索查询sort（可选字符串）：排序字段（comments, reactions, created 等）order（可选字符串）：排序顺序（'asc' 或 'desc'）per_page（可选数字）：每页结果数（最大 100）page（可选数字）：页面编号
- 返回值：问题和拉取请求搜索结果
-
search_users- 搜索 GitHub 用户
- 输入参数：
q（字符串）：使用 GitHub 用户搜索语法的搜索查询sort（可选字符串）：排序字段（followers, repositories, joined）order（可选字符串）：排序顺序（'asc' 或 'desc'）per_page（可选数字）：每页结果数（最大 100）page（可选数字）：页面编号
- 返回值：用户搜索结果
-
list_commits
- 获取仓库中分支的提交列表
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称page（可选字符串）：页面编号per_page（可选字符串）：每页记录数sha（可选字符串）：分支名称
- 返回值：提交列表
get_issue
- 获取仓库内问题的内容
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称issue_number（数字）：要检索的问题编号
- 返回值：GitHub 问题对象及详情
get_pull_request
- 获取特定拉取请求的详细信息
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称pull_number（数字）：拉取请求编号
- 返回值：包括差异和审核状态的拉取请求详情
list_pull_requests
- 列出并过滤仓库中的拉取请求
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称state（可选字符串）：按状态过滤（'open', 'closed', 'all'）head（可选字符串）：按头用户/组织和分支过滤base（可选字符串）：按基础分支过滤sort（可选字符串）：排序字段（'created', 'updated', 'popularity', 'long-running'）direction（可选字符串）：排序方向（'asc', 'desc'）per_page（可选数字）：每页结果数（最大 100）page（可选数字）：页面编号
- 返回值：拉取请求详情数组
create_pull_request_review
- 在拉取请求上创建审核
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称pull_number（数字）：拉取请求编号body（字符串）：审核评论文本event（字符串）：审核动作（'APPROVE', 'REQUEST_CHANGES', 'COMMENT'）commit_id（可选字符串）：要审核的提交的 SHAcomments（可选数组）：行特定评论，每个评论包含：path（字符串）：文件路径position（数字）：差异中的行位置body（字符串）：评论文本
- 返回值：创建的审核详情
merge_pull_request
- 合并拉取请求
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称pull_number（数字）：拉取请求编号commit_title（可选字符串）：合并提交的标题commit_message（可选字符串）：合并提交的额外细节merge_method（可选字符串）：合并方法（'merge', 'squash', 'rebase'）
- 返回值：合并结果详情
get_pull_request_files
- 获取拉取请求中更改的文件列表
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称pull_number（数字）：拉取请求编号
- 返回值：带有补丁和状态详情的更改文件数组
get_pull_request_status
- 获取拉取请求的所有状态检查的综合状态
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称pull_number（数字）：拉取请求编号
- 返回值：综合状态检查结果和个别检查详情
update_pull_request_branch
- 使用基础分支的最新更改更新拉取请求分支（相当于 GitHub 的“更新分支”按钮）
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称pull_number（数字）：拉取请求编号expected_head_sha（可选字符串）：拉取请求 HEAD 引用的预期 SHA
- 返回值：当分支更新成功时的消息
get_pull_request_comments
- 获取拉取请求的审核评论
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称pull_number（数字）：拉取请求编号
- 返回值：带有评论文本、作者和差异中位置的拉取请求审核评论数组
get_pull_request_reviews
- 获取拉取请求的审核
- 输入参数：
owner（字符串）：仓库所有者repo（字符串）：仓库名称pull_number（数字）：拉取请求编号
- 返回值：带有审核状态（APPROVED, CHANGES_REQUESTED 等）、审核员和审核正文的拉取请求审核数组
搜索查询语法
代码搜索
language:javascript：按编程语言搜索repo:owner/name：在特定仓库中搜索path:app/src：在特定路径中搜索extension:js：按文件扩展名搜索- 示例：
q: "import express" language:typescript path:src/
问题搜索
is:issue或is:pr：按类型过滤is:open或is:closed：按状态过滤label:bug：按标签搜索author:username：按作者搜索- 示例：
q: "memory leak" is:issue is:open label:bug
用户搜索
type:user或type:org：按账户类型过滤followers:>1000：按关注者数量过滤location:London：按地点搜索- 示例：
q: "fullstack developer" location:London followers:>100
关于详细的搜索语法，请参阅 GitHub 的搜索文档。
配置
个人访问令牌
创建一个 GitHub 个人访问令牌，具有适当的权限：
- 转到 个人访问令牌（在 GitHub 设置 > 开发者设置中）
- 选择您希望此令牌访问哪些仓库（公共、全部或选择）
- 创建具有
repo范围的令牌（“完全控制私有仓库”）- 如果仅与公共仓库一起工作，可以选择仅
public_repo范围
- 如果仅与公共仓库一起工作，可以选择仅
- 复制生成的令牌
与 Claude Desktop 结合使用
要在 Claude Desktop 中使用此工具，请在您的 claude_desktop_config.json 中添加以下内容：
Docker
{
"mcpServers": {
"github": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"GITHUB_TOKEN",
"mcp/github"
],
"env": {
"GITHUB_TOKEN": "<YOUR_TOKEN>"
}
}
}
}
NPX
{
"mcpServers": {
"github": {
"command": "npx",
"args": [
"-y",
"@modelcontextprotocol/server-github"
],
"env": {
"GITHUB_TOKEN": "<YOUR_TOKEN>"
}
}
}
}
构建
Docker 构建：
docker build -t mcp/github -f src/github/Dockerfile .
许可证
此 MCP 服务器根据 MIT 许可证发布。这意味着您可以自由地使用、修改和分发该软件，但需遵守 MIT 许可证的条款和条件。更多详情，请参阅项目存储库中的 LICENSE 文件。