Skip to main content
Glama

docs-mcp

by com.redpanda
OverviewDiscussionsAdmin

Search API Reference

search_api_reference

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.8/5.0
Behavior4/5

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

Annotations are empty, so the description carries the burden. It discloses the search nature and result limit ('Returns up to 20'), but does not explicitly state it is read-only or mention any side effects. However, for a search tool this is largely implied, and no misleading claims are present.

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

Conciseness5/5

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

The description is well-structured with clear sections (SCOPING, WHEN TO USE WHICH) and avoids unnecessary verbosity. Each sentence serves a purpose, and the formatting improves readability.

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?

The description provides sufficient context for an agent to decide when and how to use the tool, including scope options, example queries, and sibling-tool differentiation. It also hints at output format, covering the essential operational context.

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

Parameters5/5

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

All four parameters have descriptive schema entries, and the description adds extra context for the 'api' parameter with concrete examples and conditions. This goes beyond the schema's basic 'Scope' note, fully clarifying parameter usage.

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 description clearly states the tool's purpose: 'Search Redpanda API reference documentation by keyword.' It also specifies the output (returns up to 20 matching endpoints, schemas, or topics) and explicitly differentiates from sibling tool ask_redpanda_question by directing general questions elsewhere.

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?

Provides explicit scoping guidance with examples (e.g., 'broker endpoints' → api='admin') and a clear rule for when to use ask_redpanda_question instead. This gives agents direct criteria for tool selection.

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
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources