🚀 GitHub PR 机器人服务器（GitHub PR-MCP）

GitHub PR 机器人服务器（GitHub PR-MCP）可助力开发者高效管理 GitHub 拉取请求。它提供便捷的安装与使用方式，支持自定义配置，能有效集成 GitHub PR 功能。

🚀 快速开始

你可以选择快速安装，也能通过克隆仓库构建项目来使用 GitHub PR 机器人服务器。

📦 安装指南

快速安装

npm install github-pr-mcp

构建项目

1. 克隆仓库：

   git clone https://github.com/your-username/github-pr-mcp.git
   cd github-pr-mcp
   

2. 安装依赖：

   npm install
   

3. 启动开发服务器：

   npm run dev
   

💻 使用示例

基础用法

初始化配置文件

github-pr-mcp init

运行服务器

npm start

高级用法

常规配置

环境变量

设置以下环境变量以自定义行为：

• GITHUB_TOKEN: 必填，用于身份验证的 GitHub 个人访问令牌。
• PORT: 可选，默认为 3000，指定服务器运行端口。

集成 GitHub PR 功能

创建拉取请求

const server = new GithubPRServer();
server.createPullRequest({
  owner: 'your-org',
  repo: 'your-repo',
  title: '新功能实现',
  head: 'feature-branch',
  base: 'main',
  // 其他可选参数...
});

🔧 技术细节

开发

目录结构

src/
├── index.ts          # 主 MCP 服务器实现
├── api/             # API 路由和中间件
├── config/          # 配置文件
└── types/           # TypeScript 类型定义

添加新功能

1. 在 src/types/index.ts 中定义类型。
2. 更新主服务器实现，在 src/index.ts 中添加新功能。
3. 在 GitHubServer 类中添加新的工具处理程序。
4. 更新文档。

开发环境配置

先决条件

• Node.js 18+
• npm 或 yarn
• Git
• 带个人访问令牌的 GitHub 账户

本地开发

1. 安装依赖：

   npm install
   

2. 启动开发服务器：

   npm run dev
   

3. 运行测试：

   npm test
   

测试

• 单元测试：npm run test:unit
• 集成测试：npm run test:integration
• 测试覆盖率：npm run test:coverage

故障排除

常见问题

1. 身份验证错误

   • 确认令牌具有所需权限。
   • 检查令牌是否正确设置在环境中。
   • 查看令牌的有效期。

2. 构建问题

   • 清除构建目录：rm -rf build/
   • 重新安装依赖：npm install

3. 服务器启动失败

   • 确认端口未被占用。
   • 检查环境变量是否正确设置。

🤝 贡献指南

提交代码

遵循 CONTRIBUTING.md 文件中的指导进行贡献。

创建拉取请求

1. 叉仓库。
2. 创建功能分支。
3. 提交更改并创建拉取请求到主分支。

📄 许可证

项目在 LICENSE 下开源。

📞 联系方式

有问题或建议，请联系 your.email@example.com。