GitHub MCP 工具

一个用于通过 Claude Desktop 与 GitHub API 交互的 Multi-Claude Program (MCP)。

功能

• 搜索 GitHub 仓库和 issue
• 创建、更新和管理 GitHub issue 和 pull request
• 管理仓库设置和配置
• 处理仓库工作流和 actions
• 搜索用户和组织
• 管理仓库协作者和团队

安装

1. 克隆此仓库：

   git clone https://github.com/yourusername/github-mcp.git
   cd github-mcp
   

2. 创建并激活一个虚拟环境：

   # On macOS/Linux
   python -m venv venv
   source venv/bin/activate
   
   # On Windows
   python -m venv venv
   .\venv\Scripts\activate
   

3. 安装依赖：

   pip install -r requirements.txt
   

4. 在项目根目录下创建一个 .env 文件：

   touch .env
   

5. 将您的 GitHub 凭据添加到 .env 文件：

   GITHUB_TOKEN=your_personal_access_token_here
   GITHUB_USERNAME=your_github_username
   

6. 测试安装：

   # 运行所有测试
   python -m pytest
   
   # 运行特定的测试文件
   python -m pytest tests/test_search_repos.py
   

7. 启动 MCP 服务器：

   python run.py
   

环境设置

GitHub Personal Access Token

您需要一个细粒度的个人访问令牌来通过 GitHub 进行身份验证：

1. 登录到您的 GitHub 帐户
2. 转到 Settings > Developer settings > Personal access tokens > Fine-grained tokens
3. 点击 "Generate new token"
4. 配置令牌：
   • Token name: "Claude Desktop Integration"
   • Description: "Token for Claude Desktop GitHub integration"
   • Expiration: 选择合适的过期日期
   • Repository access: 选择 "All repositories" 或特定仓库
   • Permissions:
     • Repository permissions:
       • Actions: Read and write
       • Contents: Read and write
       • Issues: Read and write
       • Pull requests: Read and write
       • Repository hooks: Read and write
       • Repository settings: Read and write
     • Organization permissions (如果使用组织仓库):
       • Members: Read-only
       • Teams: Read-only
5. 点击 "Generate token" 并安全地保存生成的令牌

工具

搜索仓库

使用各种条件搜索 GitHub 仓库。

参数：

• query: 搜索查询字符串
• sort: 排序字段 (stars, forks, updated, 等.)
• order: 排序顺序 (asc 或 desc)
• max_results: 要返回的最大结果数 (默认: 10)

创建 Issue

在指定的仓库中创建一个新的 GitHub issue。

参数：

• owner: 仓库所有者
• repo: 仓库名称
• title: Issue 标题
• body: Issue 描述
• labels: 要应用的标签列表
• assignees: 受让人用户名列表

创建 Pull Request

创建一个新的 pull request。

参数：

• owner: 仓库所有者
• repo: 仓库名称
• title: PR 标题
• body: PR 描述
• head: 源分支
• base: 目标分支
• draft: 是否创建为草稿 PR

管理仓库设置

更新仓库设置和配置。

参数：

• owner: 仓库所有者
• repo: 仓库名称
• settings: 要更新的设置字典

搜索 Issues

跨仓库搜索 issue。

参数：

• query: 搜索查询字符串
• state: Issue 状态 (open, closed, all)
• sort: 排序字段
• order: 排序顺序
• max_results: 最大结果数

管理工作流

管理 GitHub Actions 工作流。

参数：

• owner: 仓库所有者
• repo: 仓库名称
• workflow_file: 工作流文件路径
• action: 要执行的操作 (enable, disable, trigger)

管理协作者

管理仓库协作者。

参数：

• owner: 仓库所有者
• repo: 仓库名称
• username: 协作者用户名
• permission: 权限级别 (pull, push, admin, maintain, triage)

使用示例

# 搜索仓库
search_repos(query="python web framework", sort="stars", max_results=5)

# 创建一个新的 issue
create_issue(
    owner="username",
    repo="repository",
    title="Bug: Login not working",
    body="Users cannot log in using the login button",
    labels=["bug", "high-priority"]
)

# 创建一个 pull request
create_pull_request(
    owner="username",
    repo="repository",
    title="Feature: Add user authentication",
    body="Implements JWT-based authentication",
    head="feature/auth",
    base="main"
)

# 搜索 issues
search_issues(query="is:open is:issue author:username", max_results=10)

# 管理仓库设置
manage_repo_settings(
    owner="username",
    repo="repository",
    settings={
        "has_issues": True,
        "has_projects": True,
        "has_wiki": True
    }
)

开发

运行测试

# 运行所有测试
python -m pytest

# 运行并生成覆盖率报告
python -m pytest --cov=src tests/

# 运行特定的测试文件
python -m pytest tests/test_search_repos.py

添加新工具

1. 在 src/tools/ 中创建一个新文件
2. 实现您的工具函数
3. 在 src/main.py 中注册该工具
4. 在 tests/ 中添加测试
5. 更新 README.md 中的文档

贡献

1. Fork 该仓库
2. 创建一个 feature 分支
3. 进行更改
4. 运行测试
5. 提交一个 pull request

许可证

MIT 许可证