Skip to main content
Glama

docs-mcp

by com.redpanda

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")
contextYesExplain 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."

TDQS

A4.7/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden and does well: it discloses the scope of results (up to 20 matches), the return components (URL, title, text excerpts), and the meaning of each api scoping value. However, it does not mention behaviors like no-results handling, ordering, or rate limits, which would strengthen transparency for a search tool.

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 structured with clear headers (SCOPING, WHEN TO USE WHICH) and a final pointer to an alternative tool. While it is somewhat lengthy, every section serves a purpose: the scoping lists are essential for correct parameter use, and the examples are directly actionable. There is no filler or repetition.

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 tool has 4 parameters and no output schema, so the description must cover both input semantics and output behavior. It does this thoroughly: it describes the return format, explains all api scoping values, provides usage examples, and explicitly distinguishes from sibling tools. This is a complete, self-contained description for the agent.

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?

The input schema already describes all parameters, so the baseline is 3. The description adds significant value by explaining the semantic meaning of each api value (admin, cloud-controlplane, etc.) and offering concrete examples of when to use each, which goes beyond the schema's terse 'Scope: all or omit' description. This raises the score above baseline.

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 specifies a verb ('Search') and a resource (Redpanda API reference documentation), and it distinguishes itself from sibling tools by stating that general Redpanda questions should use ask_redpanda_question instead. It also clarifies that it returns up to 20 matching endpoints, schemas, or topics with URL, title, and excerpts, making its purpose unambiguous.

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 description provides explicit 'WHEN TO USE WHICH' examples mapping user queries to specific api parameter values, and it explicitly directs non-API-specific questions to ask_redpanda_question. This is strong, actionable guidance that helps an agent choose this tool over alternatives and configure it correctly.

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
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.4/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose: general docs search, API reference search, API reference listing, API content retrieval, and meta tool discovery. The potential overlap between search_api_reference and list_api_reference_pages is resolved by their differing functions and scoping parameters.

Naming Consistency4/5

Tool names consistently use imperative verbs with underscore separators (ask, get, list, search). The naming is readable and predictable, though 'ask_redpanda_question' is slightly less conventional than the clear 'api_reference' group.

Tool Count5/5

Five tools is well-scoped for a documentation MCP server, covering search, browsing, and content retrieval without unnecessary duplication or bloat.

Completeness4/5

The server covers general doc search, API reference search, listing, and content retrieval. A dedicated general-doc page fetcher is absent, but ask_redpanda_question returns content sections directly, so the gap is minor and workable.

Resources