MCP Githubcli

🚀 GitHub CLI MCP服務器

這個MCP服務器為GitHub CLI提供了簡單友好的接口，藉助MCP協議，你能夠輕鬆訪問GitHub的各項功能，極大提升操作效率。

🚀 快速開始

本MCP服務器需依賴GitHub CLI，使用前請確保已完成安裝與認證：

1. 安裝GitHub CLI (gh)

   # MacOS
   brew install gh
   
   # Ubuntu/Debian
   apt install gh
   
   # 其他系統請參考GitHub CLI官方文檔
   

2. 通過gh auth login完成GitHub認證

✨ 主要特性

• 倉庫管理：支持查看和創建倉庫，讓你對倉庫的掌控更加得心應手。
• Issue管理：可查看和創建issue，便於跟蹤項目問題。
• PR管理：能查看、創建PR，還可查看PR差異，助力代碼審查。
• Gist管理：支持查看和創建gist，方便代碼片段的分享。

📦 安裝指南

安裝GitHub CLI

根據不同的操作系統，選擇合適的安裝方式：

# MacOS
brew install gh

# Ubuntu/Debian
apt install gh

# 其他系統請參考GitHub CLI官方文檔

完成認證

通過以下命令完成GitHub認證：

gh auth login

📚 詳細文檔

參數類型說明

本服務對參數類型有以下要求：

• PR編號必須使用整數類型，例如：pr_view(123, "owner/repo")
• Issue編號必須使用整數類型，例如：issue_view(456, "owner/repo")
• PR基礎分支名稱使用字符串類型，例如：pr_create("owner/repo", "標題", "內容", "main")

所有整數參數在內部都會被自動轉換為字符串，以確保命令正確執行。

可用工具

倉庫操作

• repo_list() - 列出你擁有或參與的GitHub倉庫
• repo_view(repo) - 查看倉庫詳細信息
• repo_create(name, description, private) - 創建新倉庫

Issue操作

• issue_list(repo, state) - 列出倉庫中的issue
• issue_view(issue, repo) - 查看特定issue詳情
• issue_create(repo, title, body) - 創建新issue

PR操作

• pr_list(repo, state) - 列出倉庫中的PR
• pr_view(pr, repo) - 查看特定PR詳情
• pr_diff(pr, repo) - 查看特定PR的代碼差異
• pr_create(repo, title, body, base) - 創建新PR

Gist操作

• gist_list() - 列出你的Gist
• gist_create(files, description, public) - 創建新Gist

可用資源

• repo://{owner}/{name} - 獲取倉庫信息
• user://{username} - 獲取用戶信息

故障排除

如果遇到問題，可按以下步驟排查：

1. 確保GitHub CLI已正確安裝，可通過運行 gh --version 驗證。
2. 確保已通過 gh auth login 進行身份驗證。
3. 檢查是否有權限訪問相應的倉庫或資源。
4. 如果使用JSON格式輸出有問題，嘗試使用標準輸出格式。

💻 使用示例

基礎用法

# 查看PR差異
diff = pr_diff(2543, "qianshouapp/kyc")

# 查看倉庫
repo_info = repo_view("microsoft/vscode")

# 創建issue
issue_create("owner/repo", "標題", "這是issue的內容")

高級用法

PR差異查看

PR差異查看功能支持完整輸出所有差異內容，不會進行截斷，確保您可以查看到完整的代碼變更。

diff = pr_diff(2543, "qianshouapp/kyc")
print(diff)  # 顯示完整差異

🔧 技術細節

如果需要擴展功能，可以修改main.py文件，添加新的工具函數並註冊到MCP服務器。