DOCA Comm Channel Admin Tool
Actual binary contract. doca_comm_channel_admin is one
zero-application-argument, read-only scan-and-print operation.
It scans every comch-capable doca_dev on the current side via
resourcedump (MFT) and prints SERVERS and CONNECTIONS tables.
It has no list, inspect, device-scope, drain, restart, or other
application operation. This skill does not retain conceptual
workflows under invented command names.
Where to start: This is a tool skill for invoking the DOCA Comm
Channel Admin Tool — the read-only inventory CLI counterpart
to the doca-comch library. The
shipped doca_comm_channel_admin binary takes no arguments
beyond ARGP defaults (--help, --version, --log-level,
--sdk-log-level, --json) and performs one inventory pass
per invocation: it walks every doca_dev on this side, filters
to comch-capable devices, shells out to resourcedump (MFT) on
each, and prints two ASCII tables (SERVERS and CONNECTIONS).
There is no list subcommand, no inspect subcommand, no
drain flag, and no restart flag — those are not part of the
tool's surface. Open TASKS.md and start at
## run for the single-shot invocation, or
## debug when the user reports the tool sees
a different channel set than the program. Open
CAPABILITIES.md when the question is what
the printed tables actually mean and what is not in this
tool's scope. If the user has not installed DOCA yet, route to
doca-setup first; if the user
needs MFT (resourcedump on PATH with the privilege documented
for the installed release), doca-setup + doca-public-knowledge-map
cover that. If the user is holding pre-2.5 docs that mention
"Comm Channel", route to
doca-comch CAPABILITIES.md ## Version compatibility
for the rename rule. If the user wants to change channel
state, route to the program-side
reconnect lifecycle in doca-comch
or to BlueField mode / driver reload in
doca-setup +
doca-hardware-safety — not
to this tool.
Example questions this skill answers well
The CLASSES of admin-tool questions this skill is built to answer,
each with one worked example. The class is the load-bearing piece;
the worked example is one instance.
- "Which comch servers and connections are currently visible?" —
worked example: "print every server and connection row visible
on this side". Answered by the scan-and-print surface in
CAPABILITIES.md ## Capabilities and modes
- the single invocation in
TASKS.md ## run.
- "What does the tool report for this server or connection?" —
locate the matching row in the SERVERS or CONNECTIONS table;
there is no second per-channel query. Answered by
CAPABILITIES.md ## Capabilities and modes
- "How do I know the admin tool's view matches what my Comch
program sees?" — worked example: "the program reports
CONNECTED but the admin tool lists zero channels". Answered by
the cross-checking pattern in
TASKS.md ## test and the representor-binding
layer in
CAPABILITIES.md ## Error taxonomy.
- "Is this admin tool on my installed DOCA version, and does it
match the comch library version?" — worked example: "is the
tool available on DOCA 2.4". Answered by the overlay in
CAPABILITIES.md ## Version compatibility,
which redirects to the canonical
doca-version rules and adds the
Comm Channel Admin Tool specifics.
- "The tool prints nothing — is the install broken or is there
genuinely no channel?" — worked example: "
list returned an
empty result on a host with a known-good Comch client".
Answered by the empty-output interpretation rules in
TASKS.md ## debug +
CAPABILITIES.md ## Error taxonomy.
Audience
This skill serves external operators and AI agents who need to
inventory a host-DPU comch channel from the outside
— after the doca-comch library
has been used to create the channel from a program. Concretely:
- A platform operator who runs a Comch-using service on BlueField
and needs to confirm the channel is healthy before declaring the
service ready.
- A developer of a Comch consumer who sees
DOCA_ERROR_AGAIN or a
silent stall on the program side and wants to read the channel's
state from outside the program rather than guessing.
- An AI agent capturing the external server/connection rows before
recommending a program-side code or lifecycle change.
It is not for users debugging the admin tool itself, not a
substitute for the live public DOCA Comm Channel Admin Tool guide,
and not the right place for users learning the comch API —
that audience belongs in
doca-comch.
The tool is shipped as a CLI binary under
/opt/mellanox/doca/tools/, not a library you link against. The
skill uses the same kind: tool three-file shape as the rest of
the bundle so the agent's task-verb contract
(configure / build / modify / run / test / debug) is uniform
across libraries, services, and tools.
When to load this skill
Load this skill when the user is — or the agent needs to — invoke
the DOCA Comm Channel Admin Tool on a real host or BlueField Arm
with DOCA installed (or inside the public NGC DOCA container with
the right device passthrough). Concretely:
- Listing currently active comch channels on a host or DPU.
- Reading the row for one named server or connection from the
complete zero-argument scan.
- Cross-checking the admin tool's view against the program-side
connection callback state when the two appear to disagree.
- Capturing a side-effect-free channel snapshot as prerequisite
evidence for a later debug session that crosses program /
channel / driver layers.
Do not load this skill for general DOCA orientation, the comch
programming API, library install, or comch protocol design. For
those, route to
doca-public-knowledge-map,
doca-comch, or
doca-setup.
What this skill provides
This is a thin loader. Substantive material lives in two
companion files:
CAPABILITIES.md — what the Comm Channel Admin Tool reports:
the two read-only tables, the version-availability overlay
that redirects to doca-version,
the layered error taxonomy (tool-not-installed / device-binding
/ channel-discovery / channel-state-stuck / permission /
version / cross-cutting), the tool's role as an observability
primitive for doca-comch
debug sessions, and the read-only safety policy.
TASKS.md — step-by-step workflows for the in-scope task verbs:
configure (route to install), build (route to install),
modify (refuse), run (one scan-and-print), test
(cross-check the printed rows), debug (the layered
diagnosis ladder), plus a Deferred task verbs block and a
Command appendix that honors the bundle's
doca-structured-tools-contract
preamble.
The skill assumes a host or BlueField where DOCA is already
installed (or the public NGC DOCA container is running with the
right device passthrough) and the operator has whatever privileges
the public DOCA Comm Channel Admin Tool guide requires.
What this skill deliberately does not ship
This skill is agent guidance, not a samples or scripts bundle.
To keep the boundary clean, it deliberately does not contain — and
pull requests should not add:
- Verbatim flag inventories, subcommand names, or output column
names. The public DOCA Comm Channel Admin Tool guide on
docs.nvidia.com and the installed --help on the user's
version are the joint source of truth; copying them here pins
the skill to one release and silently rots when the tool
evolves. The skill routes the agent at those sources instead.
- Pre-baked example output. Output is install-, version-, and
channel-state-specific. A captured example will mislead an
operator on a different platform / state.
- Wrappers, parsers, or scripts in any language that consume
the admin tool's output. The output format is documented; users
who want to script against it should read the live guide and
write the parser against their installed version.
- A
samples/ or reference/ subtree. This is a thin loader
for a documented CLI; substantive material lives on the public
page and in --help.
Loading order
- Read this
SKILL.md first to confirm the user's question is in
scope (the user wants to inventory a comch
channel from the outside, not learn the comch API).
- For what the tool reports, version availability, the layered error surface,
observability, and safety posture, see
CAPABILITIES.md.
- For the single invocation and cross-check
workflow —
configure, build, modify, run, test,
debug, plus the Command appendix — see
TASKS.md.
Related skills
doca-comch — the library
whose channels this tool inventories. Pair them in every
triage session: the program-side connection callback and the
admin tool's channel state are the two halves of the same
picture.
doca-public-knowledge-map
— routing to the public DOCA Comm Channel Admin Tool guide and
the rest of the public DOCA documentation set.
doca-version — canonical DOCA
version-handling rules. The ## Version compatibility section
in CAPABILITIES.md is a concise overlay
that redirects here for the body.
doca-structured-tools-contract
— the bundle's detect → prefer → fall back → report contract for
structured helper tools. The Command appendix in
TASKS.md honors this contract.
doca-setup — env preparation,
install verification, representor visibility checks, and the
I have no install yet path with the public NGC DOCA
container. This skill assumes its preconditions are satisfied.
doca-debug — the cross-cutting
debug ladder. The Comm Channel Admin Tool slots in at the
runtime layer as the read-only inventory surface before any
code change is recommended.
1---2name: doca-comm-channel-admin3description: Use this skill to enumerate host↔DPU DOCA comch (formerly Comm Channel) servers and connections via the shipped doca_comm_channel_admin binary — listing comch-capable devices and decoding the per-device server / connection table (server name, PID, in-use / max, PCIe address). The shipped binary is a SINGLE-SHOT SCAN-AND-PRINT tool with no registered arguments — NO list / inspect / drain / restart subcommands; one inventory pass over every comch-capable doca_dev on this side. Channel reset / drain / restart go to doca-comch (program side), doca-setup / doca-hardware-safety (driver reload), or BFB / RShim — NOT to this binary. Trigger on phrasings like "list comch servers", "which channels are active on this BlueField", or "verify admin tool sees same channel as program." Refuse and route elsewhere for the comch programming API, library install, protocol design, channel reset, or general orientation.4license: Apache-2.05---67# DOCA Comm Channel Admin Tool89> **Actual binary contract.** `doca_comm_channel_admin` is one10> zero-application-argument, read-only scan-and-print operation.11> It scans every comch-capable `doca_dev` on the current side via12> `resourcedump` (MFT) and prints SERVERS and CONNECTIONS tables.13> It has no list, inspect, device-scope, drain, restart, or other14> application operation. This skill does not retain conceptual15> workflows under invented command names.1617**Where to start:** This is a tool skill for invoking the DOCA Comm18Channel Admin Tool — the **read-only inventory** CLI counterpart19to the [`doca-comch`](../../libs/doca-comch/SKILL.md) library. The20shipped `doca_comm_channel_admin` binary takes **no arguments21beyond ARGP defaults** (`--help`, `--version`, `--log-level`,22`--sdk-log-level`, `--json`) and performs **one inventory pass**23per invocation: it walks every `doca_dev` on this side, filters24to comch-capable devices, shells out to `resourcedump` (MFT) on25each, and prints two ASCII tables (SERVERS and CONNECTIONS).26There is no `list` subcommand, no `inspect` subcommand, no27`drain` flag, and no `restart` flag — those are not part of the28tool's surface. Open [`TASKS.md`](TASKS.md) and start at29[`## run`](TASKS.md#run) for the single-shot invocation, or30[`## debug`](TASKS.md#debug) when the user reports the tool sees31a different channel set than the program. Open32[`CAPABILITIES.md`](CAPABILITIES.md) when the question is *what33the printed tables actually mean* and *what is not in this34tool's scope*. If the user has not installed DOCA yet, route to35[`doca-setup`](../../doca-setup/SKILL.md) first; if the user36needs MFT (`resourcedump` on `PATH` with the privilege documented37for the installed release), `doca-setup` + `doca-public-knowledge-map`38cover that. If the user is holding pre-2.5 docs that mention39"Comm Channel", route to40[`doca-comch CAPABILITIES.md ## Version compatibility`](../../libs/doca-comch/CAPABILITIES.md#version-compatibility)41for the rename rule. If the user wants to *change* channel42state, route to the program-side43reconnect lifecycle in [`doca-comch`](../../libs/doca-comch/SKILL.md)44or to BlueField mode / driver reload in45[`doca-setup`](../../doca-setup/SKILL.md) +46[`doca-hardware-safety`](../../doca-hardware-safety/SKILL.md) — **not**47to this tool.4849## Example questions this skill answers well5051The CLASSES of admin-tool questions this skill is built to answer,52each with one worked example. The class is the load-bearing piece;53the worked example is one instance.5455- **"Which comch servers and connections are currently visible?"** —56 worked example: *"print every server and connection row visible57 on this side"*. Answered by the scan-and-print surface in58 [`CAPABILITIES.md ## Capabilities and modes`](CAPABILITIES.md#capabilities-and-modes)59 + the single invocation in60 [`TASKS.md ## run`](TASKS.md#run).61- **"What does the tool report for this server or connection?"** —62 locate the matching row in the SERVERS or CONNECTIONS table;63 there is no second per-channel query. Answered by64 [`CAPABILITIES.md ## Capabilities and modes`](CAPABILITIES.md#capabilities-and-modes)65 + [`TASKS.md ## run`](TASKS.md#run).66- **"How do I know the admin tool's view matches what my Comch67 program sees?"** — worked example: *"the program reports68 CONNECTED but the admin tool lists zero channels"*. Answered by69 the cross-checking pattern in70 [`TASKS.md ## test`](TASKS.md#test) and the representor-binding71 layer in72 [`CAPABILITIES.md ## Error taxonomy`](CAPABILITIES.md#error-taxonomy).73- **"Is this admin tool on my installed DOCA version, and does it74 match the comch library version?"** — worked example: *"is the75 tool available on DOCA 2.4"*. Answered by the overlay in76 [`CAPABILITIES.md ## Version compatibility`](CAPABILITIES.md#version-compatibility),77 which redirects to the canonical78 [`doca-version`](../../doca-version/SKILL.md) rules and adds the79 Comm Channel Admin Tool specifics.80- **"The tool prints nothing — is the install broken or is there81 genuinely no channel?"** — worked example: *"`list` returned an82 empty result on a host with a known-good Comch client"*.83 Answered by the empty-output interpretation rules in84 [`TASKS.md ## debug`](TASKS.md#debug) +85 [`CAPABILITIES.md ## Error taxonomy`](CAPABILITIES.md#error-taxonomy).8687## Audience8889This skill serves **external operators and AI agents who need to90inventory a host-DPU comch channel from the outside**91— after the [`doca-comch`](../../libs/doca-comch/SKILL.md) library92has been used to create the channel from a program. Concretely:9394- A platform operator who runs a Comch-using service on BlueField95 and needs to confirm the channel is healthy before declaring the96 service ready.97- A developer of a Comch consumer who sees `DOCA_ERROR_AGAIN` or a98 silent stall on the program side and wants to read the channel's99 state from outside the program rather than guessing.100- An AI agent capturing the external server/connection rows before101 recommending a program-side code or lifecycle change.102103It is **not** for users debugging the admin tool itself, **not** a104substitute for the live public DOCA Comm Channel Admin Tool guide,105and **not** the right place for users learning the comch API —106that audience belongs in107[`doca-comch`](../../libs/doca-comch/SKILL.md).108109The tool is shipped as a CLI binary under110`/opt/mellanox/doca/tools/`, not a library you link against. The111skill uses the same `kind: tool` three-file shape as the rest of112the bundle so the agent's task-verb contract113(`configure / build / modify / run / test / debug`) is uniform114across libraries, services, and tools.115116## When to load this skill117118Load this skill when the user is — or the agent needs to — invoke119the DOCA Comm Channel Admin Tool on a real host or BlueField Arm120with DOCA installed (or inside the public NGC DOCA container with121the right device passthrough). Concretely:122123- Listing currently active comch channels on a host or DPU.124- Reading the row for one named server or connection from the125 complete zero-argument scan.126- Cross-checking the admin tool's view against the program-side127 connection callback state when the two appear to disagree.128- Capturing a side-effect-free channel snapshot as prerequisite129 evidence for a later debug session that crosses program /130 channel / driver layers.131132Do **not** load this skill for general DOCA orientation, the comch133programming API, library install, or comch protocol design. For134those, route to135[`doca-public-knowledge-map`](../../doca-public-knowledge-map/SKILL.md),136[`doca-comch`](../../libs/doca-comch/SKILL.md), or137[`doca-setup`](../../doca-setup/SKILL.md).138139## What this skill provides140141This is a **thin loader**. Substantive material lives in two142companion files:143144- `CAPABILITIES.md` — what the Comm Channel Admin Tool reports:145 the two read-only tables, the version-availability overlay146 that redirects to [`doca-version`](../../doca-version/SKILL.md),147 the layered error taxonomy (tool-not-installed / device-binding148 / channel-discovery / channel-state-stuck / permission /149 version / cross-cutting), the tool's role as an observability150 primitive for [`doca-comch`](../../libs/doca-comch/SKILL.md)151 debug sessions, and the read-only safety policy.152- `TASKS.md` — step-by-step workflows for the in-scope task verbs:153 `configure` (route to install), `build` (route to install),154 `modify` (refuse), `run` (one scan-and-print), `test`155 (cross-check the printed rows), `debug` (the layered156 diagnosis ladder), plus a `Deferred task verbs` block and a157 `Command appendix` that honors the bundle's158 [`doca-structured-tools-contract`](../../doca-structured-tools-contract/SKILL.md)159 preamble.160161The skill assumes a host or BlueField where DOCA is already162installed (or the public NGC DOCA container is running with the163right device passthrough) and the operator has whatever privileges164the public DOCA Comm Channel Admin Tool guide requires.165166## What this skill deliberately does not ship167168This skill is **agent guidance**, not a samples or scripts bundle.169To keep the boundary clean, it deliberately does not contain — and170pull requests should not add:171172- **Verbatim flag inventories, subcommand names, or output column173 names.** The public DOCA Comm Channel Admin Tool guide on174 `docs.nvidia.com` and the installed `--help` on the user's175 version are the joint source of truth; copying them here pins176 the skill to one release and silently rots when the tool177 evolves. The skill routes the agent at those sources instead.178- **Pre-baked example output.** Output is install-, version-, and179 channel-state-specific. A captured example will mislead an180 operator on a different platform / state.181- **Wrappers, parsers, or scripts** in any language that consume182 the admin tool's output. The output format is documented; users183 who want to script against it should read the live guide and184 write the parser against their installed version.185- **A `samples/` or `reference/` subtree.** This is a thin loader186 for a documented CLI; substantive material lives on the public187 page and in `--help`.188189## Loading order1901911. Read this `SKILL.md` first to confirm the user's question is in192 scope (the user wants to inventory a comch193 channel from the outside, not learn the comch API).1942. **For what the tool reports, version availability, the layered error surface,195 observability, and safety posture, see196 [CAPABILITIES.md](CAPABILITIES.md).**1973. **For the single invocation and cross-check198 workflow — `configure`, `build`, `modify`, `run`, `test`,199 `debug`, plus the `Command appendix` — see200 [TASKS.md](TASKS.md).**201202## Related skills203204- [`doca-comch`](../../libs/doca-comch/SKILL.md) — the library205 whose channels this tool inventories. Pair them in every206 triage session: the program-side connection callback and the207 admin tool's channel state are the two halves of the same208 picture.209- [`doca-public-knowledge-map`](../../doca-public-knowledge-map/SKILL.md)210 — routing to the public DOCA Comm Channel Admin Tool guide and211 the rest of the public DOCA documentation set.212- [`doca-version`](../../doca-version/SKILL.md) — canonical DOCA213 version-handling rules. The `## Version compatibility` section214 in [`CAPABILITIES.md`](CAPABILITIES.md) is a concise overlay215 that redirects here for the body.216- [`doca-structured-tools-contract`](../../doca-structured-tools-contract/SKILL.md)217 — the bundle's detect → prefer → fall back → report contract for218 structured helper tools. The Command appendix in219 [`TASKS.md`](TASKS.md) honors this contract.220- [`doca-setup`](../../doca-setup/SKILL.md) — env preparation,221 install verification, representor visibility checks, and the222 *I have no install yet* path with the public NGC DOCA223 container. This skill assumes its preconditions are satisfied.224- [`doca-debug`](../../doca-debug/SKILL.md) — the cross-cutting225 debug ladder. The Comm Channel Admin Tool slots in at the226 *runtime* layer as the read-only inventory surface before any227 code change is recommended.