Cline Github MCP

🚀 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。