MCP 服务器

docs-mcp

com.redpanda/docs-mcp
开发者工具 知识与文档 公开且可连接 MCP 2026-07-28

此 MCP 可以做什么

Searches official Redpanda documentation and API references, retrieves endpoint details, and submits documentation feedback with consent.

ask_redpanda_question
Search Redpanda Sources
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.
只读
输入模式
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['question'], 'properties': {'top_k': {'type': 'integer', 'description': 'Maximum number of sections to return, applied after platform filtering. Must be a positive integer.', 'exclusiveMinimum': 0}, '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.'}, '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.'}, 'platform': {'enum': ['cloud', 'self-managed'], 'type': 'string', '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."}, 'question': {'type': 'string'}}, 'additionalProperties': False}
get_api_reference_content
Get API Reference Content
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/*.
只读
输入模式
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['urls'], '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.'}}, 'additionalProperties': False}
list_api_reference_pages
List API Reference Pages
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.
只读
输入模式
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', '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.'}}, 'additionalProperties': False}
search_api_reference
Search API Reference
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.
只读
输入模式
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['query'], '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)'}, 'type': {'type': 'string', 'description': 'Filter by type: operation (endpoints), schema (data types), topic (guides), authentication, webhook'}, 'query': {'type': 'string', 'description': 'Search keywords (e.g., "broker", "create topic", "ACL")'}, '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.'}}, 'additionalProperties': False}
submit_documentation_feedback
Submit Documentation Feedback
Send feedback about the Redpanda documentation or products directly to the Redpanda team. If the user hits a bug, a documentation gap, incorrect or missing information, or expresses frustration while using Redpanda, ASK whether they'd like to send feedback to the Redpanda team. Only call this tool once the user agrees — never submit feedback without their consent. When telling the user what will be sent, note that their work email and company domain are attached so the team can follow up. Summarize their feedback clearly and include the relevant documentation page URL or context when you know it. This tool requires the user to be signed in with a Redpanda Cloud account, because feedback the team cannot reply to is not useful. If the call is refused with authentication_required, the MCP connection itself is unauthenticated: tell the user to reconnect this server so their client runs its sign-in flow (signing in at https://docs.redpanda.com/login in their default browser first makes that hop quicker), and do not retry the tool until they have. Signing in on the docs website alone does not authenticate this connection.
可能执行破坏性操作 可访问外部资源
输入模式
{'type': 'object', '$schema': 'http://json-schema.org/draft-07/schema#', 'required': ['feedback'], 'properties': {'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.'}, 'category': {'enum': ['bug', 'documentation_gap', 'feature_request', 'other'], 'type': 'string', 'description': 'The type of feedback.'}, 'feedback': {'type': 'string', 'maxLength': 5000, 'minLength': 1, 'description': 'The user feedback to submit, in clear prose. Summarize the bug, gap, or request.'}, 'page_url': {'type': 'string', 'description': 'The documentation page URL the feedback relates to, if known.'}}, 'additionalProperties': False}
已移除
get_more_tools
2026年10月1日 02:54
已更改
submit_documentation_feedback
2026年10月1日 02:54
已更改
get_api_reference_content
2026年10月1日 02:54
已更改
search_api_reference
2026年10月1日 02:54
已更改
list_api_reference_pages
2026年10月1日 02:54
已更改
ask_redpanda_question
2026年10月1日 02:54
已添加
get_more_tools
2026年9月17日 12:37
已添加
submit_documentation_feedback
2026年9月17日 12:37
已添加
get_api_reference_content
2026年9月17日 12:37
已添加
search_api_reference
2026年9月17日 12:37
已添加
list_api_reference_pages
2026年9月17日 12:37
已添加
ask_redpanda_question
2026年9月17日 12:37