Graphql Api Integration

🚀 mcp-graphql プロジェクトドキュメント

大規模言語モデル（LLMs）がGraphQL APIとやり取りできるようにするModel Context Protocolサーバーです。この実装では、スキーマのイントロスペクションとクエリの実行機能を提供し、モデルがGraphQL APIを動的に発見して使用できるようにします。

🚀 クイックスタート

mcp-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

# イントロスペクションクエリではなく、ローカルのスキーマファイルを使用する
npx mcp-graphql --endpoint http://localhost:3000/graphql --schema ./schema.graphql

✨ 主な機能

サーバーは以下の2つの主要な機能を提供します。

1. introspect-schema：このツールはGraphQLスキーマを取得します。スキーマリソースにアクセスできない場合は、最初にこれを使用してください。このツールは、ローカルのスキーマファイルを使用するか、イントロスペクションクエリに基づいて動作します。
2. query-graphql：エンドポイントに対してGraphQLクエリを実行します。デフォルトではミューテーション操作は無効になっており、--enable-mutationsオプションを指定した場合のみ有効になります。

📚 ドキュメント

リソース

• graphql-schema：サーバーはGraphQLスキーマをリソースとして公開し、クライアントがアクセスできるようにします。これはローカルのスキーマファイルである場合もあれば、イントロスペクションクエリに基づいて生成されたものである場合もあります。

📦 インストール

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

🔧 注意事項

⚠️ 重要提示

ミューテーション操作は安全対策としてデフォルトで無効になっています。本番環境でミューテーション操作を有効にする前に、十分に検討してください。

💡 使用建议

これは非常に汎用的な実装であり、完全なイントロスペクションを可能にし、ユーザーが任意の操作（ミューテーションを含む）を実行できるようにします。より具体的な実装が必要な場合は、カスタムMCPを作成し、クライアントツールの呼び出しを特定のクエリフィールドや変数に制限することをおすすめします。このプロジェクトは参考にすることができます。