mcp-graphql 项目文档 翻译版本

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

使用说明

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

命令行参数

示例

# 基本使用，与本地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查询生成的。

安装说明

使用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"]
        }
    }
}

安全注意事项

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

自定义属于您自己的服务器

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