mcpField
H
huawei-cloud-business-tf-support

huawei-cloud-business-tf-support

github.com/huaweicloudクラウド・DevOps59175 回インストール2 日前に更新
リポジトリ

huawei-cloud-business-tf-support について

Huawei Cloud Python SDKを使うローカルPythonスクリプトで、Huawei Cloudのリソースや利用可能な仕様を照会する読み取り専用スキルです。リソースの棚卸しや自動化用パラメーターの確認に使い、作成・変更・削除は行いません。

主な機能

  1. 01リソース一覧の読み取り専用照会
  2. 02個別リソース詳細の照会
  3. 03仕様、イメージ、ディスク種別の検索
  4. 04リソースIDと依存関係の照会
  5. 05環境と認証情報の検証

活用シーン

  1. 01既存クラウドリソースの棚卸し
  2. 02リージョンの仕様やイメージの確認
  3. 03ディスク詳細やリソースIDの特定
  4. 04検証済み自動化パラメーターの準備

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/huaweicloud/huaweicloud-skills --skill huawei-cloud-business-tf-support

インストール後、Claude Code で/huawei-cloud-business-tf-supportを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

requirements.txt
references/bss/
guide.md
scripts/bms/
list_baremetal_flavor_detail_extends.py
scripts/bss/
inquiry_dcs.py
inquiry_elb.py
inquiry_nat.py
list_cities.py
list_conversions.py
list_costs.py
list_counties.py
list_customer_account_change_records.py
list_customer_bills_fee_records.py
list_customer_bills_monthly_break_down.py
list_customer_coupon_change_records.py
list_customer_orders.py
list_customerself_resource_record_details.py
list_customerself_resource_records.py
list_enterprise_multi_account.py
list_enterprise_organizations.py
list_enterprise_sub_customers.py
list_free_resource_infos.py
list_free_resource_usages.py
list_free_resources_usage_records.py
list_measure_units.py
list_multi_account_retrieve_coupons.py
list_multi_account_transfer_coupons.py
list_on_demand_resource_ratings.py
list_pay_per_use_customer_resources.py
list_provinces.py
list_rate_on_period_detail.py

詳細

Huawei Cloud リソースクエリ

⚠️ 実行方法(必読):このスキルはローカルの Python スクリプトを使ってクエリを実行します。hcloud、openstack などの CLI ツールを使用したり、API を直接呼び出したりしないでください。

  • クエリスクリプトはスキルディレクトリ内の scripts/<service_category>/ にあります(例:scripts/as/list_scaling_groups.py)。
  • すべてのスクリプトと環境チェック用スクリプトはスキルパッケージ内にあります。skill action=exec を使用して実行してください。シェルから直接実行してはいけません。
  • 個別のスクリプトパスとパラメーターについては、references/<service>/guide.md を参照してください。
  • hcloud、openstack、curl IAM などの CLI/API による方法は試さないでください。このスキルはこれらのツールに依存しません。
  • すべてのパスはスキルディレクトリからの相対パスです。このディレクトリは SKILL.md が置かれている場所です。

概要

このスキルは、ローカルの Python スクリプトを使用して Huawei Cloud Python SDK を呼び出し、Huawei Cloud のリソース、利用可能な仕様、既存リソースの情報を照会する、独立した読み取り専用のクエリスキルです。

このスキルは、次のようなシナリオで利用できます。

  1. 指定したリージョンで利用可能なクラウドリソースの仕様を照会する
  2. 特定の OS タイプで利用可能なイメージを照会する
  3. ディスクタイプと既存のディスク情報を照会する
  4. 既存のリソースとその主要な属性を照会する
  5. Terraform やその他の IaC ツールを使用せずに作成されたリソースを照会する
  6. 自動化設定、リソース検証、環境インベントリ用の実際のパラメーターを準備する
  7. リソース ID、名前、仕様、イメージ、ネットワーク、ディスクなど、再利用可能な情報を取得する

このスキルでは、次の操作は行いません。

  1. リソースの作成
  2. リソースの変更
  3. リソースの削除
  4. 照会していない情報の推測や捏造

機能範囲

このスキルは、scripts ディレクトリ内のカテゴリ別スクリプトを通じてクエリ機能を提供し、references ディレクトリ内のカテゴリ別ガイドで使用方法を説明します。 このスキルでは、次の機能を提供します。

  1. リソース一覧の照会
  2. 個別のリソース詳細の照会
  3. 利用可能な仕様、イメージ、ディスクタイプなどの選択情報の照会
  4. 既存リソースの主要な識別子と依存関係の照会

使用原則

重要:このスキル内で実行するスクリプトのパスはすべて、スキルディレクトリからの相対パスです。このディレクトリは SKILL.md が置かれている場所です。

  1. このスキルではクエリのみを実行し、書き込み操作は行いません。
  2. ユーザーが明示的に指定したリージョン、プロジェクト、AZ、リソース名、リソース ID などを優先してください。
  3. クエリ結果は実際の API レスポンスに基づく必要があります。経験に基づいて推測しないでください。
  4. 返す結果では、後で再利用できる主要なフィールドを優先してください。
  5. 結果が大量にある場合は、リージョン、名前、ID、ステータス、タグなどで範囲を絞り込んでください。
  6. 現在のリソースタイプに対応するスクリプトまたはガイドがない場合は、未対応であることを明確に伝えてください。信頼できない結果を返してはいけません。
  7. ユーザーが必要な範囲情報を指定しておらず、環境にもデフォルト値がない場合は、クエリを実行する前に確認してください。
  8. guide.md の記載に従って直接実行してください。scripts ディレクトリ内のスクリプトの内容を読んではいけません。
  9. 出力が大量になる場合は、キャッシュしてください。
  10. 各スクリプトの実行前に、必ず -h を実行して使用方法を確認してください。
  11. スクリプト名をでっち上げないでください。guide.md に記載されたスクリプト名に従って実行してください。スクリプト名が guide.md にない場合、そのスクリプトは未対応です。
  12. 請求額やコストなど、時間に依存するクエリでは、スクリプトのデフォルト値を使用するか、実行前に現在の日付を確認してください。想定に基づいて時間パラメーターをハードコードしてはいけません。

前提条件

使用前に、環境チェック用スクリプトを実行して、環境の検証と依存関係のインストールを一度に完了する必要があります。

  • Linux / macOS:skill action=exec: bash skill://scripts/check_env.sh
  • Windows:skill action=exec: powershell -ExecutionPolicy Bypass -File skill://scripts/check_env.ps1

Windows に関する注意:PowerShell 5.x は && によるコマンドの連結をサポートしていないため、コマンドを連結する際に使用しないでください。先にディレクトリを変更する必要がある場合は、セミコロンを使用してください。

スクリプトは次の順にチェックします:Python >= 3.6 → 依存関係のインストール → SDK の検証 → 認証情報の検証 → サービスの利用可能性の検証。環境チェックに失敗した場合は、 ほかのスクリプトを実行する前に問題を修正してください。

環境変数:

変数必須説明
HW_ACCESS_KEYはいHuawei Cloud AK
HW_SECRET_KEYはいHuawei Cloud SK
HW_REGION_NAMEいいえデフォルトは cn-north-4
HW_PROJECT_IDいいえプロジェクト ID(設定されていない場合は IAM API 経由で自動取得)
HW_SECURITY_TOKENいいえ一時的な AK/SK を使用する場合に必要

上記の環境変数の値を出力しないでください。 可用性ゾーンやエンタープライズプロジェクトなど、ほかのリソーススクリプトで必要となる追加パラメーターについては、該当する guide.md を参照してください。


実行フロー

このスキルが呼び出されたときは、ユーザーからの指示を待たずに、次の手順を実行する必要があります。

ステップ 1:環境の準備

環境チェック用スクリプトを実行して、依存関係がインストールされ、認証情報が設定されていることを確認します。

  • Linux / macOS:skill action=exec: bash skill://scripts/check_env.sh
  • Windows:skill action=exec: powershell -ExecutionPolicy Bypass -File skill://scripts/check_env.ps1

環境チェックに失敗した場合は、表示された指示に従って問題を修正し、チェックに合格するまで再実行してください。

