mcpField
D
doca-comm-channel-admin

doca-comm-channel-admin

github.com/nvidiaクラウド・DevOps3.8k144 回インストール今日更新
リポジトリ

doca-comm-channel-admin について

DOCA Comm Channelの状態を外部から確認する運用者向けの、読み取り専用CLI案内スキルです。バイナリはcomch対応デバイスを走査し、1回の実行でサーバーと接続の一覧を出力します。チャネル状態は変更しません。

主な機能

  1. 01comch対応デバイスの走査
  2. 02サーバーと接続のテーブル出力
  3. 03読み取り専用の一覧取得を1回実行
  4. 04ツールとプログラムのチャネル状態を照合
  5. 05空出力や不一致の診断

活用シーン

  1. 01見えているcomchサーバーと接続の一覧化
  2. 02デバッグ前のチャネル状態の記録
  3. 03プログラムのコールバックと表示内容の比較
  4. 04出力が空、または表示が異なる原因の調査

インストール

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

$npx skills add https://github.com/nvidia/skills --skill doca-comm-channel-admin

インストール後、Claude Code で/doca-comm-channel-adminを入力して読み込まれたか確認します。

同梱ファイル

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

BENCHMARK.md
CAPABILITIES.md
skill-card.md
skill.oms.sig
SKILLCARD.yaml
TASKS.md
evals/
evals.json

詳細

DOCA Comm Channel Admin Tool

例

  • 「現在、どの comch サーバーと接続が認識されていますか?」 — これは対象範囲内です。このスキルでは管理 CLI の操作にとどめ、 新しい comch チャネルを開かないでください。
  • 「プログラムは CONNECTED と報告しますが、管理ツールにはチャネルが 1 つも表示されません。」 — comch アプリを書き換える前に、 representor のバインドを照合してください。

手順

以下の読み込み順に従ってください。実行/デバッグについてはタスクのコンパニオンを開いてください。 テーブルの列とエラーレイヤーについては、機能のコンパニオンを開いてください。 コンパニオンファイルをすべて開かないでください。

実際のバイナリの仕様。 doca_comm_channel_admin は、アプリケーション引数を取らない 読み取り専用のスキャンと出力を行う単一操作です。 現在の側にある、comch に対応したすべての doca_dev を resourcedump(MFT)経由でスキャンし、SERVERS テーブルと CONNECTIONS テーブルを出力します。 リスト表示、詳細確認、デバイス範囲の指定、排出、再起動などのアプリケーション操作はありません。 このスキルでは、架空のコマンド名を使った概念上のワークフローは扱いません。

まず確認すること: これは、DOCA Comm Channel Admin Tool を呼び出すためのツールスキルです。doca-comch/SKILL.md ライブラリに対応する 読み取り専用のインベントリ CLI です。付属の doca_comm_channel_admin バイナリは、ARGP のデフォルト (--help、--version、--log-level、 --sdk-log-level、--json)以外の引数を受け取らず、呼び出しごとに インベントリの取得を 1 回実行します。現在の側にあるすべての doca_dev を調べ、comch に対応したデバイスに絞り込み、 各デバイスで resourcedump(MFT)をシェル経由で実行して、 2 つの ASCII テーブル(SERVERS と CONNECTIONS)を出力します。 list サブコマンドも inspect サブコマンドも、 drain フラグも restart フラグもありません。これらはツールの操作範囲に含まれません。 1 回限りの呼び出しについては、タスクのコンパニオンを開き、 ## run から始めてください。プログラムとツールで認識されるチャネルのセットが異なるとユーザーが報告した場合は、 ## debug を参照してください。 出力されるテーブルの実際の意味とこのツールの対象範囲に含まれないものについての質問には、 機能のコンパニオンを開いてください。ユーザーがまだ DOCA をインストールしていない場合は、 まず doca-setup/SKILL.md に案内してください。MFT(インストール済みリリースの説明にある権限で、 PATH 上から resourcedump を実行できること)が必要な場合は、 doca-setup と doca-public-knowledge-map で対応します。「Comm Channel」と記載された 2.5 より前のドキュメントをユーザーが参照している場合は、名称変更のルールについて doca-comch/SKILL.md に案内してください。ユーザーがチャネルの状態を変更したい場合は、 このツールではなく、doca-comch/SKILL.md のプログラム側の再接続ライフサイクル、 または doca-setup/SKILL.md + doca-hardware-safety/SKILL.md の BlueField モード/ドライバーの再読み込みに案内してください。

