Redpanda Docs
OfficialSearch through official Redpanda documentation to get authoritative answers to questions about using Redpanda streaming data platform.
Get authoritative answers to questions about Redpanda
What it does
- Search Redpanda documentation
- Retrieve relevant doc sections with URLs
- Get authoritative answers about Redpanda features
- Access official configuration guides
Best for
About Redpanda Docs
Redpanda Docs is an official MCP server published by redpanda-data that provides AI assistants with tools and capabilities via the Model Context Protocol. Redpanda Docs — authoritative answers, guides, and troubleshooting for Redpanda users and developers. Learn, implement, This server exposes 1 tool that AI clients can invoke during conversations and coding sessions.
How to install
You can install Redpanda Docs in your AI client of choice. Use the install panel on this page to get one-click setup for Cursor, Claude Desktop, VS Code, and other MCP-compatible clients. This server supports remote connections over HTTP, so no local installation is required.
License
Redpanda Docs is released under the MIT license. This is a permissive open-source license, meaning you can freely use, modify, and distribute the software.
Tools (1)
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.
= Redpanda Docs Site :url-docs: https://docs.redpanda.com :url-org: https://github.com/redpanda-data :url-gh-docs: {url-org}/documentation :url-ui: {url-org}/docs-ui :url-extensions: {url-org}/docs-extensions-and-macros :hide-uri-scheme: :url-contributing: ./meta-docs/CONTRIBUTING.adoc :url-netlify: https://netlify.com :url-netlify-docs: https://docs.netlify.com :url-antora-docs: https://docs.antora.org :url-redoc: https://github.com/Redocly/redoc :idprefix: :idseparator: - ifdef::env-github[] :important-caption: :exclamation: :note-caption: :paperclip: endif::[] :toc: :toc-title: Contents
image:https://img.shields.io/badge/slack-purple[Slack, link="https://redpanda.com/slack"] image:https://img.shields.io/twitter/follow/redpandadata.svg?style=social&label=Follow[Twitter, link="https://twitter.com/intent/follow?screen_name=redpandadata"] image:https://api.netlify.com/api/v1/badges/5b89dd6f-1847-419c-b3be-a1650ce8992f/deploy-status[Netlify Status, link="https://app.netlify.com/sites/redpanda-documentation/deploys"]
++++
++++This is the Antora playbook project (site build) for the Redpanda docs site published at {url-docs}.
== Playbook
The playbook, link:antora-playbook.yml[antora-playbook.yml]configures the production build for the docs site.
This playbook tells Antora what documentation to assemble, where to find it, and what UI to apply to it.
The documentation is hosted in a separate Git repository, as is the {url-ui}[UI project], and the {url-extensions}[custom extensions].
image::images/antora.svg[]
The production site is built for each change to the main branch.
A deploy preview of the site is also published for each pull request.
TIP: For an introduction to Antora and helpful tips for getting started with local development, see the link:{url-contributing}[Contributing guide].
== Content sources
The playbook pulls content from branches in the https://github.com/redpanda-data/documentation repository.
=== Redpanda core docs
Redpanda core documentation is stored in versioned branches prefixed with v/.
For more details, see the https://github.com/redpanda-data/documentation/blob/main/README.adoc[README].
== Extensions and macros
The Redpanda docs site includes custom extensions and macros to enhance the site and provide custom features.
For details about all the extensions and macros, see {url-extensions}.
== Netlify configuration and redirects
The docs site is hosted on link:{url-netlify}[Netlify].
The Netlify build is configured in the netlify.toml file. The redirects in this file redirect users from the previous Docusaurus URLs to the new Antora ones.
NOTE: When you delete, rename, or move an existing page, use the {url-antora-docs}/antora/latest/page/page-aliases/[page-aliases attribute]. Do not use the netlify.toml file. The redirects in this file must be bulk URL redirects, such as removing or renaming a component or component version.
For details about this file, see the link:{url-netlify-docs}/configure-builds/file-based-configuration/[Netlify documentation].
== Contributing
To learn how to use the playbook and generate the docs site locally, see our link:{url-contributing}[contributing guide].
Related Skills
Browse all skillsToolkit for styling artifacts with a theme. These artifacts can be slides, docs, reportings, HTML landing pages, etc. There are 10 pre-set themes with colors/fonts that you can apply to any artifact that has been creating, or can generate a new theme on-the-fly.
Google Workspace CLI for Gmail, Calendar, Drive, Contacts, Sheets, and Docs.
飞书文档(Docx)API技能。用于创建、读取、更新和删除飞书文档。支持Markdown/HTML内容转换、文档权限管理。
Use this skill for requests related to LangGraph in order to fetch relevant documentation to provide accurate, up-to-date guidance.
Interact with ClickUp tasks and documents - get task details, view comments, create and manage tasks, create and edit docs. Use when working with ClickUp task/doc URLs or IDs.
Search personal markdown knowledge bases, notes, meeting transcripts, and documentation using QMD - a local hybrid search engine. Combines BM25 keyword search, vector semantic search, and LLM re-ranking. Use when users ask to search notes, find documents, look up information in their knowledge base, retrieve meeting notes, or search documentation. Triggers on "search markdown files", "search my notes", "find in docs", "look up", "what did I write about", "meeting notes about".