Skip to main content
Glama

mcp4gql - GraphQL MCP Server

mcp4gql

This project is a Node.js/TypeScript server that implements the Model Context Protocol (MCP). It acts as a bridge, allowing MCP clients (like Cursor) to interact with a target GraphQL API.

Features

  • MCP Server: Implements the MCP Server class from @modelcontextprotocol/sdk.

  • Stdio Transport: Communicates with clients via standard input/output.

  • GraphQL Client: Uses axios to send requests to the configured GraphQL endpoint.

  • Generic GraphQL Tools: Exposes the following tools to MCP clients:

    • introspectGraphQLSchema: Fetches the target GraphQL API schema using introspection.

    • executeGraphQLOperation: Executes arbitrary GraphQL queries or mutations against the target API, taking query, optional variables, and optional operationName as input.

Related MCP server: mcp-graphql

Configuration

The server requires the following environment variables:

  • GRAPHQL_ENDPOINT: The URL of the target GraphQL API.

  • AUTH_TOKEN: A bearer token for an optional Authorization: Bearer <token> header for authenticating with the GraphQL API.

Client Configuration

To allow clients like Cursor or Claude Desktop to use the tools provided by this server, you need to configure them to run the npx command.

Cursor

  1. Go to Cursor MCP Settings (Cursor > Settings > Cursor Settings > MCP)

  2. Go to + Add 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 Config.

  3. Add to the config:

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

Once configured, the MCP client 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 optionally AUTH_TOKEN) in the configuration so the server can connect to your API.

Available Tools

2 tools
executeGraphQLOperationA

Executes an arbitrary GraphQL query or mutation against the target API. Use introspectGraphQLSchema first to understand the available operations.

ParametersJSON Schema
NameRequiredDescriptionDefault
queryYesThe GraphQL query string to execute.
variablesNoAn optional object containing variables for the query.
operationNameNoAn optional name for the operation, if the query contains multiple operations.

TDQS

A3.9/5.0
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden of behavioral disclosure. While it mentions executing 'query or mutation,' it lacks critical details such as authentication requirements, rate limits, error handling, or whether it's read-only or destructive. This is a significant gap for a tool that can perform mutations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is highly concise and front-loaded, consisting of only two sentences. The first sentence states the core purpose, and the second provides essential usage guidance. Every sentence earns its place without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (executing arbitrary GraphQL operations with potential mutations) and lack of annotations and output schema, the description is incomplete. It covers purpose and usage guidelines well but fails to address behavioral aspects like safety, permissions, or response format, which are crucial for such a flexible tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 100%, so the schema already documents all three parameters (query, variables, operationName) with clear descriptions. The description does not add any parameter-specific details beyond what the schema provides, which aligns with the baseline score of 3 when schema coverage is high.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Executes an arbitrary GraphQL query or mutation against the target API.' It specifies the verb ('executes') and resource ('GraphQL query or mutation'), and distinguishes it from the sibling tool 'introspectGraphQLSchema' by mentioning it as a prerequisite for understanding available operations.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool: 'Use introspectGraphQLSchema first to understand the available operations.' This clearly indicates a prerequisite and distinguishes it from the sibling tool, offering a specific alternative for schema exploration.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

introspectGraphQLSchemaB

Fetches the schema of the target GraphQL API using introspection. Returns the schema in JSON format.

ParametersJSON Schema
NameRequiredDescriptionDefault

No parameters

TDQS

B3.4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden. It discloses the tool fetches schema via introspection and returns JSON, which is useful behavioral context. However, it lacks details on permissions, rate limits, error handling, or whether it's read-only/destructive, leaving gaps for a mutation-sensitive context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence that front-loads key information (fetches schema, uses introspection, returns JSON) with no wasted words. It's appropriately sized for a simple tool with no parameters.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's simplicity (0 parameters, no output schema, no annotations), the description is adequate but minimal. It explains what the tool does and the return format, but lacks context on behavioral traits like safety or performance, which could be important for an API introspection tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description appropriately doesn't discuss parameters, focusing on the tool's purpose instead, which aligns with the baseline for zero parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('fetches') and resource ('schema of the target GraphQL API'), specifying it uses introspection and returns JSON format. It distinguishes from the sibling 'executeGraphQLOperation' by focusing on schema retrieval rather than operation execution, though it doesn't explicitly name the sibling for differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No explicit guidance on when to use this tool versus alternatives is provided. The description implies usage for schema introspection, but it doesn't mention prerequisites, when not to use it, or reference the sibling tool for operational queries.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 2 tool updates
    • First observedexecuteGraphQLOperation
    • First observedintrospectGraphQLSchema

TDQS

A3.6/5.0

Scored across 2 tools

Disambiguation5/5

The two tools have clearly distinct purposes: introspectGraphQLSchema fetches the schema, while executeGraphQLOperation executes queries/mutations. There is no overlap or ambiguity between them, making it easy for an agent to select the correct tool.

Naming Consistency4/5

Both tools follow a verb_noun pattern (introspectGraphQLSchema, executeGraphQLOperation), but they use camelCase instead of snake_case. This is a minor deviation from a common convention, but the pattern is consistent and readable across the set.

Tool Count2/5

With only 2 tools, the server feels thin for a GraphQL client purpose. While the tools cover introspection and execution, typical GraphQL interactions might benefit from additional utilities like schema validation or query building, making this count borderline too few.

Completeness3/5

The tools cover core GraphQL operations (introspection and execution), but there are notable gaps. For example, there are no tools for schema exploration, query validation, or handling subscriptions, which could limit an agent's ability to fully interact with a GraphQL API.

Maintenance

ActivityInactive
ResponsivenessNo issues

Related MCP Connectors

  • The Grafbase MCP server sits in front of a GraphQL API and exposes an MCP protocol-compliant interface that allows AI agents and LLMs to explore and query GraphQL APIs using natural language. It provides tools to search schemas, introspect types and fields, and execute GraphQL queries while minimizing context bloat by returning only relevant schema subsets, with built-in support for authentication, authorization, and configurable access control.

  • Model Context Protocol server for the Apideck Unified API. Connect any MCP-compatible agent framework to 100+ accounting systems, HRIS platforms, file storage providers, and more through one integration. More information https://www.apideck.com/mcp-server

  • Hosted Amazon Seller and Vendor MCP server for Claude, ChatGPT, Cursor, Codex, Gemini, Copilot.

  • An MCP server that provides an API to LLMs to manage their JumpCloud resources.

Related MCP Servers

  • A
    license
    Not graded
    quality
    F
    maintenance
    A MCP server that exposes GraphQL schema information to LLMs like Claude. This server allows an LLM to explore and understand large GraphQL schemas through a set of specialized tools, without needing to load the whole schema into the context
    54 npm
    47
    MIT
  • A
    license
    Not graded
    quality
    D
    maintenance
    A Model Context Protocol server that enables LLMs to interact with GraphQL APIs by providing schema introspection and query execution capabilities.
    1,191 npm
    3
    MIT
  • F
    license
    Not graded
    quality
    D
    maintenance
    This MCP server exposes approved GraphQL operations from an Apollo GraphQL API as AI-accessible tools. It sits between MCP clients and the GraphQL API, translating tool calls into GraphQL queries and returning results in MCP format.
    -