AI Integration with Model Context Protocol (MCP)
Introduction
The Model Context Protocol (MCP) server in WunderGraph Cosmo Router enables seamless integration between your GraphQL API and AI models such as ChatGPT, Claude, and other Large Language Models (LLMs). This powerful feature allows AI agents to discover, understand, and interact with any GraphQL API in a structured and secure way.
What is MCP?
MCP (Model Context Protocol) is a protocol designed to help AI models interact with your APIs by providing context, schema information, and a standardized interface. The Cosmo Router implements an MCP server that exposes your GraphQL operations as tools that AI models can use.MCP enables AI models to understand and interact with your GraphQL API without
requiring custom integration code for each model.
API Discovery
Make your GraphQL API automatically discoverable by AI models like OpenAI,
Claude, and Cursor
Rich Metadata
Provide detailed schema information and input requirements for each
operation
Secure Access
Enable controlled, precise access to your data with operation-level
granularity
AI Empowerment
Empower AI assistants to work with your application’s data through a
standardized interface
Why combining GraphQL + MCP is Revolutionary
The integration of GraphQL with MCP creates a uniquely powerful system for AI-API interactions:- Precise data selection: GraphQL’s nature allows you to define exactly what data AI models can access, from simple queries to complex operations across your entire graph.
- Declarative operation definition: Create purpose-built
.graphql
files with operations tailored specifically for AI consumption. These function as persisted operations (trusted documents), giving you complete control over what queries AI models can execute. - Flexible data exposure: Control exactly which operations and fields are exposed to AI systems with granular precision.
- Compositional API design: Build different operation sets for different AI use cases without changing your underlying API.
- Runtime safety: GraphQL’s strong typing ensures AI models can only request valid data patterns that match your schema.
- Built-in validation: Operation validation prevents malformed queries from ever reaching your backend systems.
- Evolve without breaking: Change your underlying data model while maintaining stable AI-facing operations.
- Federation-ready: Works seamlessly with federated GraphQL schemas, giving AI access to data across your entire organization.
The GraphQL Advantage: Real Security for AI Integration
When a major financial services company integrated AI assistants into their customer support workflow, they faced a critical challenge: how could they let AI access transaction data without exposing sensitive financial information or risking regulatory non-compliance?Without proper data boundaries, AI models might inadvertently access or expose
sensitive customer information, creating security and compliance risks.
- Security vulnerabilities: Their existing REST endpoints contained mixed sensitive and non-sensitive data, making them unusable for AI integration without major restructuring.
- Development bottlenecks: Their engineering team estimated 6+ months to create and maintain a parallel “AI-safe” REST API, delaying their AI initiative significantly.
- Data governance issues: Without granular control, they couldn’t meet regulatory requirements for tracking and limiting what data AI systems could access.
- Compliance approval in weeks, not months: Their compliance team could clearly verify exactly what data AI systems could access, accelerating approval.
- 95% reduction in security review time: With GraphQL’s schema enforcement, security teams had confidence that AI systems couldn’t accidentally access unauthorized data.
- Zero API duplication: They maintained a single source of truth in their API layer while creating different “views” for different consumers.
- Future-proof integration: As they added new data fields to their internal models, those fields remained invisible to AI until explicitly added to AI-accessible operations.
How It Works
The Cosmo Router server:- Loads GraphQL operations from a specified directory
- Validates them against your schema
- Generates JSON schemas for operation variables
- Exposes these operations as tools that AI models can discover and use
- Handles execution of operations when called by AI models
- It discovers available GraphQL operations
- Understands input requirements through the JSON schema
- Executes operations with appropriate parameters
- Receives structured data that it can interpret and use in its responses
Built-in MCP Tools
The MCP server provides several tools out of the box to help AI models discover and interact with your GraphQL API:Discovery Tools
get_operation_info
Retrieves detailed information about a specific GraphQL operation, including
its input schema, query structure, and execution guidance. AI models use
this to understand how to properly call an operation in real-world
scenarios.
get_schema
Provides the full GraphQL schema as a string. This helps AI models
understand the entire API structure. This tool is only available if
expose_schema
is enabled.Execution Tools
execute_graphql
Executes arbitrary GraphQL queries or mutations against your API. This tool is only available if
enable_arbitrary_operations
is enabled, allowing AI models to craft and execute custom operations beyond predefined ones.execute_operation_*
For each GraphQL operation in your operations directory, the MCP server automatically generates a corresponding execution tool with the pattern
execute_operation_<operation_name>
(e.g., execute_operation_get_users
).- Tool naming: Tools follow the pattern
execute_operation_<operation_name>
(with operation names converted to snake_case) - Tool schema: Generated from your GraphQL operation’s variables, ensuring type safety
- Tool description: Inherited from your GraphQL operation descriptions, including operation name and additional context
- Mutation warnings: Tools for mutation operations include a warning that the operation has side effects
exclude_mutations: true
configuration option to prevent mutation operations from being exposed if you want to ensure AI models can only read data.
Configuration
To enable MCP in your Cosmo Router, add the following configuration to yourconfig.yaml
:
Configuration Options
Option | Description | Default |
---|---|---|
enabled | Enable or disable the MCP server | false |
server.listen_addr | The address and port where the MCP server will listen for requests | localhost:5025 |
server.base_url | Custom URL to use for the router GraphQL endpoint in MCP. Use this when your router is behind a proxy. Purely metadata for AI model. | - |
router_url | Custom URL to use for the router GraphQL endpoint in MCP. Use this when your router is behind a proxy. | http://{listen_addr}{graphql_path} |
storage.provider_id | The ID of a storage provider to use for loading GraphQL operations. Only file_system providers are supported. | - |
graph_name | The name of the graph to be used by the MCP server | mygraph |
exclude_mutations | Whether to exclude mutation operations from being exposed | false |
enable_arbitrary_operations | Whether to allow arbitrary GraphQL operations to be executed. Security risk: Should only be enabled in secure, internal environments. | false |
expose_schema | Whether to expose the full GraphQL schema. Security risk: Should only be enabled in secure, internal environments. | false |
Storage Providers
MCP loads operations from a configured file system storage provider. This allows you to centralize the configuration of operation sources:Setting Up Operations
- Create a directory to store your GraphQL operations as specified in your
storage.provider_id
configuration. - Add
.graphql
files containing named GraphQL operations.
Example Query Operation
Create a fileoperations/getUsers.graphql
:
Example Mutation Operation
Create a fileoperations/createUser.graphql
:
Directory Structure
Here’s an example of how your project directory might be structured:- The path in your
storage_providers.file_system.path
should point to the operations directory - All
.graphql
files in this directory (and subdirectories) will be loaded - Each file should contain a single named GraphQL operation
Operation Naming and Tool Generation
The MCP server converts each operation into a corresponding tool:- Operation name:
GetUsers
→ Tool name:execute_operation_get_users
- Operation name:
CreateUser
→ Tool name:execute_operation_create_user
Best Practices
- Meaningful names: Give operations clear, action-oriented names that describe what they do.
- Add descriptions: Include comments that describe the operation’s purpose, required inputs, and any side effects.
- Use explicit types: Define all input variables with explicit types to ensure proper validation.
- Create focused operations: Design operations specifically for AI model consumption rather than exposing generic operations.
- Security considerations: For mutation operations, add checks and validations to prevent misuse.
Authentication
The MCP server respects the “Authorization” header from MCP clients and forwards them to the router. This allows you to leverage all the authentication and authorization capabilities of your Cosmo Router when AI models interact with your GraphQL API.By passing authentication headers from AI tools to your GraphQL API, you can
maintain consistent security across all API consumers while giving AI models
appropriate access to your data.
Configuration
The authentication header can be configured in various AI tools and environments:Cursor and Claude Desktop
Configure Cursor and Claude Desktop to use your MCP server with authentication by using themcp-remote
command.
Cursor and Claude Desktop (Windows) have a bug where spaces inside args aren’t
escaped when it invokes npx, which ends up mangling these values. You can work
around it by interpolating the value into the command using the
env
key.VS Code
In VS Code, you can configure the MCP extension with authentication headers in yoursettings.json
: