Graphql MCP

🚀 GraphQL MCP Server

A strongly-typed TypeScript Model Context Protocol (MCP) server that enables seamless access to any GraphQL API through Claude AI.

🚀 Quick Start

The GraphQL MCP Server is a robust solution for interacting with GraphQL APIs. It offers a range of features that enhance the development experience and provide flexibility in handling GraphQL queries and mutations.

✨ Features

• Strong Typing: Utilize TypeScript to enhance code quality and type safety.
• Dynamic GraphQL Integration: Work seamlessly with any GraphQL API.
• Automatic Discovery: Automatically generate the Model Context Protocol (MCP) description.
• Command Execution: Support queries and mutations via Claude commands.
• Scalability: Easily add custom processing logic.

📦 Installation

npm install graphql-mcp-server --save

💻 Usage Examples

Basic Usage

import { MCPGraphQLServer } from 'graphql-mcp-server';

async function start() {
  const server = new MCPGraphQLServer({
    endpoint: 'http://localhost:8080/graphql',
    mcpEndpoint: '/mcp'
  });
  
  await server.start();
  console.log('Server has started');
}
start();

Advanced Usage

import { MCPGraphQLServer } from 'graphql-mcp-server';

async function start() {
  const server = new MCPGraphQLServer({
    endpoint: 'http://localhost:8080/graphql',
    mcpEndpoint: '/mcp',
    onCommand: async (command) => {
      // Handle custom commands
      console.log('Received command from Claude:', command);
      return { status: 'success', result: 'Command has been processed' };
    }
  });
  
  await server.start();
  console.log('Server has started');
}
start();

📚 Documentation

• Quick Start Guide
• Technical Documentation
• Query Whitelist Documentation
• Mutations Documentation
• Project Status

🔧 Technical Details

Development

To modify the server:

1. Modify the TypeScript source code in src/graphql-mcp-server.ts.
2. Compile the TypeScript code: npm run build.
3. Run the compiled server: node dist/graphql-mcp-server.js.

Publishing to npm

To publish this package to npm:

# Ensure you are logged in to npm
npm login

# Build the project
npm run build

# Publish to npm
npm publish

This package will include pre - built JavaScript files in the dist directory, making it ready for direct use without additional build steps.

📄 License

This project is distributed under the Business Source License 1.1 (BSL 1.1), which allows:

• Non - commercial Use: You can use this software for any non - commercial purpose.
• Internal Business Use: You can use this software for internal business operations without offering it as a hosted or managed service to third parties.
• Open - source Conversion: The code will not automatically convert to the MIT license until March 14, 2029.

Commercial use, including offering it as a service to others, requires a commercial license from CTK Advisors. For more information, please contact or review the full LICENSE file.

The BSL license aims to balance open - source availability and sustainable commercial development, providing free access for non - commercial use to everyone while protecting our ability to maintain and improve the code in the long term.