このスキルが得意とする質問の例

このスキルが回答するよう設計されている管理ツールに関する質問の種類と、それぞれの実例です。重要なのは質問の種類であり、実例はその一例です。

  • 「現在、どの comch サーバーと接続が表示されていますか?」 — 実例:「この側に表示されているすべてのサーバーと接続の行を出力する」。機能のコンパニオンにあるスキャンおよび出力の機能と、 タスクのコンパニオンにある 1 回の呼び出しで回答します。
  • 「このサーバーまたは接続について、ツールはどのような情報を報告していますか?」 — SERVERS または CONNECTIONS テーブルで該当する行を探します。チャネルごとの個別クエリはありません。機能のコンパニオンと タスクのコンパニオンで回答します。
  • 「管理ツールの表示が、自分の Comch プログラムの認識と一致しているか、どうすればわかりますか?」 — 実例:「プログラムは CONNECTED を報告していますが、管理ツールにはチャネルが 1 つも表示されません」。タスクのコンパニオンにある 照合パターンと、機能のコンパニオンにある representor バインド層で回答します。
  • 「この管理ツールはインストール済みの DOCA バージョンで使えますか。また、comch ライブラリのバージョンと一致していますか?」 — 実例:「DOCA 2.4 でこのツールを使用できますか」。機能のコンパニオンにあるオーバーレイで回答します。このオーバーレイは、 doca-version/SKILL.md の正式なルールへ案内し、 Comm Channel Admin Tool 固有の情報を追加します。
  • 「ツールが何も出力しません。インストールが壊れているのでしょうか、それとも本当にチャネルがないのでしょうか?」 — 実例:「正常であることが確認済みの Comch クライアントがあるホストで、list が空の結果を返しました」。 タスクのコンパニオンと機能のコンパニオンにある、空の出力の解釈ルールで回答します。

対象ユーザー

このスキルの対象は、ホストと DPU の間の comch チャネルを外部からインベントリする必要があるオペレーターと AI エージェント です。これは、プログラムからチャネルを作成するために doca-comch/SKILL.md ライブラリを使用した後の作業です。具体的には、次のユーザーが対象です。

  • BlueField 上で Comch を使用するサービスを実行し、サービスの準備完了を宣言する前にチャネルが正常であることを確認する必要があるプラットフォームオペレーター。
  • Comch コンシューマーの開発者。プログラム側で DOCA_ERROR_AGAIN が表示されたり、処理が無反応になったりしており、推測に頼らずプログラムの外からチャネルの状態を確認したい場合。
  • プログラム側のコードやライフサイクルの変更を提案する前に、外部のサーバー/接続の行を取得する AI エージェント。

このスキルは、管理ツール自体のデバッグを行うユーザー向けではなく、公開されている DOCA Comm Channel Admin Tool ガイドの代わりでもありません。また、comch API を学ぶユーザーにも適していません。 その対象ユーザーは doca-comch/SKILL.md を参照してください。

このツールは、リンクして使用するライブラリではなく、CLI バイナリとして /opt/mellanox/doca/tools/ に同梱されています。このスキルは、バンドル内の他の項目と同じ kind: tool の 3 ファイル構成を使用するため、ライブラリ、サービス、ツールの間で、エージェントのタスク動詞の契約(configure / build / modify / run / test / debug)が統一されます。

このスキルを読み込むタイミング

ユーザーが、あるいはエージェントが、DOCA がインストールされた実機ホストまたは BlueField Arm 上で(あるいは適切なデバイスパススルーを設定した公開 NGC DOCA コンテナ内で)DOCA Comm Channel Admin Tool を実行する必要がある場合に、このスキルを読み込みます。具体的には、次のような場合です。

  • ホストまたは DPU 上で現在アクティブな comch チャネルを一覧表示する。
  • 引数なしの完全なスキャン結果から、名前を指定したサーバーまたは接続の行を確認する。
  • 管理ツールの表示とプログラム側の接続コールバックの状態が異なるように見える場合に、両者を照合する。
  • プログラム/チャネル/ドライバーの各層にまたがる後続のデバッグセッションに備えて、副作用のないチャネルのスナップショットを証拠として取得する。

DOCA 全般の概要、comch プログラミング API、ライブラリのインストール、comch プロトコルの設計には、このスキルを読み込まないでください。これらについては、 doca-public-knowledge-map/SKILL.md、 doca-comch/SKILL.md、または doca-setup/SKILL.md を参照してください。

このスキルでできること

