Home

How to Use These Docs

Redpanda’s documentation helps you stream data, build pipelines, and deploy AI agents, whether you manage the infrastructure yourself or run in Redpanda Cloud. Use this page to find the docs you need, ask questions with Ask AI, and read the docs from AI tools and scripts.

How the docs are organized

The docs are organized by deployment model and product. The Agentic Data Plane is infrastructure for AI agents and agentic workflows. The Data Platform is the streaming foundation, which you run in Redpanda Cloud or manage yourself.

Documentation hierarchy
Redpanda Documentation
├── Agentic Data Plane
│   └── AI agent infrastructure and workflows
└── Data Platform
    ├── Cloud (managed by Redpanda)
    │   ├── Serverless
    │   ├── BYOC
    │   └── Dedicated
    └── Self-Managed (managed by you)
        ├── Streaming (broker, Redpanda CLI)
        └── Connect (data pipelines)

Self-Managed is the deployment model: you run and manage the infrastructure. Streaming is the product: the Redpanda broker and the Redpanda CLI. Older docs used the name Redpanda Self-Managed for the broker software itself.

Each part has its own overview:

Choose your path

Start from what you want to do:

  • Build AI agent infrastructure: the Agentic Data Plane runs and orchestrates AI agents and agentic workflows. Start with Get started with the Agentic Data Plane.

  • Deploy Redpanda yourself: install and manage Redpanda Streaming and Connect on your own infrastructure. Start with the Streaming quickstart or the Connect quickstart.

  • Let Redpanda manage it for you: choose Serverless, BYOC, or Dedicated in Redpanda Cloud. Start with Get started with Cloud.

  • Connect data sources and sinks: Redpanda Connect runs in both Cloud and Self-Managed deployments, with hundreds of prebuilt connectors, including AI and change data capture (CDC). See the Connect documentation.

Page features

Each page has an options menu with these features:

  • View as plain text: opens the page as GitHub-Flavored Markdown, for Markdown-aware editors or for sharing a snippet.

  • Copy as Markdown: copies the page as Markdown to your clipboard, with its YAML front matter (title, description, git dates, categories, and more), for pasting into notes, docs, or issue trackers.

  • Ask AI: opens a chat with access to the Redpanda documentation. It can explain a configuration in simpler terms, show examples, or point out common pitfalls. You can also open it from the navigation bar. Without signing in, you can ask three questions every 24 hours. Sign in with a free Redpanda Cloud account for unlimited questions and the docs AI agent, which also saves your conversations.

Use the docs MCP server

The docs MCP server lets you query Redpanda documentation from your IDE or AI tool. It uses the Model Context Protocol (MCP), and you can add it to any AI tool that supports remote MCP servers:

https://docs.redpanda.com/mcp

Sign in for a higher allowance

You can connect and start asking without signing in. Anonymous access allows 10 tool calls every 24 hours, counted per network address, so you share that allowance with anyone else using the server from the same network. Connecting, listing tools, and sending feedback don’t count against it.

Signing in with a Redpanda Cloud account, which is free to create, removes that limit and gives you an allowance of your own.

There’s no token to copy: the server uses OAuth, and a client that supports the MCP OAuth flow handles sign-in for you. You sign in once. Your client renews access in the background and prompts you again only if you go 30 days without using the server.

Start sign-in from your client

Your client might not offer to sign you in. MCP clients start sign-in only when a server requires authentication, and this server allows anonymous access. To get the higher allowance, ask your client to authenticate: reconnect the server, or use your client’s authenticate action for it.

Signing in to docs.redpanda.com in a browser doesn’t sign in your client, because the client runs its own OAuth flow. It does make that flow faster: your client’s sign-in becomes a redirect with nothing to click.

Sign in first if you use a stdio bridge

If you connect through a stdio bridge such as mcp-remote, a local process that converts the HTTP endpoint for your client, sign in to docs.redpanda.com in your default browser before you connect. The host stops the bridge when its startup timeout elapses (30 seconds in Claude Code), and the browser sign-in step stops with it. Creating a Cloud account takes longer than that. If you’ve already hit this, see Sign-in opens a browser but the page fails to load.

