Skip to main content
Glama
Sign In

docs-mcp

by com.redpanda
OverviewDiscussionsAdmin

Search API Reference

search_api_reference
Read-only

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

NameRequiredDescriptionDefault
apiNoScope: "all" or omit to search all APIs, or specific API name (admin, cloud-controlplane, cloud-dataplane, http-proxy, schema-registry)
typeNoFilter 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.
queryYesSearch keywords (e.g., "broker", "create topic", "ACL")
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.
session_goalNoOptional. 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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / session_goal
      Added value: +{
+  "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.",
+  "type": "string"
+}
  2. Changed1 schema field changed
    • changedInput schema / properties / type / description
      Previous value: -"Filter by type: operation (endpoints), schema (data types), topic (guides), authentication, webhook"New value: +"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."
  3. 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: -[
-  "query",
-  "context"
-]New value: +[
+  "query"
+]
  4. Added

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so safety is covered; the description adds behavior beyond that with the "up to 20 results" cap and the per-result fields returned. It does not discuss relevance ranking, pagination, or what happens when zero results match, but for a read-only search that is a minor omission.

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?

Purpose and return shape are front-loaded in the first sentence, and the bullets are scannable. There is some redundancy between the SCOPING list and the WHEN TO USE WHICH examples, which repeat the same mappings in a second form, costing a little length for an otherwise tight definition.

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 1 required parameter, 100% schema coverage, and no output schema, the description supplies the one thing the schema cannot: how to pick the `api` scope and what the results contain. Nothing an agent needs in order to call it correctly is missing.

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 100%, so baseline is 3, but the description adds real semantic content by explaining what each `api` scope actually contains (admin = brokers/partitions/configs/users, cloud-dataplane = topics/ACLs/connectors), which the schema enum list alone does not convey. It gives no guidance on `type`, `context`, or `session_goal`, but those are already documented in the schema.

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?

States a specific verb and resource ("Search Redpanda API reference documentation by keyword") and immediately describes the return shape (up to 20 endpoints, schemas, or topics with URL, title, text excerpts). It also explicitly routes non-API questions to the sibling ask_redpanda_question, so an agent can distinguish it without opening another schema.

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

Usage Guidelines5/5

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

The SCOPING and WHEN TO USE WHICH blocks give explicit scope-to-value mappings plus concrete query examples ("broker endpoints" -> admin, "create topic API" -> all) and an exclusion routing general questions to ask_redpanda_question. This is the strongest part of the definition — when-to-use, when-not, and the alternative are all named.

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
Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources