Github MCP Go

🚀 GitHub MCP 服務器

本項目是一個用 Go 語言實現的 GitHub 模型上下文協議（MCP）服務器。它為大語言模型（LLMs）提供了標準接口，使其能夠與 GitHub 倉庫、問題、拉取請求等進行交互。

🚀 快速開始

設置環境變量以配置服務器：

export GITHUB_TOKEN="your_token_here"

然後運行服務器：

github-mcp-server

✨ 主要特性

• 全面的 GitHub API 訪問：涵蓋了豐富的工具，詳情見下文工具部分。
• 設置命令：專為 AI 助手自動配置設計，簡單易用。
  • --auto-approve 可預先勾選同意框。
  • --write-access 用於啟用寫入權限。
  • 能自動將二進制文件複製到穩定位置。
  • 支持更新工具 MCP 服務器配置（適用於 cline 和 claude - desktop）。
• 安全控制：
  • 默認禁用寫入權限，保障系統安全。
  • 具備細粒度的自動批准選項。

計劃中的功能

• [ ] “get_diff”
  • 比較兩個提交之間的差異。
  • ? 是否應該將此內容包含在 compare_commits 的輸出中？

📦 安裝指南

先決條件

需要配備適當權限的 GitHub 個人訪問令牌。

使用預編譯二進制文件

提供了多種平臺的預編譯二進制文件：

• Linux（amd64、arm64）
• macOS（amd64、arm64）
• Windows（amd64）

從源代碼構建

克隆倉庫後，運行以下命令進行安裝：

go install ./...

💻 使用示例

基礎用法

設置環境變量和運行服務器的示例：

export GITHUB_TOKEN="your_token_here"
github-mcp-server

高級用法

通過 --approve 選項臨時啟用寫入權限：

github-mcp-server --approve

📚 詳細文檔

自動批准選項

• 默認情況下，寫入權限處於禁用狀態。
• 可通過 --approve 選項臨時啟用寫入權限。

工具

倉庫相關工具

• search_repositories：搜索 GitHub 倉庫。
• create_repository：創建新倉庫。
• fork_repository：分叉現有倉庫。
• list_forks：列出倉庫的分叉。
• delete_repository：刪除指定倉庫。
• transfer_repository：轉移倉庫所有權。

拉取請求相關工具

• search_pull_requests：搜索特定倉庫中的拉取請求。
• create_pull_request：創建新的拉取請求。
• update_pull_request：更新現有拉取請求信息。
• merge_pull_request：合併指定的拉取請求。
• delete_pull_request：刪除指定拉取請求。

問題相關工具

• search_issues：搜索倉庫中的問題和拉取請求。
• create_issue：創建新的問題。
• update_issue：更新現有問題信息。
• close_issue：關閉指定的問題。
• reopen_issue：重新打開已關閉的問題。
• add_comment_to_issue：向問題添加評論。

分支相關工具

• list_branches：列出倉庫的所有分支。
• create_branch：創建新分支。
• delete_branch：刪除指定分支。
• protect_branch：保護指定分支（防止被推翻）。
• unprotect_branch：取消保護指定分支。

提交相關工具

• commit_file：提交文件更改。
• get_commit_diff：獲取特定提交的差異視圖。
• compare_commits：比較兩個提交或分支之間的變化。
• create_commit_comment：向特定提交添加評論。
• delete_commit_comment：刪除指定提交上的評論。

搜索相關工具

• search_code：在多個倉庫中搜索代碼片段。
• search_users：搜索 GitHub 用戶。
• search_teams：搜索 GitHub 組織或團隊。

發佈

該項目遵循語義化版本控制（SemVer）。當推送新的標籤時，會自動構建併發布到 GitHub 發佈頁面。 詳細創建新發布的說明請參閱RELEASE.md。

開發

測試

項目使用 table - driven 測試方法，並結合 go - vcr 記錄 HTTP 交互：

go test ./...

📄 許可證

該項目採用 MIT 許可證，詳情見LICENSE文件。