Gh MCP Server

🚀 GitHub 倉庫 MCP 服務器

該 Model Context Protocol (MCP) 服務器允許 AI 模型訪問 GitHub 倉庫內容作為上下文。它提供了獲取文件內容、倉庫結構以及整個倉庫的工具，以便在 AI 交互中用作上下文。

🚀 快速開始

該 MCP 服務器可讓 AI 模型將 GitHub 倉庫內容作為上下文使用，提供了獲取文件內容、倉庫結構等工具，方便在 AI 交互中使用。

✨ 主要特性

• 獲取整個倉庫的內容作為上下文
• 獲取特定文件內容從一個倉庫
• 獲取倉庫結構（文件列表）
• 根據擴展名篩選文件
• 排除特定路徑
• 限制返回的文件數量

📦 安裝指南

# 克隆倉庫
git clone https://github.com/shanksxz/github-mcp.git
cd github-mcp

# 安裝依賴項
npm install

# 構建項目
npm run build

💻 使用示例

基礎用法

設置 GitHub 認證

儘管服務器可以在沒有身份驗證的情況下與公共倉庫一起使用，但未認證請求的 GitHub API 有嚴格的速率限制（每小時 60 次）。為了將速率限制提高到每小時 5000 次，請設置 GITHUB_TOKEN 環境變量：

# 創建一個名為 gh.sh 的文件並添加以下內容：
export GITHUB_TOKEN=your_github_personal_access_token
# 設置文件可執行權限
chmod +x gh.sh
# 運行文件
./gh.sh

你可以在 GitHub Developer Settings 中創建一個個人訪問令牌。

與 Cursor 使用

要將此服務器與 Cursor 結合使用，請按照以下步驟操作：

1. 打開 Cursor 設置
2. 搜索“MCP”
3. 點擊“添加新的 MCP 服務器”
4. 填寫以下信息：
   • 名稱：github-repo-context（或任何你想要的名稱）
   • 類型：命令
   • 命令：/path/to/your-local-repo-setup/gh.sh
5. 點擊“保存”
6. 通過點擊服務器名稱旁邊的切換開關來啟用服務器
7. 現在你應該能夠在此項目中使用該服務器

服務器通過 stdin/stdout 按照 MCP 協議進行通信。

高級用法

可用工具

服務器提供了以下工具：

1. get-repo-context：獲取 GitHub 倉庫中的所有文件以作為上下文

   • 參數：
     • owner：GitHub 倉庫所有者/組織名稱
     • repo：GitHub 倉庫名稱
     • maxFiles（可選）：要包含的最大文件數（默認：50）
     • fileExtensions（可選）：要包含的文件擴展名（例如，['js', 'ts', 'md']）
     • excludePaths（可選）：要排除的路徑（默認：['node_modules', 'dist', 'build']）

2. get-file-content：獲取 GitHub 倉庫中特定文件的內容

   • 參數：
     • owner：GitHub 倉庫所有者/組織名稱
     • repo：GitHub 倉庫名稱
     • path：倉庫中的文件路徑

3. get-repo-structure：獲取 GitHub 倉庫的結構

   • 參數：
     • owner：GitHub 倉庫所有者/組織名稱
     • repo：GitHub 倉庫名稱

示例

當與支持 MCP 的 AI 模型結合使用時，你可以執行類似以下命令：

獲取 tensorflow/tensorflow 倉庫的結構

AI 將會使用 get-repo-structure 工具來獲取並顯示倉庫結構。