Graphql Bridge

🚀 mcp4gql - GraphQL MCP 服務器

mcp4gql 是一個基於 Node.js 和 TypeScript 的服務器，實現了 Model Context Protocol (MCP)。它在 MCP 客戶端（如 Cursor）和目標 GraphQL API 之間架起了橋樑，讓客戶端能方便地與 GraphQL API 交互。

✨ 主要特性

• MCP 服務器：實現了來自 @modelcontextprotocol/sdk 的 MCP Server 類，為 MCP 通信提供基礎支持。
• 標準輸入輸出傳輸：通過標準輸入和輸出與客戶端通信，確保數據的穩定傳輸。
• GraphQL 客戶端：使用 axios 向目標 GraphQL 端點發送請求，方便快捷地與 GraphQL API 交互。
• 通用的 GraphQL 工具：為 MCP 客戶端提供以下實用工具：
  • introspectGraphQLSchema：使用 introspection 檢索目標 GraphQL API 的模式，幫助客戶端了解 API 的結構。
  • executeGraphQLOperation：執行針對目標 API 的任意 GraphQL 查詢或突變，接受 query、可選的 variables 和可選的 operationName 作為輸入，滿足多樣化的查詢需求。

📦 安裝指南

該項目無需複雜的安裝步驟，只需配置好環境變量即可使用。

配置環境變量

服務器需要以下環境變量：

📚 詳細文檔

客戶端配置

要允許像 Cursor 或 Claude Desktop 這樣的客戶端使用此服務器提供的工具，您需要配置它們運行 npx 命令。

Cursor

1. 轉到 Cursor MCP 設置（Cursor > Settings > Cursor Settings > MCP）。
2. 點擊添加新的全局 MCP 服務器。
3. 將以下內容添加到您的 Cursor MCP 配置中：

{
  "mcpServers": {
    "mcp4gql": {
      "command": "npx",
      "type": "stdio",
      "args": ["-y", "mcp4gql"],
      "env": {
        "GRAPHQL_ENDPOINT": "YOUR_GRAPHQL_ENDPOINT_URL",
        "AUTH_TOKEN": "YOUR_OPTIONAL_AUTH_TOKEN"
      }
    }
  }
}

Claude Desktop

1. 打開 Claude Desktop 設置（Claude > Settings）。
2. 轉到開發者 > 編輯配置。
3. 在配置中添加以下內容：

{
  "mcpServers": {
    "mcp4gql": {
      "command": "npx",
      "args": ["-y", "mcp4gql"],
      "env": {
        "GRAPHQL_ENDPOINT": "YOUR_GRAPHQL_ENDPOINT_URL",
        "AUTH_TOKEN": "YOUR_OPTIONAL_AUTH_TOKEN"
      }
    }
  }
}

配置完成後，MCP 客戶端應該能夠列出並調用此服務器提供的 introspectGraphQLSchema 和 executeGraphQLOperation 工具，當相關時。記得在配置中設置所需的環境變量 (GRAPHQL_ENDPOINT 和可選的 AUTH_TOKEN)，以便服務器可以連接到您的 API。

⚠️ 重要提示

請確保在配置中正確設置 GRAPHQL_ENDPOINT 和 AUTH_TOKEN 環境變量，否則服務器可能無法正常連接到目標 GraphQL API。

💡 使用建議

在使用 executeGraphQLOperation 工具時，建議提前規劃好查詢語句和變量，以提高查詢效率。同時，定期使用 introspectGraphQLSchema 工具更新 API 模式信息，確保客戶端與 API 的兼容性。