GitHub PR MCP Server

GitHub PR MCP Server

site icon
2025.02.17 0
TypeScriptGitHub PR管理代码审查工具开发工作流增强开发效率交流协作
GitHub PR MCP Server 是一个基于 Model Context Protocol (MCP) 构建的增强型 GitHub Pull Request 管理服务器。它扩展了基础的 @modelcontextprotocol/server-github 功能,提供了更结构化和全面的 Pull Request 工作流。
View on GitHub

Overview

基本能力

产品定位

GitHub PR MCP Server 是一个专注于增强 GitHub Pull Request 管理流程的工具,旨在提供更结构化和高效的代码审查体验。

核心功能

  • 结构化 PR 模板,包含预定义部分(概述、关键更改、代码亮点、测试详情等)
  • 丰富的媒体附件支持
  • 自动化质量检查清单
  • 高级问题链接和跟踪
  • 与现有 GitHub 工作流的无缝集成
  • 完整的基服务器兼容性(创建、列出和更新 PR)
  • 增强的 PR 创建功能(标签、审阅者、分配者管理等)

适用场景

  • 需要更结构化和标准化 Pull Request 流程的开发团队
  • 希望自动化 PR 质量检查的项目
  • 需要将媒体内容(如图片、视频)附加到 PR 中的项目
  • 需要更紧密的问题跟踪和链接的项目

工具列表

  1. create_pull_request: 创建具有增强功能的新 Pull Request
  2. list_pull_requests: 列出仓库中的 Pull Requests
  3. update_pull_request: 更新现有的 Pull Request

常见问题解答

  1. 认证错误: 验证 GitHub 令牌是否具有所需权限
  2. 构建问题: 清除构建目录并重新安装依赖
  3. 运行时错误: 检查日志并验证环境变量

使用教程

使用依赖

  • Node.js 18+
  • 具有 repo 范围的 GitHub 个人访问令牌
  • PR 模板文件 .github/pull_request_template.md

安装教程

选项1: 使用 NPX(推荐)

export GITHUB_TOKEN=your_github_personal_access_token
npx @ibraheem4/github-mcp

选项2: 本地构建

  1. 克隆仓库:
git clone https://github.com/ibraheem4/github-mcp.git
cd github-mcp
  1. 安装依赖:
npm install
  1. 构建项目:
npm run build

调试方式

  1. 启动开发服务器:
npm run dev
  1. 启用调试日志:
DEBUG=github-pr-mcp:* npm run dev
  1. 运行测试:
npm test

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。