Skip to main content
Glama

List rpk Commands

list_rpk_commands
Read-only

List or search rpk CLI commands for a docs version. Filter by a keyword matched against command names and help text, by parent command (for example parent='rpk topic' lists its direct subcommands), or by plugin (connect, ai, k8s, check). Returns compact rows: name, usage, one-line summary, subcommand and flag counts, Cloud scoping, plugin, docs URL. Name matches rank above help-text matches; deprecated commands are hidden unless include_deprecated is true. Use it to find the right command name before get_rpk_command, or to answer 'which rpk commands do X'. total=0 means nothing matches in that version; it never falls back to a guess.

Input Schema

NameRequiredDescriptionDefault
limitNoMaximum rows to return (default 25, max 100).
queryNoKeyword, e.g. 'partition', 'decommission', or a partial name like 'topic cre'.
parentNoList the direct subcommands of this command, e.g. 'rpk cluster' or 'rpk'.
pluginNoOnly commands of this rpk plugin.
contextNoOptional. In one concise sentence (third person), describe what the user is trying to accomplish with this request. Do not include credentials, tokens, personal data, or verbatim secrets.
versionNoDocs version as its URL spells it ('26.1'), 'current' for the latest release, or a Redpanda release tag ('v26.2.2'). Omit for the latest release. An unknown value returns found=false with the list of published versions.
session_goalNoOptional. In one concise sentence (third person), the overall goal of this session: what the user is trying to get done, not just this call. Send the same goal on every call in the session, and update it only if the goal changes. Do not include credentials, tokens, personal data, or verbatim secrets.
include_deprecatedNoInclude deprecated commands (default false).

Output Schema

NameRequiredDescriptionDefault
noteNo
errorNoSet when the call was not answered: 'anonymous_quota_exhausted' or 'data_unavailable'.
limitNoQuota refusal only.
totalNoMatches before the limit. Absent only when `error` is set.
reasonNo
datasetNo
messageNo
commandsNo
returnedNo
resets_atNoQuota refusal only.
sign_in_urlNoQuota refusal only.
valid_versionsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the readOnly/no-open-world annotations it discloses ranking behavior (name matches rank above help-text matches), the deprecation default, and that total=0 is authoritative with no fallback. It doesn't cover pagination mechanics beyond the limit cap or anything about response ordering ties, so it stops short of fully exhaustive.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with purpose, then filter modes, then return shape, then selection guidance — a sensible ordering with no filler. It is dense (four sentences of packed clauses) but nearly every clause carries operational information; only the returned-fields enumeration edges toward redundancy with the output schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 8-parameter, zero-required list tool with an output schema, the description supplies what the structured fields cannot: ranking, deprecation behavior, and the semantics of an empty result. Nothing an agent needs to invoke it correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description earns above that by clarifying that the keyword is matched against both command names AND help text (the schema only says 'Keyword'), and by giving a concrete parent example ('rpk topic' lists direct subcommands). It does not explain how multiple filters combine (query + parent + plugin), which is the main remaining ambiguity.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource (list/search rpk CLI commands for a docs version) and explicitly positions itself against the sibling get_rpk_command as the discovery step that precedes it. An agent can distinguish it from get_rpk_command and the API-reference list tools without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Names the trigger scenarios directly ('find the right command name before get_rpk_command', 'which rpk commands do X') and defines the zero-result contract so the agent knows not to retry or guess. Filter modes (query/parent/plugin) are each given a purpose, which amounts to explicit routing guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.