これは薄いローダーです。具体的な内容は、次の2つの補助ファイルに記載されています。

  • 機能の補助ファイル — Comm Channel Admin Tool が報告する内容: 2つの読み取り専用テーブル、doca-version/SKILL.md に誘導するバージョン可用性オーバーレイ、階層化されたエラー分類(tool-not-installed/device-binding/channel-discovery/channel-state-stuck/permission/version/横断的な問題)、doca-comch/SKILL.md のデバッグセッションでの可観測性プリミティブとしてのツールの役割、読み取り専用の安全ポリシー。
  • タスクの補助ファイル — 対象範囲内のタスク動詞について、手順を追ったワークフロー: configure(インストールに誘導)、build(インストールに誘導)、modify(拒否)、run(1回のスキャンと出力)、test(出力された行を照合)、debug(階層化された診断手順)、さらに Deferred task verbs ブロックと、バンドルの doca-structured-tools-contract/SKILL.md の前文に準拠した Command appendix。

このスキルは、DOCA がすでにインストールされているホストまたは BlueField(あるいは適切なデバイスのパススルー設定でパブリック NGC DOCA コンテナーが実行中)と、パブリック DOCA Comm Channel Admin Tool ガイドが求める権限をオペレーターが保有していることを前提としています。

このスキルに意図的に含めていないもの

このスキルはエージェント向けガイダンスであり、サンプルやスクリプトのバンドルではありません。境界を明確にするため、意図的に以下を含めていません。また、プルリクエストで追加しないでください。

  • フラグ、サブコマンド名、出力列名をそのまま列挙したもの。 docs.nvidia.com にあるパブリック DOCA Comm Channel Admin Tool ガイドと、ユーザーのバージョンにインストールされている --help が、共通の正式な情報源です。ここに複製すると、このスキルが特定のリリースに固定され、ツールの進化に伴って気づかないうちに古くなります。このスキルでは、エージェントをそれらの情報源に誘導します。
  • あらかじめ用意された出力例。 出力はインストール状況、バージョン、チャネルの状態によって異なります。取得済みの例を掲載すると、異なるプラットフォームや状態のオペレーターに誤解を与えます。
  • 管理ツールの出力を取り込む、あらゆる言語のラッパー、パーサー、スクリプト。出力形式は文書化されています。出力に対するスクリプトを作成したいユーザーは、最新のガイドを読み、インストール済みのバージョンに合わせてパーサーを作成してください。
  • samples/ または reference/ サブツリー。 これは文書化された CLI 用の薄いローダーであり、具体的な内容はパブリックページと --help に記載されています。

読み込み順序

  1. まずこのスキルを読み、ユーザーの質問が対象範囲内であることを確認します(ユーザーは外部から comch チャネルをインベントリしたいのであり、comch API を学びたいわけではありません)。
  2. ツールの報告内容、バージョンの可用性、階層化されたエラーの範囲、可観測性、安全性に関する方針については、機能の補助ファイルを参照してください。
  3. 単一の呼び出しと照合のワークフロー(configure、build、modify、run、test、debug、および Command appendix)については、タスクの補助ファイルを参照してください。

関連スキル

  • doca-comch/SKILL.md — このツールがチャネルを一覧表示するライブラリです。すべてのトリアージセッションで併用してください。プログラム側の接続コールバックと管理ツールのチャネル状態が、同じ状況を把握するための両面です。
  • doca-public-knowledge-map/SKILL.md — 公開されている DOCA Comm Channel Admin Tool ガイドと、その他の公開 DOCA ドキュメント一式への案内です。
  • doca-version/SKILL.md — DOCA のバージョン処理に関する正式なルールです。機能に関するコンパニオンの ## Version compatibility セクションは、本文についてはこちらを参照する簡潔な補足です。
  • doca-structured-tools-contract/SKILL.md — 構造化ヘルパーツールに関する、このバンドルの検出 → 優先 → フォールバック → 報告の契約です。タスク用コンパニオンの「コマンド」付録は、この契約に従います。
  • doca-setup/SKILL.md — 環境の準備、インストールの検証、representor の可視性チェック、および公開 NGC DOCA コンテナーを使う まだ何もインストールしていない場合 の手順です。このスキルでは、前提条件が満たされていることを想定しています。
  • doca-debug/SKILL.md — 横断的なデバッグ手順です。Comm Channel Admin Tool は、コード変更を推奨する前に使用する読み取り専用の一覧表示インターフェースとして、ランタイム 層に位置付けられます。

コメント