Graphql Bridge

🚀 mcp4gql - GraphQL MCP Server

This project is a Node.js and TypeScript-based server that implements the Model Context Protocol (MCP). It serves as a bridge between MCP clients (such as Cursor) and the target GraphQL API.

🚀 Quick Start

This server is a bridge between MCP clients and GraphQL APIs. It enables clients to interact with GraphQL APIs through MCP.

✨ Features

• MCP Server: Implements the MCP Server class from @modelcontextprotocol/sdk.
• Standard Input/Output Transport: Communicates with clients via standard input and output.
• GraphQL Client: Sends requests to the target GraphQL endpoint using axios.
• Generic GraphQL Tools: Provides the following tools to MCP clients:
  • introspectGraphQLSchema: Retrieves the schema of the target GraphQL API using introspection.
  • executeGraphQLOperation: Executes arbitrary GraphQL queries or mutations against the target API, accepting query, optional variables, and optional operationName as inputs.

📦 Installation

The server requires the following environment variables:

• GRAPHQL_ENDPOINT: The URL of the target GraphQL API.
• AUTH_TOKEN: An optional bearer token for configuring an optional Authorization: Bearer <token> request header to authenticate with the GraphQL API.

💻 Usage Examples

Cursor

1. Go to Cursor MCP settings (Cursor > Settings > Cursor Settings > MCP).
2. Click to add a new global MCP server.
3. Add the following to your Cursor MCP configuration:

{
  "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. Open Claude Desktop settings (Claude > Settings).
2. Go to Developer > Edit Configuration.
3. Add the following to the configuration:

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

After configuration, MCP clients should be able to list and call the introspectGraphQLSchema and executeGraphQLOperation tools provided by this server when relevant. Remember to set the required environment variables (GRAPHQL_ENDPOINT and optional AUTH_TOKEN) in the configuration so that the server can connect to your API.