Graphql Api Integration

🚀 mcp-graphql 项目文档

mcp-graphql 是一个支持大语言模型（LLMs）与 GraphQL API 交互的 Model Context Protocol 服务器。它提供了模式 introspection 和查询执行功能，能让模型动态发现并使用 GraphQL API。

🚀 快速开始

使用 mcp-graphql 命令时指定正确的端点，它会自动尝试 introspection 查询。

📦 安装指南

使用 Smithery 安装

要通过 Smithery 自动安装 GraphQL MCP Server for Claude Desktop：

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

手动安装

可以手动安装到 Claude 中：

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

💻 使用示例

基础用法

# 基本使用，与本地 GraphQL 服务器通信
npx mcp-graphql --endpoint http://localhost:3000/graphql

高级用法

# 使用自定义头信息
npx mcp-graphql --endpoint https://api.example.com/graphql --headers '{"Authorization":"Bearer token123"}'

# 启用变异操作
npx mcp-graphql --endpoint http://localhost:3000/graphql --enable-mutations

# 使用本地模式文件而非 introspection 查询
npx mcp-graphql --endpoint http://localhost:3000/graphql --schema ./schema.graphql

📚 详细文档

命令行参数

可用工具

服务器提供两个主要功能：

1. introspect-schema：此工具获取 GraphQL 模式。如果您没有访问到模式资源，首先使用它。此工具要么使用本地的模式文件，要么基于 introspection 查询。
2. query-graphql：对端点执行 GraphQL 查询。默认情况下禁用变异操作，除非指定了 --enable-mutations 选项。

资源

• graphql-schema：服务器将 GraphQL 模式作为资源暴露出来，供客户端访问。这可能是本地模式文件，也可能是基于 introspection 查询生成的。

🔧 技术细节

这是一个非常通用的实现，允许完整的 introspection，并让用户能够执行任意操作（包括变异）。如果您需要更具体的实现，建议创建自定义的 MCP，并限制客户端工具调用仅限于特定查询字段和/或变量。此项目可以作为参考。

⚠️ 重要提示

变异操作默认关闭，作为安全措施。在生产环境中启用变异操作前请谨慎考虑。