MCP Github

🚀 GitHub MCP（模型上下文協議）服務器

這是一個專門為GitHub打造的MCP（Model Context Protocol）服務器。其主要價值在於支持兼容MCP的大型語言模型（LLM），像Claude這類模型就能借助此服務器與MCP服務器通信，進而通過GitHub API實現交互。

🚀 快速開始

本項目旨在搭建一個GitHub MCP服務器，支持兼容MCP的大型語言模型與GitHub API交互。下面將為您介紹項目的需求、本地設置、測試方法以及主要功能。

✨ 主要特性

MCP主要支持以下兩類功能：

工具（4個）

• create-issue：可在GitHub倉庫中創建新問題。
• get-repo-info：能夠獲取特定GitHub倉庫的信息。
• list-issues：用於列出GitHub倉庫中的問題。
• search-repos：可以搜索GitHub上的倉庫。

提示（5個）

• create-issue-description：生成GitHub問題的描述。
• create-pull-request-description：生成GitHub拉取請求的描述。
• search-repos-prompt：生成用於搜索GitHub倉庫的查詢。
• create-issue-prompt：生成創建GitHub問題的參數。
• enhance-github-response：格式化並增強原始GitHub API響應數據。

您既可以編寫自己的提示，也能在Claude Desktop中“選擇集成”選項的MCP下拉菜單裡挑選合適的提示。

📦 安裝指南

需求

• TypeScript（編程語言）
• Octokit（用於向GitHub發送API請求）
• 模型上下文協議SDK

本地設置步驟

1. 克隆倉庫。
2. 運行 npm install。
3. 根據提供的.env.example文件創建一個.env文件。
4. 要將TypeScript文件編譯為JavaScript，運行 npx tsc。
5. 最終運行項目時，運行 node build/index.js。

💻 使用示例

測試方法

您可以通過兩種方式測試您的MCP服務器：

• 使用MCP檢查工具（Inspector）
• 使用Claude Desktop

使用MCP檢查工具進行測試

# 1. 在終端中運行以下命令
npx @modelcontextprotocol/inspector node build/index.js
# 2. 打開 http://localhost:5173
# 3. 您現在可以使用MCP檢查工具並開始測試。

使用Claude Desktop進行測試

{
    "mcpServers": {
        "gh": {
            "command": "node",
            "args": ["絕對\\路徑\\到\\您的\\index.js\\文件"],
            "env": {
                "GITHUB_TOKEN": "您的GitHub個人訪問令牌"
            }
        }
    }
}

具體步驟如下：

1. 從這裡下載並安裝Claude Desktop。
2. 進入菜單欄的 文件 > 設置... > 開發者 > 編輯配置。
3. 它會打開claude_desktop_config.json文件的位置。
4. 打開該文件並在代碼編輯器中添加上述JSON內容。
5. 退出並重新打開Claude Desktop。