GitHub API交互工具

GitHub MCP Server是一个提供与GitHub API交互的工具,使AI助手能够查询仓库、拉取请求、问题、提交、用户等信息。

  • by grysonbaltazar
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 grysonbaltazar/github-mcp

使用说明

GitHub MCP服务器

一个MCP(模型上下文协议)服务器,提供与GitHub API交互的工具。该服务器使AI助手能够查询存储库、拉取请求、问题、提交、用户等。

特性

  • 🔍 搜索存储库和用户
  • 📦 获取存储库信息
  • 🔀 列出并查看拉取请求
  • 🐛 列出并查看问题
  • 📝 查看提交并比较分支
  • 👤 获取用户信息
  • 📄 从存储库读取文件内容
  • 🏷️ 列表发布和分支

先决条件

  • Node.js(v18或更高版本)
  • GitHub个人访问令牌

安装

  1. 克隆此存储库:
git clone https://github.com/grysonbaltazar/github-mcp.git
cd github-mcp
  1. 安装依赖项:
npm install
  1. 构建TypeScript代码:
npm run build

配置

获取GitHub代币

  1. 首选 GitHub设置→ 开发人员设置→ 个人访问令牌
  2. 点击“生成新令牌(经典)”
  3. 为其命名(例如,“MCP服务器”)
  4. 选择范围:
    • repo -完全控制私有存储库
    • read:user -读取用户配置文件数据
    • read:org -阅读组织和团队成员(可选)
  5. 生成并复制令牌

适用于克劳德桌面

编辑 ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "github": {
      "command": "node",
      "args": ["/path/to/github-mcp/build/index.js"],
      "env": {
        "GITHUB_TOKEN": "your_github_token_here"
      }
    }
  }
}

对于光标

编辑 ~/.cursor/mcp_config.json:

{
  "mcpServers": {
    "github": {
      "command": "node",
      "args": ["/path/to/github-mcp/build/index.js"],
      "env": {
        "GITHUB_TOKEN": "your_github_token_here"
      }
    }
  }
}

用法

配置后,MCP服务器提供以下工具:

  • get_repository -获取有关存储库的详细信息
  • list_user_repos -列出用户或组织的存储库
  • search_repositories -在GitHub上搜索存储库
  • get_pull_request -获取特定拉取请求的详细信息
  • list_pull_requests -列出存储库的拉取请求
  • get_pr_files -获取拉取请求中更改的文件列表
  • get_pr_comments -获取对拉取请求的评论
  • get_commit -获取特定提交的详细信息
  • list_commits -列出存储库中的提交
  • compare_commits -比较两个提交或分支
  • get_issue -获取特定问题的详细信息
  • list_issues -列出存储库的问题
  • get_issue_comments -获取对某个问题的评论
  • list_branches -列出存储库中的分支
  • get_branch -获取特定分支机构的详细信息
  • get_user -获取GitHub用户的信息
  • search_users -在GitHub上搜索用户
  • get_file_contents -获取存储库中文件的内容
  • list_releases -列出存储库的版本
  • get_latest_release -获取存储库的最新版本

发展

MCP检验员测试

npx @modelcontextprotocol/inspector node build/index.js

这将打开一个web界面,您可以在其中交互式地测试所有工具。

观看模式

npm run watch

许可证

麻省理工学院

贡献

欢迎投稿!请随时提交拉取请求。