What is Mcp Graphql

mcp-graphql is a Model Context Protocol server designed to enable Large Language Models (LLMs) to interact with GraphQL APIs. It provides capabilities for schema introspection and query execution, allowing models to dynamically discover and utilize GraphQL APIs.

Use cases

mcp-graphql is useful for developers looking to integrate LLMs with GraphQL APIs, automate data retrieval, and perform dynamic queries based on the API schema. It can also be used in testing environments to validate GraphQL queries.

How to use

To use mcp-graphql, run the command with the appropriate endpoint. You can specify headers, enable mutations, and provide a local schema file if needed. For example, use ‘npx mcp-graphql --endpoint http://localhost:3000/graphql’ for basic usage.

Key features

Key features of mcp-graphql include schema introspection, query execution, support for custom headers, the ability to enable mutations, and the option to use a local GraphQL schema file.

Where to use

undefined

mcp-graphql

A Model Context Protocol server that enables LLMs to interact with GraphQL APIs. This implementation provides schema introspection and query execution capabilities, allowing models to discover and use GraphQL APIs dynamically.

Usage

Run mcp-graphql with the correct endpoint, it will automatically try to introspect your queries.

Environment Variables (Breaking change in 1.0.0)

Note: As of version 1.0.0, command line arguments have been replaced with environment variables.

Examples

# Basic usage with a local GraphQL server
ENDPOINT=http://localhost:3000/graphql npx mcp-graphql

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

# Enable mutation operations
ENDPOINT=http://localhost:3000/graphql ALLOW_MUTATIONS=true npx mcp-graphql

# Using a local schema file instead of introspection
ENDPOINT=http://localhost:3000/graphql SCHEMA=./schema.graphql npx mcp-graphql

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.

Available Tools

The server provides two main tools:

1. introspect-schema: This tool retrieves the GraphQL schema. Use this first if you don’t have access to the schema as a resource.
   This uses either the local schema file or an introspection query.

2. query-graphql: Execute GraphQL queries against the endpoint. By default, mutations are disabled unless ALLOW_MUTATIONS is set to true.

Installation

Installing via Smithery

To install GraphQL MCP Server for Claude Desktop automatically via Smithery:

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

Installing Manually

It can be manually installed to Claude:

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

Security Considerations

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

Customize for your own server

This is a very generic implementation where it allows for complete introspection and for your users to do whatever (including mutations). If you need a more specific implementation I’d suggest to just create your own MCP and lock down tool calling for clients to only input specific query fields and/or variables. You can use this as a reference.