Graphql MCP

🚀 GraphQL MCP 服务器

GraphQL MCP 服务器是一个强类型的 TypeScript 模型上下文协议 (MCP) 服务器，借助 Claude AI 可实现对任何 GraphQL API 的无缝访问，有效提升代码质量与类型安全。

🚀 快速开始

GraphQL MCP 服务器能让你借助 Claude AI 轻松访问 GraphQL API。以下是使用前的安装与启动步骤。

✨ 主要特性

• 强类型：采用 TypeScript 编写，极大提高代码质量和类型安全。
• 动态 GraphQL 集成：可与任何 GraphQL API 协同工作，具有高度灵活性。
• 自动发现：能够自动生成上下文协议 (MCP) 描述，简化开发流程。
• 命令执行：支持通过 Claude 命令进行查询和突变操作。
• 可扩展性：易于添加自定义处理逻辑，满足多样化需求。

📦 安装指南

使用以下命令安装 graphql-mcp-server 包：

npm install graphql-mcp-server --save

💻 使用示例

基础用法

以下代码展示了如何初始化服务器：

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('服务器已启动');
}
start();

高级用法

以下代码展示了如何添加自定义处理逻辑：

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

async function start() {
  const server = new MCPGraphQLServer({
    endpoint: 'http://localhost:8080/graphql',
    mcpEndpoint: '/mcp',
    onCommand: async (command) => {
      // 处理自定义命令
      console.log('接收到来自 Claude 的命令:', command);
      return { status: 'success', result: '命令已处理' };
    }
  });
  
  await server.start();
  console.log('服务器已启动');
}
start();

📚 详细文档

• 快速入门指南
• 技术文档
• 查询白名单文档
• 突变文档
• 项目状态

🔧 技术细节

开发

若要修改服务器，可按以下步骤操作：

1. 修改 TypeScript 源代码，文件路径为 src/graphql-mcp-server.ts。
2. 编译 TypeScript 代码，使用命令 npm run build。
3. 运行编译后的服务器，使用命令 node dist/graphql-mcp-server.js。

发布到 npm

若要将此包发布到 npm，可按以下步骤操作：

# 确保你已登录到 npm
npm login

# 构建项目
npm run build

# 发布到 npm
npm publish

该包将包含 dist 目录中的预构建 JavaScript 文件，可直接使用，无需额外的构建步骤。

📄 许可证

此项目根据 Business Source License 1.1 (BSL 1.1) 分发，具体允许情况如下：

• 非商业用途：您可以将此软件用于任何非商业目的。
• 内部业务用途：您可以将此软件用于内部业务操作，但不可将其作为托管或管理服务提供给第三方。
• 开源转换：在 2029 年 3 月 14 日之前，代码不会自动转换为 MIT 许可证。

商业用途，包括作为服务提供给他人，需要从 CTK Advisors 获得商业许可。有关更多信息，请联系或查看完整的 LICENSE 文件。

BSL 许可证旨在平衡开源可用性和可持续的商业开发，给予所有人免费访问非商业用途，同时保护长期维护和改进代码的能力。