Graphql Api Integration

🚀 mcp-graphql

An MCP (Model Context Protocol) server that enables Large Language Models (LLMs) to interact with GraphQL APIs. This implementation offers schema introspection and query execution capabilities, allowing models to dynamically discover and utilize GraphQL APIs.

🚀 Quick Start

When using the mcp-graphql command, specify the correct endpoint, and it will automatically attempt an introspection query.

Command-line Arguments

💻 Usage Examples

Basic Usage

# Basic usage, communicate with a local GraphQL server
npx mcp-graphql --endpoint http://localhost:3000/graphql

Using Custom Headers

# Use custom headers
npx mcp-graphql --endpoint https://api.example.com/graphql --headers '{"Authorization":"Bearer token123"}'

Enabling Mutation Operations

# Enable mutation operations
npx mcp-graphql --endpoint http://localhost:3000/graphql --enable-mutations

Using a Local Schema File

# Use a local schema file instead of an introspection query
npx mcp-graphql --endpoint http://localhost:3000/graphql --schema ./schema.graphql

✨ Features

The server provides two main features:

1. introspect-schema: This tool retrieves the GraphQL schema. Use it first if you don't have access to the schema resources. It either uses a local schema file or an introspection query.

2. query-graphql: Execute GraphQL queries against the endpoint. Mutation operations are disabled by default unless the --enable-mutations option is specified.

📚 Documentation

Resources

• graphql-schema: The server exposes the GraphQL schema as a resource for clients to access. This could be a local schema file or one generated from an introspection query.

📦 Installation

Installing via Smithery

To automatically install the GraphQL MCP Server for Claude Desktop through Smithery:

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

Manual Installation

You can manually install it in Claude:

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

⚠️ Important Note

Mutation operations are disabled by default as a security measure. Please consider carefully before enabling them in a production environment.

💡 Usage Tip

This is a very generic implementation that allows full introspection and enables users to perform arbitrary operations (including mutations). If you need a more specific implementation, it is recommended to create a custom MCP and restrict client tool calls to specific query fields and/or variables. This project can serve as a reference.