docs-mcp
Get authoritative answers about Redpanda documentation and search API references.
Should I use this
Quality & Safety
Based on automated analysis of tool definitions and protocol compliance.
Context Cost
This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.
Install
One-Click Install
Add this to your `claude_desktop_config.json` file:
{
"mcpServers": {
"docs-mcp": {
"url": "https://docs.redpanda.com/mcp"
}
}
}Remote endpoints
https://docs.redpanda.com/mcpstreamable-httpWhat it can do
Tool inventory
Tools (9)
🟢ask_redpanda_question(question, query, platform, version, top_k, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"question": {
"type": "string",
"description": "The question to search the docs for. Required."
},
"query": {
"type": "string",
"description": "Alias for \"question\", for clients that use that name. Prefer \"question\"."
},
"platform": {
"type": "string",
"enum": [
"cloud",
"self-managed"
],
"description": "The user's deployment platform. 'cloud' excludes Self-Managed sections; 'self-managed' excludes Redpanda Cloud sections. Platform-neutral docs (Connect, API reference, labs) are always kept. Applied after retrieval, so it shrinks the result set rather than finding more of the right platform's pages. Omit to search all docs."
},
"version": {
"type": "string",
"description": "Docs version to search, written as the docs URLs spell it (23.3, 24.1, 24.2, 24.3, 25.1, 25.2, 25.3, 26.1, current). Use 'current' for the latest release; a release number newer than every listed one is also read as the latest release. Applied at retrieval, so unlike \"platform\" it does not shrink the result set: every section returned is from this version, plus version-neutral docs (Cloud, Connect, Agentic Data Plane, API reference), which are always included. Omit to search the latest release. Any other value is rejected with the list of valid versions."
},
"top_k": {
"type": "integer",
"exclusiveMinimum": 0,
"description": "Maximum number of sections to return, applied after platform filtering. Must be a positive integer."
},
"context": {
"type": "string",
"description": "Optional. 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."
},
"session_goal": {
"type": "string",
"description": "Optional. 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."
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢list_api_reference_pages(api, url, context, session_goal)
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.
Input Schema
{
"type": "object",
"properties": {
"api": {
"type": "string",
"description": "Which API to list: \"all\" or omit for overview of all APIs, or a specific API name (admin, cloud-controlplane, cloud-dataplane, http-proxy, schema-registry)"
},
"url": {
"type": "string",
"description": "Specific URL path to list children of (optional, defaults to API root)"
},
"context": {
"type": "string",
"description": "Optional. 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."
},
"session_goal": {
"type": "string",
"description": "Optional. 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."
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢search_api_reference(api, query, type, context, session_goal)
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.
Input Schema
{
"type": "object",
"properties": {
"api": {
"type": "string",
"description": "Scope: \"all\" or omit to search all APIs, or specific API name (admin, cloud-controlplane, cloud-dataplane, http-proxy, schema-registry)"
},
"query": {
"type": "string",
"description": "Search keywords (e.g., \"broker\", \"create topic\", \"ACL\")"
},
"type": {
"type": "string",
"description": "Filter by result type. Known values: operation (endpoints), request, response, property, model, message, guide, group, api, hub, binding. Optional; a value the index does not recognise is ignored and the search runs unfiltered."
},
"context": {
"type": "string",
"description": "Optional. 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."
},
"session_goal": {
"type": "string",
"description": "Optional. 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."
}
},
"required": [
"query"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢get_api_reference_content(urls, context, session_goal)
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/*.
Input Schema
{
"type": "object",
"properties": {
"urls": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 10,
"description": "Page URLs to retrieve (max 10). Use URLs from list_api_reference_pages or search_api_reference results."
},
"context": {
"type": "string",
"description": "Optional. 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."
},
"session_goal": {
"type": "string",
"description": "Optional. 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."
}
},
"required": [
"urls"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}⚪give_feedback(title, message, expected, context, category, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "A one-line summary of the problem, for example 'Webhook docs list the wrong signature header'."
},
"message": {
"type": "string",
"description": "What happened: the error, wrong result, or missing or contradictory information, with the pages, endpoints, or tools involved."
},
"expected": {
"type": "string",
"description": "What you expected to happen or to find instead."
},
"context": {
"type": "string",
"description": "What you were trying to accomplish, in general terms."
},
"category": {
"type": "string",
"enum": [
"documentation",
"docs_search",
"product",
"product_mcp_tool"
],
"description": "What you saw: 'documentation' (docs missing, unclear, outdated, or wrong; the default), 'docs_search' (a search or document tool on this server misbehaved), 'product' (a bug, limitation, or missing feature in Redpanda), or 'product_mcp_tool' (another Redpanda tool failed or behaved unexpectedly)."
},
"severity": {
"type": "string",
"enum": [
"high",
"medium",
"low"
],
"description": "'high' if you are blocked, 'medium' if you found a workaround (the default), 'low' for a minor annoyance."
},
"tool_name": {
"type": "string",
"description": "The exact name of the tool that failed or misbehaved, if any."
},
"session_goal": {
"type": "string",
"description": "Optional. 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."
}
},
"required": [
"message"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢get_config_property(name, version, platform, context, session_goal)
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.
Input Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "Exact property name, e.g. 'log_segment_size' or 'cleanup.policy'. Aliases are accepted."
},
"version": {
"type": "string",
"description": "Docs version as its URL spells it ('26.1'), 'current' for the latest release, or a release tag ('v26.2.4'). Omit for the latest release. An unknown value returns found=false with the list of published versions. Ignored when platform is 'cloud', which always answers from the latest release."
},
"platform": {
"type": "string",
"enum": [
"self-managed",
"cloud"
],
"description": "'cloud' answers for Redpanda Cloud (Cloud availability, the Cloud docs page); 'self-managed' (the default) answers for Self-Managed Redpanda."
},
"context": {
"type": "string",
"description": "Optional. 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."
},
"session_goal": {
"type": "string",
"description": "Optional. 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."
}
},
"required": [
"name"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Output Schema
{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Set when the call was not answered: 'anonymous_quota_exhausted' or 'data_unavailable'."
},
"message": {
"type": "string"
},
"limit": {
"type": "number",
"description": "Quota refusal only."
},
"resets_at": {
"type": "string",
"description": "Quota refusal only."
},
"sign_in_url": {
"type": "string",
"description": "Quota refusal only."
},
"found": {
"type": "boolean",
"description": "Absent only when `error` is set."
},
"name": {
"type": "string"
},
"reason": {
"type": "string",
"enum": [
"not_found",
"unknown_version"
],
"description": "Why found is false."
},
"note": {
"type": "string",
"description": "How the version or platform was interpreted, when not literally."
},
"matched_via": {
"type": "string",
"enum": [
"name",
"alias"
]
},
"property": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"scope": {
"type": "string",
"enum": [
"cluster",
"broker",
"topic"
]
},
"type": {
"type": "string"
},
"description": {
"type": "string"
},
"default": {},
"default_human_readable": {
"type": "string"
},
"nullable": {
"type": "boolean"
},
"visibility": {
"type": "string"
},
"needs_restart": {
"type": "boolean"
},
"is_enterprise": {
"type": "boolean"
},
"enterprise_value": {},
"is_deprecated": {
"type": "boolean"
},
"introduced_in": {
"type": "string"
},
"minimum": {
"type": "number"
},
"maximum": {
"type": "number"
},
"enum": {
"type": "array"
},
"acceptable_values": {},
"example": {
"type": "string"
},
"aliases": {
"type": "array",
"items": {
"type": "string"
}
},
"corresponding_cluster_property": {
"type": "string"
},
"related_properties": {
"type": "array",
"items": {
"type": "string"
}
},
"cloud": {
"type": "object",
"properties": {
"supported": {
"type": "boolean"
},
"editable": {
"type": "boolean"
},
"readonly": {
"type": "boolean"
},
"byoc_only": {
"type": "boolean"
},
"documented": {
"type": "boolean"
},
"summary": {
"type": "string"
}
},
"required": [
"supported",
"editable",
"readonly",
"byoc_only",
"summary"
],
"additionalProperties": true
},
"docs_url": {
"type": "string"
}
},
"required": [
"name",
"is_enterprise",
"is_deprecated",
"cloud"
],
"additionalProperties": true
},
"suggestions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Close property names, when not found."
},
"dataset": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"self-managed",
"cloud"
]
},
"version": {
"type": [
"string",
"null"
],
"description": "Docs version, e.g. '26.2'. Null for Cloud."
},
"version_segment": {
"type": [
"string",
"null"
],
"description": "URL segment, e.g. 'current' or '26.1'."
},
"tag": {
"type": "string",
"description": "Release the data was generated from, e.g. 'v26.2.4'."
},
"latest": {
"type": "boolean"
},
"url": {
"type": "string",
"description": "The dataset this answer was read from."
}
},
"required": [
"platform",
"tag",
"url"
],
"additionalProperties": true
},
"valid_versions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"version": {
"type": [
"string",
"null"
]
},
"segment": {
"type": [
"string",
"null"
]
},
"tag": {
"type": "string"
},
"latest": {
"type": "boolean"
},
"prerelease": {
"type": "boolean"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢list_config_properties(query, scope, platform, version, enterprise, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"query": {
"type": "string",
"description": "Keyword matched against property names and descriptions, e.g. 'retention' or 'tls'. Omit to list by filter only."
},
"scope": {
"type": "string",
"enum": [
"cluster",
"broker",
"topic"
],
"description": "Only properties of this scope."
},
"platform": {
"type": "string",
"enum": [
"self-managed",
"cloud"
],
"description": "'cloud' answers for Redpanda Cloud (Cloud availability, the Cloud docs page); 'self-managed' (the default) answers for Self-Managed Redpanda."
},
"version": {
"type": "string",
"description": "Docs version as its URL spells it ('26.1'), 'current' for the latest release, or a release tag ('v26.2.4'). Omit for the latest release. An unknown value returns found=false with the list of published versions. Ignored when platform is 'cloud', which always answers from the latest release."
},
"enterprise": {
"type": "boolean",
"description": "true: only enterprise-licensed properties; false: only non-enterprise."
},
"include_deprecated": {
"type": "boolean",
"description": "Include deprecated properties (default false)."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Maximum rows to return (default 25, max 100)."
},
"context": {
"type": "string",
"description": "Optional. 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."
},
"session_goal": {
"type": "string",
"description": "Optional. 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."
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Output Schema
{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Set when the call was not answered: 'anonymous_quota_exhausted' or 'data_unavailable'."
},
"message": {
"type": "string"
},
"limit": {
"type": "number",
"description": "Quota refusal only."
},
"resets_at": {
"type": "string",
"description": "Quota refusal only."
},
"sign_in_url": {
"type": "string",
"description": "Quota refusal only."
},
"total": {
"type": "integer",
"description": "Matches before the limit. Absent only when `error` is set."
},
"returned": {
"type": "integer"
},
"properties": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"scope": {
"type": "string",
"enum": [
"cluster",
"broker",
"topic"
]
},
"type": {
"type": "string"
},
"default": {},
"summary": {
"type": "string"
},
"is_enterprise": {
"type": "boolean"
},
"is_deprecated": {
"type": "boolean"
},
"needs_restart": {
"type": "boolean"
},
"cloud_supported": {
"type": "boolean"
},
"cloud_documented": {
"type": "boolean"
},
"docs_url": {
"type": "string"
}
},
"required": [
"name",
"is_enterprise",
"cloud_supported"
],
"additionalProperties": true
}
},
"reason": {
"type": "string",
"enum": [
"unknown_version"
]
},
"note": {
"type": "string"
},
"dataset": {
"type": "object",
"properties": {
"platform": {
"type": "string",
"enum": [
"self-managed",
"cloud"
]
},
"version": {
"type": [
"string",
"null"
],
"description": "Docs version, e.g. '26.2'. Null for Cloud."
},
"version_segment": {
"type": [
"string",
"null"
],
"description": "URL segment, e.g. 'current' or '26.1'."
},
"tag": {
"type": "string",
"description": "Release the data was generated from, e.g. 'v26.2.4'."
},
"latest": {
"type": "boolean"
},
"url": {
"type": "string",
"description": "The dataset this answer was read from."
}
},
"required": [
"platform",
"tag",
"url"
],
"additionalProperties": true
},
"valid_versions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"version": {
"type": [
"string",
"null"
]
},
"segment": {
"type": [
"string",
"null"
]
},
"tag": {
"type": "string"
},
"latest": {
"type": "boolean"
},
"prerelease": {
"type": "boolean"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢get_connect_component(type, name, field, context, session_goal)
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.
Input Schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"input",
"output",
"processor",
"cache",
"buffer",
"rate_limit",
"metric",
"tracer",
"scanner"
],
"description": "Component type."
},
"name": {
"type": "string",
"minLength": 1,
"description": "Component name as it appears in a config, e.g. 'kafka_franz', 'redpanda', 'mapping'."
},
"field": {
"type": "string",
"description": "One field path for full detail, e.g. 'batching.count' or 'cases[].check'."
},
"context": {
"type": "string",
"description": "Optional. 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."
},
"session_goal": {
"type": "string",
"description": "Optional. 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."
}
},
"required": [
"type",
"name"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Output Schema
{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Set when the call was not answered: 'anonymous_quota_exhausted' or 'data_unavailable'."
},
"message": {
"type": "string"
},
"limit": {
"type": "number",
"description": "Quota refusal only."
},
"resets_at": {
"type": "string",
"description": "Quota refusal only."
},
"sign_in_url": {
"type": "string",
"description": "Quota refusal only."
},
"found": {
"type": "boolean",
"description": "Absent only when `error` is set."
},
"type": {
"type": "string",
"enum": [
"input",
"output",
"processor",
"cache",
"buffer",
"rate_limit",
"metric",
"tracer",
"scanner"
]
},
"name": {
"type": "string"
},
"reason": {
"type": "string",
"enum": [
"not_found"
]
},
"component": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"input",
"output",
"processor",
"cache",
"buffer",
"rate_limit",
"metric",
"tracer",
"scanner"
]
},
"status": {
"type": "string"
},
"summary": {
"type": "string"
},
"description": {
"type": "string"
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"cloud_supported": {
"type": "boolean"
},
"cloud_only": {
"type": "boolean"
},
"introduced_in": {
"type": "string"
},
"docs_url": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"type": {
"type": "string"
},
"kind": {
"type": "string"
},
"default": {},
"summary": {
"type": "string"
},
"advanced": {
"type": "boolean"
},
"optional": {
"type": "boolean"
},
"deprecated": {
"type": "boolean"
},
"secret": {
"type": "boolean"
},
"interpolated": {
"type": "boolean"
},
"introduced_in": {
"type": "string"
},
"options": {
"type": "array"
}
},
"required": [
"path"
],
"additionalProperties": true
}
},
"field": {},
"field_not_found": {
"type": "string"
},
"field_suggestions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"name",
"type",
"cloud_supported"
],
"additionalProperties": true
},
"suggestions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"input",
"output",
"processor",
"cache",
"buffer",
"rate_limit",
"metric",
"tracer",
"scanner"
]
},
"name": {
"type": "string"
}
},
"required": [
"type",
"name"
],
"additionalProperties": false
}
},
"dataset": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "Redpanda Connect release the data was generated from."
},
"url": {
"type": "string"
}
},
"required": [
"version",
"url"
],
"additionalProperties": true
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}🟢list_connect_components(type, query, status, cloud_supported, limit, ...)
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.
Input Schema
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"input",
"output",
"processor",
"cache",
"buffer",
"rate_limit",
"metric",
"tracer",
"scanner"
],
"description": "Only components of this type. Omit for all types."
},
"query": {
"type": "string",
"description": "Keyword, e.g. 'kafka', 'postgres', 'aws'."
},
"status": {
"type": "string",
"enum": [
"stable",
"beta",
"experimental",
"deprecated"
],
"description": "Only components with this status."
},
"cloud_supported": {
"type": "boolean",
"description": "true: only components available in Redpanda Cloud; false: only self-managed-only ones."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Maximum rows to return (default 25, max 100)."
},
"context": {
"type": "string",
"description": "Optional. 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."
},
"session_goal": {
"type": "string",
"description": "Optional. 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."
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Output Schema
{
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Set when the call was not answered: 'anonymous_quota_exhausted' or 'data_unavailable'."
},
"message": {
"type": "string"
},
"limit": {
"type": "number",
"description": "Quota refusal only."
},
"resets_at": {
"type": "string",
"description": "Quota refusal only."
},
"sign_in_url": {
"type": "string",
"description": "Quota refusal only."
},
"total": {
"type": "integer",
"description": "Absent only when `error` is set."
},
"returned": {
"type": "integer"
},
"components": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"input",
"output",
"processor",
"cache",
"buffer",
"rate_limit",
"metric",
"tracer",
"scanner"
]
},
"status": {
"type": "string"
},
"summary": {
"type": "string"
},
"categories": {
"type": "array",
"items": {
"type": "string"
}
},
"cloud_supported": {
"type": "boolean"
},
"docs_url": {
"type": "string"
}
},
"required": [
"name",
"type",
"cloud_supported"
],
"additionalProperties": true
}
},
"dataset": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "Redpanda Connect release the data was generated from."
},
"url": {
"type": "string"
}
},
"required": [
"version",
"url"
],
"additionalProperties": true
}
},
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}Community
Evidence