Skip to main content
Glama

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

TableJSON 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 type: operation (endpoints), schema (data types), topic (guides), authentication, webhook
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.

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
+]
  2. 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 genuine context beyond that: a hard result cap of 20 and the return field shape (URL, title, text excerpts), which matters since no output schema exists. It stops short of describing pagination, truncation behavior when more than 20 match, or ranking, so it is strong but not complete.

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?

Front-loaded with purpose and return shape, then organized into clearly labeled SCOPING and WHEN TO USE sections. It is on the long side, and the example mappings partially restate the scoping bullets, but each line is scannable and actionable rather than padding.

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?

For a 4-parameter read-only search tool with no output schema, the description covers purpose, all scope options, selection heuristics, the result cap and result fields, and the sibling alternative. An agent has everything needed to call it correctly on the first try.

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 the baseline would be 3. The description exceeds that by explaining the semantic meaning of each `api` scope (which resources live in admin vs cloud-controlplane vs cloud-dataplane) rather than merely restating the enum values, letting the agent choose a scope correctly. `type` and `context` are left to the schema, which is acceptable at full coverage.

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 result shape ('up to 20 matching endpoints, schemas, or topics with URL, title, and text excerpts'). It also names the sibling it is not (ask_redpanda_question) for non-API questions, so an agent can distinguish it before opening any 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 sections explicitly enumerate each `api` value, what each covers, and give concrete question-to-scope mappings ('broker endpoints' → admin, 'create topic API' → all). It also states the exclusions via the alternative tool for general Redpanda questions. This is exactly the when/when-not/alternatives guidance the dimension asks for.

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