Github GraphQL API

🚀 GitHub GraphQL API MCP

一個基於MCP（模型控制協議）的工具，用於查詢和使用GitHub GraphQL API。此項目提供了一個服務器，允許您通過MCP客戶端工具（如Claude AI）探索GitHub GraphQL模式並執行GraphQL查詢。

🚀 快速開始

GitHub GraphQL API MCP是一個用於與GitHub GraphQL API交互的工具集。它提供了一個服務器，允許您通過MCP客戶端工具（如Claude AI）探索GitHub GraphQL模式並執行GraphQL查詢。

在使用此項目之前，請確保您有一個有效的GitHub賬戶，並且已經生成了具有適當權限的訪問令牌。將您的訪問令牌安全地存儲在.env文件中，避免將其提交到版本控制系統。同時，確保您的查詢符合GitHub API的使用限制。

下載代碼

您可以從以下鏈接下載此項目的源代碼：

• GitHub倉庫：GitHub GraphQL API MCP 倉庫地址

安裝依賴項

進入項目目錄後，安裝所需的Python包：

pip install -r requirements.txt

啟動服務器

運行以下命令啟動MCP服務器：

python run_server.py --directory <項目路徑>

✨ 主要特性

• 簡單易用：提供直觀的命令行接口和工具集，便於快速上手。
• 高度靈活：支持自定義GraphQL查詢，滿足個性化需求。
• 文檔豐富：內置詳細的模式文檔，幫助開發者快速理解GitHub GraphQL API。

📚 詳細文檔

項目介紹

GitHub GraphQL API MCP提供了以下功能：

1. 打印類型字段：查詢GitHub GraphQL模式中根類型的字段。
2. 獲取根類型文檔：獲取GitHub GraphQL模式中根類型（Query/Mutation）的文檔。
3. 獲取特定類型文檔：查詢GitHub GraphQL模式中的特定類型文檔。
4. 調用GraphQL API：執行GitHub GraphQL API查詢。

為什麼使用GitHub GraphQL API

功能優勢

• 高效的數據查詢：通過GraphQL，您可以一次性獲取所需數據，減少請求次數和數據冗餘。
• 靈活的查詢語法：支持自定義查詢結構，滿足各種開發需求。
• 強大的模式文檔：GitHub提供了詳細的GraphQL模式文檔，方便開發者理解和使用API。

使用場景

• 項目管理：通過GraphQL查詢倉庫信息、用戶信息等，實現高效的項目管理和協作。
• 數據集成：將GitHub的數據與其他系統集成，例如CI/CD流程或團隊內部工具。
• 自動化腳本：編寫自動化腳本來執行重複性任務，如獲取最新提交、創建問題等。

應用場景

示例截圖

在此示例中，用戶使用Claude調用GitHub GraphQL API MCP：

可用工具

1. print_type_field：查詢GitHub GraphQL模式中根類型的字段。
2. graphql_schema_root_type：獲取根類型（Query/Mutation）的文檔。
3. graphql_schema_type：查詢特定類型的文檔。
4. call_github_graphql：執行GitHub GraphQL API查詢。

示例用法

基礎用法

• 查詢根類型文檔：

Use the graphql_schema_root_type tool, parameter type_name="QUERY"

• 查詢字段信息：

Use the print_type_field tool, parameters type_name="QUERY", type_fields_name="repository"

高級用法

• 執行GraphQL查詢：

Use the call_github_graphql tool, parameter:
graphql="""
query {
  viewer {
    login
    name
  }
}
"""

⚠️ 注意事項

⚠️ 重要提示

• 確保您的GitHub訪問令牌具有適當的權限。
• 將.env文件妥善保管，避免洩露。
• 遵守GitHub API的使用限制。

📄 許可證

此項目採用MIT License，這是一種非常寬鬆的許可證，允許用戶自由使用、修改、分發和商業化此軟件，只要保留版權聲明和許可聲明。 詳細條款請參閱MIT License。