使用说明

项目简介

'mcp4gql' 是一个基于Node.js/TypeScript开发的MCP（Model Context Protocol）服务器，它充当MCP客户端（如支持MCP的LLM应用）与任何GraphQL API之间的桥梁。通过实现MCP协议，它使得LLM能够发现并调用工具来与您的GraphQL服务交互，例如查询数据或获取API Schema。

主要功能点

提供GraphQL工具: 暴露标准工具，允许LLM客户端执行GraphQL查询、变更或获取API的Schema信息。
支持Stdio传输: 通过标准输入/输出与MCP客户端进行通信。
连接任意GraphQL API: 通过配置GraphQL端点和可选的认证令牌，连接到您的目标GraphQL服务。

安装步骤

确保您的系统安装了Node.js环境。
使用npm或yarn全局安装 'mcp4gql' 包。打开终端，运行 'npm install -g mcp4gql' 或 'yarn global add mcp4gql'。

服务器配置 (供MCP客户端参考)

要在支持MCP的客户端中配置此服务器，您通常需要在客户端的设置中添加一个MCP服务器条目。以下是配置的关键信息（具体格式取决于您的客户端，但通常类似JSON）。请将 '"YOUR_GRAPHQL_ENDPOINT_URL"' 和 '"YOUR_OPTIONAL_AUTH_TOKEN"' 替换为您的实际值。

'mcpServers': 客户端配置中用于列出所有MCP服务器的键。
- 'mcp4gql': 您为这个服务器实例指定的名称，可以自定义。
  - 'command': 启动服务器的可执行命令，通常是 '"npx"'。
  - 'type': 服务器使用的传输协议，这里是 '"stdio"'（标准输入/输出）。
  - 'args': 传递给 'command' 的参数列表，用于运行已安装的包，例如 '["-y", "mcp4gql"]'。
  - 'env': 一个对象，包含需要传递给服务器进程的环境变量。
    - 'GRAPHQL_ENDPOINT': 必填。您的目标GraphQL API的完整URL。
    - 'AUTH_TOKEN': 选填。如果您的GraphQL API需要认证（如Bearer Token），在此处提供令牌值。

基本使用方法

配置完成后，启动您的MCP客户端（如支持MCP的AI助手）。客户端会自动连接并与 'mcp4gql' 服务器通信。AI助手现在应该能够感知到由 'mcp4gql' 提供的工具（如 'introspectGraphQLSchema' 和 'executeGraphQLOperation'），并在您与其交互时，如果需要获取GraphQL数据或Schema，会自动调用这些工具。例如，您可以尝试询问与您的GraphQL API相关的问题。

关键词