ステップ 2:クエリスクリプトの特定と実行
  1. ユーザーのクエリの意図に基づいて references/<service>/guide.md を読み、実行するスクリプトのパスとパラメーターを確認します。
  2. 最初に -h を実行して、スクリプトの使用方法を確認します。
    • Linux / macOS:skill action=exec: skill://.venv/bin/python3 skill://scripts/<service>/<script>.py -h
    • Windows:skill action=exec: skill://.venv/Scripts/python3.exe skill://scripts/<service>/<script>.py -h
  3. ユーザーの要件に基づいてパラメーターを組み立て、スクリプトを実行します。
    • Linux / macOS:skill action=exec: skill://.venv/bin/python3 skill://scripts/<service>/<script>.py <parameters>
    • Windows:skill action=exec: skill://.venv/Scripts/python3.exe skill://scripts/<service>/<script>.py <parameters>
  4. 結果を整形してユーザーに返します。

重要:

  • すべてのスクリプトと環境チェック用スクリプトはスキルパッケージ内にあります。必ず skill action=exec を使用して実行してください。シェルから直接実行しないでください。
  • venv は check_env スクリプトによって自動作成されます。Python は Linux/macOS では .venv/bin/python3、Windows では .venv/Scripts/python3.exe にあります。
  • python3 を使ってスクリプトを直接実行しないでください。
  • scripts ディレクトリ内のスクリプトのソースコードを読まないでください。guide.md の指示に従ってください。
  • 出力が大きい場合は、結果をキャッシュしてください。
  • --project_id パラメーターは省略可能です。指定されていない場合は、リージョンに基づいて IAM API 経由で自動取得されます。

ディレクトリ構成

ディレクトリの規則は次のとおりです(すべてのパスはスキルディレクトリからの相対パスです)。

  1. scripts/<resource_category>/ には、該当するリソースの Python クエリスクリプトが含まれます。スクリプトの内容を読む必要はありません。guide.md の使用方法に従ってスクリプトを実行してください。
  2. references/<resource_category>/guide.md には、該当するリソースの使用ガイドが含まれます。
  3. 各スクリプトは、明確な単一のクエリ操作を担当します。
  4. 各リソースカテゴリには、スクリプトの機能、パラメーター、使用方法を説明する guide.md が少なくとも 1 つ必要です。

パラメーターの確認

クエリスクリプトを実行する前に、以下のパラメーターを確認してください。

パラメーター必須説明
regionはいHuawei Cloud のリージョン。例:cn-north-4
--project_idいいえプロジェクト ID。指定しない場合は自動取得されます
--availability_zoneいいえアベイラビリティーゾーン。一部のリソースクエリで必須です

スクリプト固有のパラメーターについては、references/<service>/guide.md を参照してください。


出力形式

クエリ結果は JSON 形式で出力され、以下の共通フィールドが含まれます。

  • total:一致したリソースの合計数
  • items:リソースのリスト。各リソースには、id、name、status などの主要フィールドが含まれます
  • 固有のフィールドはリソースの種類によって異なります。詳細については、各 guide.md を参照してください

検証方法

  1. 環境チェック用スクリプトを実行し、依存関係と認証情報が利用可能であることを確認します
  2. -h パラメーターを使用してスクリプトの使用方法を確認し、パラメーターが正しいことを確かめます
  3. 既知のリソースに対してクエリを実行し、コンソールのデータと比較して結果の正確性を検証します
  4. 返された total の数が妥当かどうかを確認します

ベストプラクティス

  1. データが多く返されないよう、まずクエリ範囲を絞り込みます(リージョン、アベイラビリティーゾーンなどを指定します)
  2. --help を使用して、スクリプトでサポートされているパラメーターの一覧をすべて確認します
  3. 大量のクエリ結果はローカルにキャッシュし、リクエストの繰り返しを避けます
  4. 複数のリソースをクエリする場合は、依存関係の順序に従います(例:まず VPC をクエリし、次にサブネットをクエリします)
  5. スクリプトの実行に失敗した場合は、まず環境変数とネットワーク接続を確認します

参考ドキュメント

  • 各サービスのクエリスクリプトの使用ガイド:references/<service>/guide.md

注意事項

  1. このスキルが提供するのは読み取り専用のクエリ機能のみです。書き込み操作は実行されません
  2. HW_ACCESS_KEY、HW_SECRET_KEY、その他の環境変数の値を出力しないでください
  3. すべてのスクリプトは skill action=exec を介して実行する必要があります。シェルから直接実行しないでください
  4. スクリプト名を推測せず、guide.md に記載された名前に従って実行してください
  5. クエリを実行する前に、環境チェック用スクリプトを必ず実行してください
  6. 一時的な AK/SK を使用する場合は、HW_SECURITY_TOKEN を設定してください

コメント