Github GraphQL API

🚀 GitHub GraphQL API MCP

このツールは、MCP（モデル制御プロトコル）に基づいており、GitHub GraphQL APIをクエリして使用するために設計されています。このプロジェクトでは、MCPクライアントツール（Claude AIなど）を通じてGitHub GraphQLスキーマを探索し、GraphQLクエリを実行できるサーバーを提供しています。

English | 中文 | 日本語 | Español | Français

🚀 クイックスタート

GitHub GraphQL API MCPは、GitHub GraphQL APIとやり取りするためのツールセットです。このツールを使うことで、GitHub GraphQL APIの機能を簡単に利用できます。

✨ 主な機能

GitHub GraphQL API MCPには以下の機能があります。

1. タイプフィールドの表示：GitHub GraphQLスキーマのルートタイプのフィールドをクエリします。
2. ルートタイプのドキュメントの取得：GitHub GraphQLスキーマのルートタイプ（Query/Mutation）のドキュメントを取得します。
3. 特定タイプのドキュメントの取得：GitHub GraphQLスキーマの特定のタイプのドキュメントをクエリします。
4. GraphQL APIの呼び出し：GitHub GraphQL APIのクエリを実行します。

📚 ドキュメント

なぜGitHub GraphQL APIを使うのか

機能の利点

• 効率的なデータクエリ：GraphQLを使用することで、必要なデータを一度に取得でき、リクエスト回数とデータの冗長性を減らすことができます。
• 柔軟なクエリ構文：カスタムクエリ構造をサポートし、さまざまな開発ニーズに対応できます。
• 充実したスキーマドキュメント：GitHubは詳細なGraphQLスキーマドキュメントを提供しており、開発者がAPIを理解しやすくなっています。

使用シーン

• プロジェクト管理：GraphQLを使ってリポジトリ情報やユーザー情報をクエリし、効率的なプロジェクト管理とコラボレーションを実現します。
• データ統合：GitHubのデータを他のシステム（CI/CDフローやチーム内ツールなど）と統合します。
• 自動化スクリプト：自動化スクリプトを作成して、最新のコミットの取得や問題の作成などの繰り返しタスクを実行します。

アプリケーションシナリオ

サンプルスクリーンショット

この例では、ユーザーがClaudeを使ってGitHub GraphQL API MCPを呼び出しています。

特性

• 使いやすさ：直感的なコマンドラインインターフェイスとツールセットを提供し、すぐに使い始めることができます。
• 高い柔軟性：カスタムGraphQLクエリをサポートし、個別のニーズに対応できます。
• 充実したドキュメント：詳細なスキーマドキュメントが組み込まれており、開発者がGitHub GraphQL APIをすぐに理解できるようになっています。

前提条件

このプロジェクトを使用する前に、以下のことを確認してください。

1. 有効なGitHubアカウントを持ち、適切な権限を持つアクセストークンを生成していること。
2. アクセストークンを.envファイルに安全に保存し、バージョン管理システムにコミットしないこと。
3. クエリがGitHub APIの使用制限に準拠していること。

インストール

コードのダウンロード

このプロジェクトのソースコードは、以下のリンクからダウンロードできます。

• GitHubリポジトリ：GitHub GraphQL API MCP リポジトリURL

依存関係のインストール

プロジェクトディレクトリに移動し、必要なPythonパッケージをインストールします。

pip install -r requirements.txt

使用方法

サーバーの起動

以下のコマンドを実行して、MCPサーバーを起動します。

python run_server.py --directory <プロジェクトパス>

利用可能なツール

1. print_type_field：GitHub GraphQLスキーマのルートタイプのフィールドをクエリします。
2. graphql_schema_root_type：ルートタイプ（Query/Mutation）のドキュメントを取得します。
3. graphql_schema_type：特定のタイプのドキュメントをクエリします。
4. call_github_graphql：GitHub GraphQL APIのクエリを実行します。

使用例

1. ルートタイプのドキュメントをクエリする。

Use the graphql_schema_root_type tool, parameter type_name="QUERY"

2. フィールド情報をクエリする。

Use the print_type_field tool, parameters type_name="QUERY", type_fields_name="repository"

3. GraphQLクエリを実行する。

Use the call_github_graphql tool, parameter:
graphql="""
query {
  viewer {
    login
    name
  }
}
"""

注意事項

⚠️ 重要な注意事項

• GitHubアクセストークンが適切な権限を持っていることを確認してください。
• .envファイルを安全に保管し、漏洩を防いでください。
• GitHub APIの使用制限に準拠してください。

📄 ライセンス

このプロジェクトはMITライセンスの下で公開されています。これは非常に緩やかなライセンスで、ユーザーはこのソフトウェアを自由に使用、変更、配布、商用利用することができますが、著作権表示とライセンス表示を保持する必要があります。 詳細な条項については、MIT Licenseを参照してください。