GitHub MCP Server

GitHub MCP Server

site icon
2025.01.07 1
TypeScript代码管理版本控制问题跟踪协作开发开发效率
GitHub MCP Server 是一个用于GitHub API的服务,提供文件操作、仓库管理、搜索功能等。它支持自动分支创建、全面的错误处理、Git历史保留、批量操作和高级搜索等功能。适用于开发者在GitHub上进行代码管理、问题跟踪和协作开发。
View on GitHub

Overview

基本能力

产品定位

GitHub MCP Server 是一个用于GitHub API的服务,提供文件操作、仓库管理、搜索功能等,旨在帮助开发者更高效地管理GitHub上的项目和代码。

核心功能

  • 自动分支创建:在创建/更新文件或推送更改时,自动创建不存在的分支。
  • 全面的错误处理:提供清晰的错误消息,帮助开发者快速定位问题。
  • Git历史保留:操作保持正确的Git历史,无需强制推送。
  • 批量操作:支持单文件和多文件操作。
  • 高级搜索:支持搜索代码、问题/拉取请求和用户。

适用场景

  • 代码管理和版本控制
  • 问题跟踪和协作开发
  • 代码搜索和用户搜索
  • 自动化仓库管理

工具列表

  1. create_or_update_file:创建或更新仓库中的单个文件。
  2. push_files:在单个提交中推送多个文件。
  3. search_repositories:搜索GitHub仓库。
  4. create_repository:创建新的GitHub仓库。
  5. get_file_contents:获取文件或目录的内容。
  6. create_issue:创建新问题。
  7. create_pull_request:创建新的拉取请求。
  8. fork_repository:分叉仓库。
  9. create_branch:创建新分支。
  10. list_issues:列出和过滤仓库问题。
  11. update_issue:更新现有问题。
  12. add_issue_comment:向问题添加评论。
  13. search_code:跨GitHub仓库搜索代码。
  14. search_issues:搜索问题和拉取请求。
  15. search_users:搜索GitHub用户。
  16. list_commits:获取仓库分支的提交列表。
  17. get_issue:获取仓库中问题的内容。
  18. get_issue_comments:获取问题或拉取请求的评论。

常见问题解答

  • 如何创建个人访问令牌
  • 转到个人访问令牌
  • 选择要访问的仓库(公共、所有或选择)。
  • 创建具有repo范围的令牌("对私有仓库的完全控制")。
  • 复制生成的令牌。

使用教程

使用依赖

  • 需要GitHub个人访问令牌。

安装教程

  1. 创建GitHub个人访问令牌。
  2. claude_desktop_config.json中添加以下配置:
{
  "mcpServers": {
    "github": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-github"
      ],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

调试方式

  • 使用提供的工具和API进行调试,确保令牌和配置正确。

许可证

该项目遵循 MIT 开源许可条款。