Skip to main content
Glama

docs-mcp

by com.redpanda
OverviewDiscussionsAdmin

Search Redpanda Sources

ask_redpanda_question
Read-only

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

TableJSON Schema
NameRequiredDescriptionDefault
top_kNoMaximum number of sections to return, applied after platform filtering. Must be a positive integer.
contextNoOptional. 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.
versionNoDocs 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.
platformNoThe 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.
questionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / version
      Added value: +{
+  "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.",
+  "type": "string"
+}
  2. Changed3 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • changedInput schema / properties / context / description
      Previous value: -"Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): \"Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization.\""New value: +"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."
    • changedInput schema / required
      Previous value: -[
-  "question",
-  "context"
-]New value: +[
+  "question"
+]
  3. Changed4 schema fields changed
    • addedInput schema / properties / platform
      Added value: +{
+  "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.",
+  "enum": [
+    "cloud",
+    "self-managed"
+  ],
+  "type": "string"
+}
    • addedInput schema / properties / top_k / description
      Added value: +"Maximum number of sections to return, applied after platform filtering. Must be a positive integer."
    • addedInput schema / properties / top_k / exclusiveMinimum
      Added value: +0
    • changedInput schema / properties / top_k / type
      Previous value: -"number"New value: +"integer"
  4. Changed3 schema fields changed
    • removedInput schema / additionalProperties
      Removed value: -false
    • addedInput schema / properties / context
      Added value: +{
+  "description": "Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): \"Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization.\"",
+  "type": "string"
+}
    • changedInput schema / required
      Previous value: -[
-  "question"
-]New value: +[
+  "question",
+  "context"
+]
  5. First observed

TDQS

A4.6/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the readOnly/non-destructive annotations by disclosing non-obvious mechanics: 'platform' filters results AFTER retrieval and can cut a 15-section response to 1-2, 'version' is applied DURING retrieval and mainly prevents per-version duplication, and version-neutral docs (Cloud, Connect, API reference) are always included. These are exactly the facts an agent needs to predict result size.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core purpose and result contract are front-loaded, and the sentences about 'platform' and 'version' each carry decisions the agent must make. It is long and restates version-neutral doc behavior that also appears in the schema, so a few sentences are not strictly additive.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description correctly supplies the return contract (sections with url plus markdown content, ordered by relevance) and covers defaults for every optional parameter. An agent has everything needed to call it correctly and interpret the result.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 80%, so most parameter meaning is already in the schema; the description still adds value with the concrete 15-to-1/2 shrink example for 'platform' and the explicit statement that omitting 'version' searches the latest release. The added detail largely mirrors the schema text, keeping it out of 5 territory.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The opening sentence names a specific verb and resource ('Search the official Redpanda documentation') and states the return shape ('most relevant sections... url and its actual content in markdown'). This is clearly distinguishable from the sibling API-reference tools, which target a narrower corpus.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

'Use this tool for all queries that require Redpanda knowledge' gives an explicit trigger, and the description then walks through the tradeoff of supplying vs omitting 'platform' and 'version'. It never names an alternative tool or a when-not-to-use case, so it stops short of a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All docs-mcp toolsInspect
Try in Browser
Shareable, User-Owned Context BackendPeople, applications, and agents read, write, and coordinate together in one context lake. Reach it over MCP, a CLI, a Python SDK, or REST.fulcradynamics.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources