使用说明

项目简介

MCP GitHub项目管理服务器是一个基于Model Context Protocol (MCP) 的后端服务,旨在为LLM客户端(如AI助手)提供与GitHub仓库交互的能力。它通过一系列工具,允许LLM创建、查询、更新和管理GitHub仓库中的Issues、Projects和Pull Requests,从而实现更智能化的开发流程和项目协作。

主要功能点

  • Issue管理
    • 创建新的Issue
    • 更新现有Issue的状态、标题、内容、标签、指派人、里程碑等
    • 查询仓库中的Issue列表,支持多种过滤条件(状态、标签、指派人等)
    • 获取指定Issue的详细信息
    • 为Issue添加评论
  • Project管理
    • 创建新的项目面板
    • 向项目面板添加Issue或Pull Request
    • 更新项目面板中Item的位置(列之间移动)
    • 查询项目面板中的Items列表,可按列筛选
  • Pull Request管理
    • 创建新的Pull Request
    • 更新现有Pull Request的状态、标题、内容、目标分支等
    • 查询仓库中的Pull Request列表,支持多种过滤条件(状态、源分支、目标分支等)
    • 获取指定Pull Request的详细信息
    • 合并Pull Request
    • 检查Pull Request是否已合并
    • 创建、列出和管理Pull Request的Review
    • 创建、列出和管理Pull Request的Review Comment
    • 请求和移除Pull Request的Reviewers
    • 更新Pull Request的分支

安装步骤

  1. 克隆仓库
    git clone https://github.com/Monsoft-Solutions/model-context-protocols.git
  2. 进入 'mcp-github-project-manager' 目录
    cd model-context-protocols/packages/mcp-github-project-manager
  3. 安装依赖
    npm install
    yarn install
  4. 构建项目
    npm run build
    yarn build
  5. 配置 GitHub Personal Access Token
    • 运行 setup 脚本,按照提示输入您的 GitHub Personal Access Token。
      npm run setup
      (请确保您的Token拥有 'repo', 'admin:org', 'project' 权限。)

服务器配置

在您的MCP客户端配置中,添加一个新的MCP服务器,配置信息如下:

{
    "mcpServers": {
        "github-project-manager": {
            "command": "node",
            "args": ["/path/to/model-context-protocols/packages/mcp-github-project-manager/dist/server/index.js"]
            // 将 "/path/to/model-context-protocols" 替换为实际仓库路径
        }
    }
}

基本使用方法

  1. 启动 MCP GitHub 项目管理服务器。
  2. 在您的 MCP 客户端(如 Claude, Cursor)中配置并连接到该服务器。
  3. 使用客户端提供的界面或命令,调用服务器提供的各种工具,例如 'create_issue' (创建 Issue), 'list_pull_requests' (列出 Pull Requests) 等,并根据工具的参数描述提供必要的参数信息。

信息

分类

开发者工具