Alibaba Cloud OpenAPI を呼び出すには、API 名の検索、リクエストパラメーターの組み立て、ページネーションやクロスリージョン呼び出しの処理が必要です。OpenAPI MCP Server Core Edition (以下、「Core Edition」) は、自然言語による API 呼び出し、マルチステップのオーケストレーション、Terraform リソース管理、ドキュメント検索を可能にする 15 の組み込みツールを提供します。一般的な AI エージェント (例:Qoder、Claude Code、CodeX) と互換性があります。以下では、各ツールの機能、パラメーター、および使用方法について説明します。
前提条件
Core Edition の MCP Server の設定と統合が完了していること。詳細については、「OpenAPI MCP Server」をご参照ください。
MCP 接続を検証します。AI エージェントとの対話で「Alibaba Cloud のコンピューティング関連製品を一覧表示」と入力してください。製品リストが返されれば、接続は正常です。
ツールの概要
Core Edition には 15 のツールが含まれており、以下の 5 つのグループに分類しています:
カテゴリ | ツール | 説明 |
API の検出 | すべての Alibaba Cloud 製品とメタデータを一覧表示します | |
指定された製品配下のすべての API を一覧表示します | ||
API の完全なパラメーター定義を取得します | ||
自然言語による説明に基づいて、一致する OpenAPI を推奨します | ||
製品がサポートするリージョンを一覧表示します | ||
API の実行 | CLI コマンドを生成します (実行はしません) | |
Alibaba Cloud CLI コマンドを実行します | ||
高度なオーケストレーション | マルチ API オーケストレーションを行う Python スクリプトを実行します | |
非同期タスクのステータスをポーリングします | ||
Infrastructure as Code (IaC) | OSS の署名付き URL を生成します | |
Terraform HCL コードを実行します | ||
ドキュメント検索 | ドキュメントを検索します | |
ドキュメントの Markdown コンテンツを取得します | ||
製品ドキュメントのディレクトリツリーを閲覧します | ||
キーワードでドキュメントの内容を照合します |
ツールの詳細
API の検出
ListProducts
利用可能な Alibaba Cloud 製品を調べる必要がある場合、AI エージェントはこのツールを使用して製品カタログをクエリします。たとえば、「Alibaba Cloud にはどのようなコンピューティング関連製品がありますか」と入力すると、AI エージェントはキーワードを抽出し、それに応じて製品リストをフィルタリングします。
使用方法ガイド
問い合わせ内容に製品のキーワードを含めてください。たとえば、「Alibaba Cloud にはどのような製品がありますか」よりも「Alibaba Cloud にはどのようなコンピューティング関連製品がありますか」の方が適切です。
クエリ結果は、その後の対話のコンテキストとして利用できます。たとえば、まず「利用可能なデータベース製品は何か」と尋ね、次に特定の製品に関する具体的な操作の詳細を続けます。
ListApis
ユーザーの操作が特定の製品に関連しているものの、AI エージェントが正確な API を確認する必要がある場合、このツールを使用して製品の API リストを閲覧します。たとえば、「Elastic Compute Service (ECS) インスタンスにパブリック IP を割り当てる」と入力すると、AI エージェントはまず関連する ECS の API をクエリし、次に実行する適切な API を選択することがあります。
使用方法ガイド
操作の意図を説明する際は、製品とアクションをできるだけ具体的に記述してください。たとえば、「IP を割り当てる」よりも「ECS インスタンスにパブリック IP を割り当てる」の方が適切です。
GetApiDefinition
ユーザーのリクエストに API 呼び出しが含まれる場合、AI エージェントは通常、まず SearchApis または ListApis を通じてターゲット API を特定し、次にこのツールを使用して API のパラメーター定義を取得し、最終的に正しい API 呼び出しを生成します。たとえば、「杭州リージョンの ECS インスタンスをクエリする」と入力すると、AI エージェントはまず DescribeInstances API を特定し、次にこのツールで必要なパラメーターを確認してから実行します。
使用方法ガイド
操作の意図をできるだけ具体的に記述してください。AI エージェントが正しい API を見つけると、自動的にパラメーターを確認して実行します。
SearchApis
正確な API 名が不明な場合、AI エージェントはこのツールを使用して、自然言語による説明に基づいて対応する Alibaba Cloud OpenAPI を検索します。たとえば、「ECS インスタンスのモニタリングデータを表示する方法」と入力すると、AI エージェントは関連するモニタリング API を検索して見つけ出します。
使用方法ガイド
問い合わせ内容に製品名を含めてください。たとえば、「セキュリティグループをクエリする」よりも「ECS のセキュリティグループルールをクエリする」の方が適切です。
複雑な要件は、それぞれが単一の API に対応する複数の独立した質問に分割してください。
API 名がすでにわかっている場合は、AI エージェントに直接指定する (例:「DescribeInstances を使用して照会する」) ことで、検索ステップをスキップできます。
ListProductRegions
操作にリージョンの選択が含まれる場合、AI エージェントはこのツールを使用して、ターゲットリージョンがその製品に対応しているかを確認します。たとえば、「ウランチャブで ECS は使用できますか」または「シンガポールに ECS インスタンスを作成する」と入力すると、AI エージェントはまずリージョンの可用性を検証します。
使用方法ガイド
クエリには製品名とターゲットリージョンの両方を指定してください。たとえば、「ウランチャブで使用できますか」よりも「ウランチャブで ECS は使用できますか」の方が適切です。
複数のリージョンが関わる場合は、それぞれを指定してください。たとえば、「ECS が杭州、上海、シンガポールで利用可能かどうかを確認する」のようにします。
API の実行
GenerateCLICommand
「実行せずにコマンドのみを生成する」ように指示された場合、または AI エージェントがコマンドをプレビューする必要がある場合、このツールは CLI コマンド文字列を生成します。AI エージェントは通常、まず GetApiDefinition を通じてパラメーターを確認し、次にこのツールでコマンドを生成し、最後に CallCLI で実行します。たとえば、「杭州の ECS インスタンスをクエリするコマンドを生成する」と入力すると、ローカルターミナルで実行できる完全なコマンドが返されます。
使用方法ガイド
ローカルターミナルでコマンドを手動で実行するには、AI エージェントに「実行せずにコマンドのみを生成する」ようリクエストしてください。生成されたコマンドはコピーして直接使用できます。
CallCLI
AI エージェントが実行すべき API を正確に把握している場合、このツールを使用して直接呼び出します。これは、Core Edition における API 呼び出しの主要なツールです。たとえば、「杭州リージョンで実行中の ECS インスタンスをクエリする」と入力すると、AI エージェントは CLI コマンドを構築してクエリを実行します。
使用方法ガイド
このツールによって実行される CLI コマンドはリモートサーバー上で実行され、ローカルファイルを読み取ることはできません。
書き込み操作 (リソースの作成、変更、または削除) には料金が発生する場合があります。実行前に AI エージェントに操作内容を確認してください。
高度なオーケストレーション
RunScript
単一の API 呼び出しでは要件を満たせない場合、AI エージェントはこのツールを使用して一括操作のためのスクリプトを作成します。たとえば、「すべてのリージョンにまたがる ECS インスタンスをカウントする」または「すべてのセキュリティグループで高リスクのルールをチェックする」と入力すると、AI エージェントは複数のリソースを同時にクエリするための並行スクリプトを作成します。
使用方法ガイド
集計、比較、または一括操作が必要な場合は、範囲と目的を明確に記述してください。たとえば、「すべてのリージョンにまたがる ECS インスタンスをカウントする」や「すべてのセキュリティグループで高リスクのルールをチェックする」のようにします。
スクリプトの実行には数秒から数十秒かかる場合があります。結果が返されるまでしばらくお待ちください。
GetTask
RunScript または RunIaC タスクの実行に時間がかかる場合、AI エージェントはこのツールを使用してタスクの完了を待ち、結果を取得します。このツールは、クロスリージョン検査や Terraform のデプロイなど、時間のかかる操作中にトリガーされることがあります。
使用方法ガイド
時間のかかる操作 (クロスリージョン検査や一括クエリなど) の場合は、結果が返されるまでしばらくお待ちください。
手動での承認が必要な場合は、プロンプトに従って承認プロセスを完了すると、処理が続行され結果が返されます。
Infrastructure as Code (IaC)
GetPresignedUrl
RunIaC または RunScript ツールが外部ファイルを参照する必要がある場合、AI エージェントはこのツールを使用して一時的なアップロードリンクを生成します。たとえば、Terraform コードが 64 KB を超える場合や、スクリプトが事前にアップロードされたデータファイルを処理する必要がある場合、AI エージェントは後続の操作を実行する前に、まずこのツールを介してファイルをアップロードします。
使用方法ガイド
大容量ファイルのアップロードが伴う場合、後続の操作を実行する前に、アップロードが完了するまで待つ必要があります。
RunIaC
クラウドリソースを作成、変更、または破棄する必要がある場合、AI エージェントはこのツールを使用して Terraform を使用してインフラストラクチャを管理することがあります。たとえば、「CIDR が 172.16.0.0/16 の VPC を杭州に作成する」と入力すると、AI エージェントはまずリソース設定を生成して変更をプレビューし、確認後に作成します。
使用方法ガイド
リソース要件を記述する際は、リージョン、仕様、名前を明確に指定してください。たとえば、「CIDR 172.16.0.0/16 で、名前が mcp-demo-vpc の VPC を杭州に作成する」のようにします。
リソースの変更には手動での承認が必要な場合があります。プロンプトに従って承認プロセスを完了してください。
ドキュメント検索
SearchDocuments
製品の使用方法、設定方法、またはエラーのトラブルシューティングに関する知識ベースの質問があった場合、AI エージェントはこのツールを使用して Alibaba Cloud の公式ドキュメントを検索します。たとえば、「Function Compute のコールドスタートを最適化する方法」や「OSS バケットポリシーの設定方法」と入力すると、一致する公式ドキュメントの検索がトリガーされます。
使用方法ガイド
クエリに製品名を含めると、検索結果の精度が向上します。たとえば、「クロスオリジン設定」よりも「OSS クロスオリジン設定」の方が適切です。
特定の製品のドキュメントが必要な場合は、製品名を指定してください。たとえば、「コールドスタートの最適化」よりも「Function Compute のコールドスタート最適化ドキュメント」の方が適切です。
GetDocument
AI エージェントが SearchDocuments で関連ドキュメントを特定した後、このツールを使用して全文を読み取り、質問に回答します。たとえば、「Function Compute のコールドスタートを最適化する方法は?」と入力すると、AI エージェントはまずドキュメントを検索して特定し、次に全文を読んで回答を整理します。
使用方法ガイド
AI エージェントはドキュメントを特定した後、自動的に内容を読み取って整理します。ユーザーがこのプロセスを意識する必要はありません。
GetDocumentTree
ユーザーが製品のドキュメント構造を理解したい場合、AI エージェントはこのツールを使用してドキュメントのディレクトリツリーを閲覧します。たとえば、「OSS のドキュメント構造はどのようになっていますか」や「ECS にはどのようなユーザーガイドがありますか」と入力します。
使用方法ガイド
クエリに製品名を指定してください。たとえば、「OSS にはどのようなドキュメントカテゴリがありますか」や「ECS のユーザーガイドにはどのような章がありますか」のようにします。
GrepDocuments
質問に特定の用語、設定項目、またはエラーコードが含まれる場合、AI エージェントはこのツールを使用して、指定された製品ドキュメント内で正確なキーワードマッチングを実行します。たとえば、「ECS ドキュメントで InstanceChargeType にはどのような値がありますか」や「OSS ドキュメントで CORS 関連のコンテンツを検索する」と入力します。
使用方法ガイド
クエリには製品とキーワードの両方を指定してください。たとえば、「ECS ドキュメントで DescribeInstanceAttribute を検索する」のようにします。
キーワードがより正確であるほど、より精度の高い結果が得られます。複数のキーワードは AND 関係になります。
典型的なユースケース
以下のシナリオでは、複数のツールが連携して複雑なタスクを達成する完全なワークフローを示します。
セキュリティグループルールのクエリ
ユーザー入力:
杭州リージョンのセキュリティグループルールを確認する考えられる AI エージェントのツール呼び出しチェーン:
SearchApisを使用して「ECS インスタンスに関連付けられたセキュリティグループルールの照会」を検索し、DescribeSecurityGroupAttribute API (信頼度 0.98) を特定します。GetApiDefinitionを使用して、API で SecurityGroupId と RegionId が必須パラメーターであることを確認します。CallCLIを使用してクエリを実行し、方向、プロトコル、ポート範囲、送信元アドレスなどを含むセキュリティグループルールリストを返します。
関連ツール:SearchApis、GetApiDefinition、CallCLI
クロスリージョンの一括検査
ユーザー入力:
杭州、上海、北京リージョンの ECS インスタンス数をカウントする考えられる AI エージェントのツール呼び出しチェーン:
RunScriptを使用して、3 つのリージョンすべてのインスタンス数を同時にクエリする同時実行スクリプトを作成します。スクリプトの実行がタイムアウトし (20 秒を超える)、processID が返されます。
GetTaskを使用してタスクのステータスをポーリングし、スクリプト実行完了後に結果を取得します。
関連ツール:RunScript、GetTask
ドキュメントを使用した問題解決
ユーザー入力:
Function Compute のコールドスタートのレイテンシーが高いです。どのような最適化オプションがありますか?考えられる AI エージェントのツール呼び出しチェーン:
SearchDocumentsを使用して Function Compute cold start optimization を検索し、「Function Compute コールドスタート最適化のベストプラクティス」ドキュメント(doc_id: 2513659)を見つけます。GetDocumentを使用してドキュメントの全文を読み取り、コールドスタートの定義と最適化戦略を取得します。GetDocumentTreeを使用して Function Compute のドキュメントディレクトリを参照し、パフォーマンス関連の追加ドキュメントの章を特定します。
関連ツール: SearchDocuments、GetDocument、GetDocumentTree