mcp4gql - GraphQL MCP Server

mcp4gql - GraphQL MCP Server

site icon
2025.04.28 1
TypeScriptGraphQL 服务MCP 桥接开发效率
mcp4gql 是一个基于 Node.js/TypeScript 的服务器,实现了 Model Context Protocol (MCP)。它充当桥梁,允许 MCP 客户端(如 Cursor)与目标 GraphQL API 进行交互。
View on GitHub

Overview

基本能力

产品定位

mcp4gql 是一个 GraphQL MCP 服务器,主要用于连接 MCP 客户端与 GraphQL API,提供 GraphQL 相关的工具和服务。

核心功能

  • MCP 服务器实现:使用 @modelcontextprotocol/sdk 中的 Server 类实现 MCP 协议。
  • Stdio 传输:通过标准输入/输出与客户端通信。
  • GraphQL 客户端:使用 axios 向配置的 GraphQL 端点发送请求。
  • 通用 GraphQL 工具
  • introspectGraphQLSchema:通过内省获取目标 GraphQL API 的架构。
  • executeGraphQLOperation:执行任意 GraphQL 查询或变更操作,支持 query、可选的 variablesoperationName 作为输入。

适用场景

  • 开发者在需要将 MCP 客户端(如 Cursor 或 Claude Desktop)与 GraphQL API 集成时使用。
  • 需要快速获取 GraphQL API 架构信息或执行 GraphQL 操作的场景。

工具列表

  • introspectGraphQLSchema:获取目标 GraphQL API 的架构信息。
  • executeGraphQLOperation:执行 GraphQL 查询或变更操作。

常见问题解答

  • 如何配置 GraphQL 端点?:通过环境变量 GRAPHQL_ENDPOINT 设置目标 GraphQL API 的 URL。
  • 如何添加认证?:通过环境变量 AUTH_TOKEN 设置可选的 Bearer 令牌。

使用教程

使用依赖

确保已安装 Node.js 和 npm。

安装教程

  1. 安装 mcp4gql: bash npm install -g mcp4gql

  2. 配置环境变量: bash export GRAPHQL_ENDPOINT="YOUR_GRAPHQL_ENDPOINT_URL" export AUTH_TOKEN="YOUR_OPTIONAL_AUTH_TOKEN"

调试方式

  1. 启动服务器: bash npx -y mcp4gql

  2. 在 MCP 客户端(如 Cursor 或 Claude Desktop)中配置服务器,确保可以调用 introspectGraphQLSchemaexecuteGraphQLOperation 工具。

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。