MCP Graphql

🚀 mcp-graphql

一個模型上下文協議服務器，能讓大語言模型（LLM）與GraphQL API進行交互。該實現具備模式內省（introspection）和查詢執行功能，可讓模型動態發現並使用GraphQL API。

🚀 快速開始

運行mcp-graphql並指定正確的端點，它將自動嘗試進行內省（introspect）查詢。

✨ 主要特性

• 支持模式內省和查詢執行，方便模型動態發現和使用GraphQL API。
• 提供了豐富的環境變量配置，可靈活定製服務器行為。
• 提供兩個主要工具，方便檢索GraphQL模式和執行查詢。

📦 安裝指南

通過Smithery安裝

要自動通過Smithery安裝GraphQL MCP服務器以用於Claude Desktop，可執行以下命令：

npx -y @smithery/cli install mcp-graphql --client claude

手動安裝

可以手動安裝到Claude，配置如下：

{
    "mcpServers": {
        "mcp-graphql": {
            "command": "npx",
            "args": ["mcp-graphql"],
            "env": {
                "ENDPOINT": "http://localhost:3000/graphql"
            }
        }
    }
}

💻 使用示例

基礎用法

# 基本使用，與本地GraphQL服務器通信
ENDPOINT=http://localhost:3000/graphql npx mcp-graphql

高級用法

# 使用自定義頭文件
ENDPOINT=https://api.example.com/graphql HEADERS='{"Authorization":"Bearer token123"}' npx mcp-graphql

# 啟用變異操作
ENDPOINT=http://localhost:3000/graphql ALLOW_MUTATIONS=true npx mcp-graphql

# 使用本地模式文件而不是內省查詢
ENDPOINT=http://localhost:3000/graphql SCHEMA=./schema.graphql npx mcp-graphql

📚 詳細文檔

環境變量（1.0.0版本的重大變更）

⚠️ 重要提示

從版本1.0.0開始，命令行參數已替換為環境變量。

資源

• graphql-schema：服務器將GraphQL模式作為資源暴露，客戶端可以訪問。這可以是本地模式文件，也可以基於內省查詢。

可用工具

服務器提供兩個主要工具：

1. introspect-schema：此工具用於檢索GraphQL模式。如果你沒有模式資源，請先使用此工具。它會使用本地模式文件或內省查詢。
2. query-graphql：用於對端點執行GraphQL查詢。默認情況下，變異操作是禁用的，除非將ALLOW_MUTATIONS設置為true。

🔧 技術細節

此實現提供模式內省和查詢執行功能，允許模型動態發現和使用GraphQL API。運行時指定正確的端點，它將自動嘗試內省查詢。

📄 許可證

文檔未提及相關許可證信息。

🔒 安全注意事項

默認情況下，變異操作是禁用的，這是一種安全措施。請謹慎考慮在生產環境中啟用變異操作。

💡 使用建議

這是一個非常通用的實現，允許完整的內省，並且讓用戶可以執行任何操作（包括變異）。如果你需要更具體的實現，建議創建自己的MCP並限制客戶端僅調用特定的查詢字段和/或變量。此項目可作為參考。