Install the server

Select your AI tool for setup steps.

  • Claude Code

  • Cursor

  • VS Code

  • ChatGPT

  • Claude Desktop

Run the following command to add the server to Claude Code:

claude mcp add --scope user --transport http redpanda https://docs.redpanda.com/mcp

This adds the server as redpanda over the HTTP transport for your user account on any platform. Claude Code stores it in ~/.claude.json. The server works immediately on the anonymous allowance. To sign in, run /mcp in Claude Code and authenticate the redpanda server.

To verify the installation:

claude mcp list

The output includes redpanda: https://docs.redpanda.com/mcp (HTTP): ✓ Connected.

For more information, see the Claude Code documentation.

Add the following to your .cursor/mcp.json file:

{
  "mcpServers": {
    "redpanda": {
      "type": "http",
      "url": "https://docs.redpanda.com/mcp"
    }
  }
}

The server works immediately on the anonymous allowance. To sign in, reconnect the server from Cursor’s MCP settings.

For more information, see the Cursor documentation.

You need VS Code 1.102 or later with GitHub Copilot enabled.

Create an mcp.json file in your workspace .vscode folder:

.vscode/mcp.json
{
  "servers": {
    "redpanda": {
      "type": "http",
      "url": "https://docs.redpanda.com/mcp"
    }
  }
}

The server works immediately on the anonymous allowance. To sign in, reconnect the server from the MCP view.

To configure the server for all workspaces:

  1. Open the Command Palette (Cmd+Shift+P / Ctrl+Shift+P).

  2. Run MCP: Open User Configuration.

  3. Add the same JSON configuration.

To use the server:

  1. Open the Chat view (Ctrl+Cmd+I / Ctrl+Alt+I).

  2. Select Agent mode from the dropdown.

  3. Click Tools to see the available MCP tools.

  4. Ask a question about Redpanda. The assistant uses the documentation to answer.

For more information, see the VS Code MCP documentation.

ChatGPT connects to remote MCP servers as custom plugins. Account and workspace policies apply, so a workspace admin might need to allow custom MCP servers first.

  1. Go to ChatGPT Plugins.

  2. Select the plus button, then Add custom MCP server.

  3. Enter a name, such as redpanda, and a description.

  4. Under Connection, enter the server URL: https://docs.redpanda.com/mcp

  5. Set authentication to OAuth, review the risk warning, and select I understand and want to continue.

  6. Select Create as a plugin.

The server works immediately on the anonymous allowance. To sign in, reconnect the plugin and complete the OAuth flow when prompted.

For more information, see Connect and test your plugin in the OpenAI documentation.

You can connect Claude Desktop through Connectors or through its configuration file.

Connectors work on all plans and platforms (macOS, Windows, Linux). The Free plan is limited to one custom connector. On Team and Enterprise plans, an organization owner adds the connector first, and members then connect to it. Claude connects to the server from Anthropic’s cloud infrastructure.

  1. Open Claude Desktop.

  2. Go to Customize > Connectors.

  3. Click + Add, then Add custom connector.

  4. Enter a name, such as redpanda, and the URL https://docs.redpanda.com/mcp, then click Continue.

  5. Review the detected authentication settings, then click Add.

The connector works immediately on the anonymous allowance. To sign in, reconnect it and complete the OAuth flow when prompted.

The configuration file works on macOS and Windows, on all plans. On Linux, Claude Desktop can’t connect to remote servers configured this way, so use Connectors instead.

  1. Sign in at docs.redpanda.com in your default browser. Claude Desktop stops the mcp-remote bridge when its startup timeout elapses, so a sign-in that includes creating an account can’t finish in time.

  2. Open the configuration file: ~/Library/Application Support/Claude/claude_desktop_config.json on macOS, or %APPDATA%\Claude\claude_desktop_config.json on Windows.

  3. Add the following configuration:

    {
      "mcpServers": {
        "redpanda": {
          "command": "npx",
          "args": ["-y", "mcp-remote", "https://docs.redpanda.com/mcp"]
        }
      }
    }

    Claude Desktop supports only the stdio and sse transports, so the mcp-remote bridge converts the HTTP endpoint. On first use, mcp-remote opens a browser to sign you in with your Redpanda Cloud account.

  4. Restart Claude Desktop.

