com.redpanda/docs-mcp

Search the official Redpanda documentation and return the most relevant sections from it for a user query. Each returned section includes the url and its actual content in markdown. Use this tool for all queries that require Redpanda knowledge. Results are ordered by relevance, with the most relevant result returned first. If you know the user's deployment platform, pass "platform" so results from the other platform's docs are excluded. Note that "platform" filters the sections already retrieved rather than re-running the search, so it can return substantially fewer sections: on a broker-level question where most matches come from the other platform's docs, it can cut a 15-section response to 1 or 2. Omit "platform" if you would rather have more context and judge platform relevance yourself from each section's url. If you know which Redpanda version the user runs, pass "version" (use 'current' for the latest release; its release number is also accepted). Unlike "platform", "version" is applied during retrieval, so it does not shrink the result set: it stops the same page being returned once per indexed version, which is otherwise most of the response. Version-neutral docs (Cloud, Connect, Agentic Data Plane, API reference) are always included. Omitting "version" searches the latest release.

Retrieve full content of API reference pages by URL. Returns complete endpoint details including parameters, request/response schemas, and examples. Use this after finding pages via list_api_reference_pages or search_api_reference. Pass the URLs from those results directly. Returns up to 10 pages per request. URLs must be from docs.redpanda.com/api/doc/*.

Look up one Redpanda configuration property (cluster, broker, or topic) by exact name and return its documented type, default, description, restart and enterprise flags, Redpanda Cloud availability, related properties, and docs URL. Deterministic: it reads the generated property dataset for the requested docs version, so a property that does not exist returns found=false with close-name suggestions instead of a guess, and no LLM or search is involved. Use this before ask_redpanda_question for any question about a specific property's default, type, or availability. Pass platform='cloud' to learn whether the property is supported or editable in Redpanda Cloud.

Look up one Redpanda Connect component (input, output, processor, cache, buffer, rate_limit, metric, tracer, scanner) by type and name. Returns its status, summary, description, categories, Redpanda Cloud support, docs URL, and every configuration field as a row (path, type, default, one-line summary, advanced/optional/deprecated flags). Pass field to get one field in full: description, examples, options, child fields. Deterministic and read from the generated component schema for the published Connect release: a name that does not exist returns found=false and says whether the same name exists under another type (the redpanda input vs the redpanda output). Use this before ask_redpanda_question for any question about a specific component or field.

Look up one rpk CLI command by its full name (for example 'rpk topic create') and return its usage, help text, flags with types and defaults, aliases, subcommands, platform and Redpanda Cloud scoping, the plugin and release it ships with, and the docs page URL. Deterministic: it reads the published rpk command tree for the requested docs version (the same data the rpk reference pages are rendered from), so a command that does not exist returns found=false with close-name suggestions instead of a guess, and no LLM or search is involved. The name may omit the leading 'rpk', use command aliases at any level ('rpk topic ls', 'rpk sr schema list'), or be the page name ('rpk-topic-create'). A deprecated command returns its deprecation note and replacement, even when it is hidden and not found. Use this before ask_redpanda_question for any question about a specific rpk command's flags, defaults, or existence in a release.

Report a concrete problem to the Redpanda docs team: documentation that is missing, unclear, outdated, or wrong, a docs tool that returned something wrong or unhelpful, or a Redpanda product issue you ran into. Call it when you notice the problem, with enough detail to fix it, including the page URL when you know it. Do not call it to test the tool. It records the report and returns a short confirmation; it does not return documentation. Reports do not include the user's name or email: never include credentials, tokens, or personal data.

List pages in Redpanda API reference documentation. Returns endpoints, schemas, and topic pages with URL, title, type, and description. SCOPING (important for accurate results): - api="all" or omit: Lists all available APIs - api="admin": Cluster management operations (brokers, partitions, configs, users) - api="cloud-controlplane": Redpanda Cloud resource management (clusters, networks, namespaces) - api="cloud-dataplane": Cloud cluster data operations (topics, ACLs, connectors) - api="http-proxy": Kafka operations over HTTP (produce, consume, offsets) - api="schema-registry": Schema management (register, retrieve, compatibility) Use this to browse API structure. For general Redpanda docs, use ask_redpanda_question instead.

Search Redpanda configuration properties by a keyword in their name or description, and filter by scope (cluster, broker, topic), platform, or enterprise flag. Returns compact rows: name, scope, type, default, one-line summary, Cloud support, docs URL. Name matches rank above description matches; deprecated properties are hidden unless include_deprecated is true. Use it to find the right property name before get_config_property, or to answer 'which properties control X'. total=0 means nothing matches in that version; it never falls back to a guess.

List or search Redpanda Connect components by type, keyword (matched against name, categories, and summary), status, or Redpanda Cloud support. Returns compact rows with docs URLs. Name matches rank above category and summary matches. Use it to discover what exists (for example every 'Services' input, or every output available in Cloud) before get_connect_component. total=0 means nothing matches.

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.

Search Redpanda API reference documentation by keyword. Returns up to 20 matching endpoints, schemas, or topics with URL, title, and text excerpts. SCOPING (important for accurate results): - api="all" or omit: Search across ALL APIs at once - useful when unsure which API contains the endpoint - api="admin": Search only cluster management (brokers, partitions, configs, users, maintenance) - api="cloud-controlplane": Search only Cloud resource management (clusters, networks, namespaces) - api="cloud-dataplane": Search only Cloud data operations (topics, ACLs, connectors) - api="http-proxy": Search only HTTP Proxy (produce, consume, offsets over HTTP) - api="schema-registry": Search only Schema Registry (register, retrieve, compatibility) WHEN TO USE WHICH: - User asks "broker endpoints" → api="admin" (brokers are cluster management) - User asks "create topic API" → api="all" (topics exist in admin AND cloud-dataplane) - User asks "Cloud cluster API" → api="cloud-controlplane" - User asks about Redpanda APIs generally → api="all" or omit For general Redpanda questions (not API-specific), use ask_redpanda_question instead.