GraphQL MCP server

Provides a GraphQL interface for querying and manipulating structured data from diverse GraphQL sources.
Back to servers
Provider
Boris de Jong
Release date
Dec 21, 2024
Language
TypeScript
Stats
122 stars

This GraphQL MCP server enables Large Language Models to interact with GraphQL APIs by providing schema introspection and query execution capabilities. It allows models to dynamically discover and use GraphQL APIs without requiring hardcoded schema information.

Installation

Installing via npm

You can run the MCP server directly using npx:

npx mcp-graphql

Installing via Smithery

For Claude Desktop users, you can install it automatically via Smithery:

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

Manual Installation for Claude

Add this configuration to your Claude settings:

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

Configuration

The server is configured using environment variables:

Environment Variable Description Default
ENDPOINT GraphQL endpoint URL http://localhost:4000/graphql
HEADERS JSON string containing headers for requests {}
ALLOW_MUTATIONS Enable mutation operations (disabled by default) false
NAME Name of the MCP server mcp-graphql
SCHEMA Path to a local GraphQL schema file (optional) -

Usage Examples

Basic Usage

Connect to a local GraphQL server:

ENDPOINT=http://localhost:3000/graphql npx mcp-graphql

Using with Authentication

Add custom headers for authentication:

ENDPOINT=https://api.example.com/graphql HEADERS='{"Authorization":"Bearer token123"}' npx mcp-graphql

Enabling Mutations

Allow the server to execute mutation operations (use with caution):

ENDPOINT=http://localhost:3000/graphql ALLOW_MUTATIONS=true npx mcp-graphql

Using a Local Schema File

If you have a local schema file, you can use it instead of relying on introspection:

ENDPOINT=http://localhost:3000/graphql SCHEMA=./schema.graphql npx mcp-graphql

Available Tools

The server provides two main tools for LLMs to use:

introspect-schema

This tool retrieves the GraphQL schema. Use this first if you don't have access to the schema as a resource.

query-graphql

Execute GraphQL queries against the endpoint. By default, mutations are disabled unless ALLOW_MUTATIONS is set to true.

Resources

  • graphql-schema: The server exposes the GraphQL schema as a resource that clients can access. This is either the local schema file or based on an introspection query.

Security Considerations

Mutations are disabled by default to prevent an LLM from modifying your database or service data. Consider carefully before enabling mutations in production environments.

How to add this MCP server to Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > MCP and click "Add new global MCP server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.

Want to 10x your AI skills?

Get a free account and learn to code + market your apps using AI (with or without vibes!).

Nah, maybe later