For more information, see the Claude custom connectors documentation.

Other AI tools

Any tool that supports remote MCP servers can connect to https://docs.redpanda.com/mcp. MCP support varies by tool and version, so check your tool’s documentation for setup steps. To sign in, see Sign in for a higher allowance.

What you can ask

After you connect, you can ask questions about Redpanda from your editor, such as:

  • How do I configure Redpanda for production?

  • What are the instructions for running Redpanda in a local kind cluster?

  • What are the best practices for topic partitioning in Redpanda?

  • How do I monitor Redpanda cluster performance?

  • What’s the difference between Redpanda Cloud and Self-Managed?

For facts with one right answer, the server has exact lookups that read the generated reference data instead of searching prose:

  • A configuration property by name: its type, default, whether it needs a restart, and whether Redpanda Cloud supports it.

  • Properties that match a keyword or scope.

  • A Redpanda Connect component by type and name: its status, fields, and defaults.

  • An rpk command by name: its usage, flags, defaults, and the release it ships in.

Your assistant uses these for questions such as:

  • What is the default of log_segment_size in 26.1?

  • Which properties control retention?

  • Does the redpanda output support batching?

  • What flags does rpk topic create take?

If a property, component, or command doesn’t exist, the server returns not found with close matches instead of a guess.

You can also send feedback to the Redpanda team through your assistant. If you find a bug, a documentation gap, or anything unclear, ask your assistant to send feedback, and say what is wrong or missing. Your assistant might also report problems it notices on its own. Feedback doesn’t include your name or email address, so don’t put personal details in it. To get a reply, contact Redpanda support.

Usage limits

The server allows 60 requests every 15 minutes. When you’re signed in, the limit applies per user. Without signing in, it applies per IP address. The ask_redpanda_question tool also passes your question to an MCP server hosted by Kapa.ai, which enforces its own limits. See the Kapa documentation.

These limits suit individual use from an IDE and ad hoc questions. For automation or high-volume integrations, cache answers on your side to avoid repeating the same queries.

If you exceed the limit, you receive an HTTP 429 response. Wait until the time in RateLimit-Reset before you retry:

HTTP 429 Too Many Requests
RateLimit-Limit: 60
RateLimit-Remaining: 0
RateLimit-Reset: <timestamp>

Troubleshoot the MCP server

These sections cover sign-in, quota, and connection problems with the docs MCP server.

Authentication required (HTTP 401)

Anonymous access is allowed, so a 401 with an authentication_required error means your client sent credentials the server couldn’t accept:

  • Reconnect or restart the client. If sign-in worked before, your token may have expired, and reconnecting starts a fresh sign-in.

  • Check that your client supports the MCP OAuth flow. A client that doesn’t can still use the server anonymously.

  • If you don’t have a Redpanda Cloud account, create a free one.

Out of free tool calls

An anonymous_quota_exhausted error means you’ve used the anonymous allowance of 10 tool calls in 24 hours. Your assistant usually reads the message to you, so it may reach you as a sentence about signing in.

The allowance is counted per network address, so on a shared or office network you can reach it without making 10 calls yourself. It resets 24 hours after the first call it counted. To get an allowance of your own, sign in from your client. See Sign in for a higher allowance.

Sign-in opens a browser but the page fails to load

Your client stopped listening for the sign-in result before you finished in the browser if any of these happen:

  • The browser ends up on a localhost address that reports ERR_CONNECTION_REFUSED.

  • Sign-in keeps opening a new tab without finishing.

  • The browser shows a Finish connecting button after you sign in.

Clients that connect through a stdio bridge such as mcp-remote are affected. The host stops the bridge when its startup timeout elapses (30 seconds in Claude Code), and the bridge’s browser listener stops with it. The --auth-timeout option of mcp-remote doesn’t extend this window.

To fix it:

  • Sign in to docs.redpanda.com in your default browser first, then connect your client. The client’s sign-in is then a redirect with nothing to click, which finishes in seconds.

  • If the browser shows Finish connecting, click it within a minute. If nothing happens, reconnect the server in your client.

  • If you run mcp-remote under Claude Code, raise the startup timeout by setting MCP_TIMEOUT=300000 in the environment Claude Code runs in. Then clear any half-finished state with rm -rf ~/.mcp-auth before you retry.

  • For Claude Code, Cursor, and VS Code, use the HTTP transport shown in Install the server instead of mcp-remote. Those clients keep listening for as long as the session is open.

If you were creating your Redpanda Cloud account when this happened, no timeout is long enough: signup includes a verification email and Cloud onboarding. Finish creating the account in the browser, then reconnect your client.

Account setup is not finished

If sign-in fails with access_denied and a message about finishing account setup, your Redpanda Cloud account exists but doesn’t belong to an organization yet. Verifying the address in the signup email doesn’t create one. Complete the Redpanda Cloud onboarding steps, then reconnect your client. Retrying before onboarding is finished fails the same way.

Work account required (HTTP 403)

Any verified Redpanda Cloud account works by default, including personal email addresses. If your organization restricts access to work email domains and you receive an HTTP 403 with a work_email_required error, sign in with your work account.

Server not connecting

  • Check that the URL is exactly https://docs.redpanda.com/mcp.

  • Check that your tool supports HTTP-based MCP servers.

  • For Claude Code, Cursor, and VS Code, use the HTTP transport (--transport http or "type": "http"). If you configured Claude Code with mcp-remote before, remove that configuration and use the HTTP transport.

  • For Claude Desktop, use the mcp-remote bridge, because Claude Desktop doesn’t support the HTTP transport directly.

  • Check that your client sends an Accept header with both application/json and text/event-stream, and supports Server-Sent Events (SSE).

  • Restart your tool after you change its configuration.

In VS Code, also check that you have VS Code 1.102 or later with GitHub Copilot enabled. Run MCP: Reset Cached Tools from the Command Palette, and look for errors in View > Output > MCP.

To report a problem with the docs or the server, contact Redpanda support.

Read the docs as Markdown

For tools without MCP support, scripts, and offline processing, every page is available as Markdown, and the whole site is available as llms.txt exports.

Individual pages

Each page has a Markdown version at the same address. Use either method:

The Markdown is GitHub-Flavored Markdown with YAML front matter that holds the page metadata (title, description, categories, topic type, and personas) and the created and modified dates from git history.

llms.txt and full exports

The docs follow the llms.txt standard:

  • https://docs.redpanda.com/llms.txt: an overview with links to the main resources, for AI tools to start from.

  • https://docs.redpanda.com/llms-full.txt: every component in one file, at the latest version of each.

  • One export per component, which is smaller and cheaper to index than the full export. The files are streaming-full.txt, cloud-data-platform-full.txt, connect-full.txt, agentic-data-plane-full.txt, labs-full.txt, and home-full.txt.

The exports include only the latest version of each product. For an older version, request its pages individually.

Data collection

What Redpanda collects depends on whether you sign in:

  • When you sign in: Redpanda receives your verified email address, and your organization when available, from Redpanda Cloud. Redpanda uses it to track documentation usage and attribute it to your organization. It may be shared with Redpanda’s customer and analytics systems, and passed to the documentation search provider, Kapa.ai, for usage attribution.

  • When you use Ask AI without signing in: Redpanda counts your free questions. Where your cookie choices allow it, the count uses a first-party cookie, __Host-rp_docs_visitor, that holds only a random identifier, expires after 24 hours, and isn’t shared with third parties. If you’ve declined that category in Cookie preferences, nothing is stored on your device, and the count uses your network address instead, which you share with others on the same network.

  • In both cases: so that starting fresh isn’t an unlimited reset, Redpanda keeps a short-lived count per network address. Those counts are never tied to your questions or to you, and the address itself isn’t stored with them.

For details, see the Redpanda Privacy Policy.