Skip to main content
Glama

docs-mcp

by com.redpanda

List API Reference Pages

list_api_reference_pages

List pages in Redpanda API reference documentation. Returns endpoints, schemas, and topic pages with URL, title, type, and description.

SCOPING (important for accurate results):

  • api="all" or omit: Lists all available APIs

  • api="admin": Cluster management operations (brokers, partitions, configs, users)

  • api="cloud-controlplane": Redpanda Cloud resource management (clusters, networks, namespaces)

  • api="cloud-dataplane": Cloud cluster data operations (topics, ACLs, connectors)

  • api="http-proxy": Kafka operations over HTTP (produce, consume, offsets)

  • api="schema-registry": Schema management (register, retrieve, compatibility)

Use this to browse API structure. For general Redpanda docs, use ask_redpanda_question instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
apiNoWhich API to list: "all" or omit for overview of all APIs, or a specific API name (admin, cloud-controlplane, cloud-dataplane, http-proxy, schema-registry)
urlNoSpecific URL path to list children of (optional, defaults to API root)
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.8/5.0
Behavior4/5

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

With no annotations, the description carries the behavioral transparency burden. It discloses the return fields and the exact scoping behavior for each api value, including that omitting api lists all. It does not mention pagination, authentication, or error handling, but for a read-only listing tool these are less critical. The scoping details go well beyond a generic statement.

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: a one-sentence summary, a scoping list, and a final usage note. Every sentence earns its place, with no redundancy or filler. The formatting improves scannability.

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 list tool with no output schema and no annotations, the description provides a complete picture: what it does, what it returns, how to scope it, and when to use an alternative. The parameter semantics are thoroughly covered. Given the tool's simplicity, nothing essential is missing.

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?

Schema description coverage is 100%, so baseline is 3, but the description adds substantial meaning beyond the schema. It elaborates on each api value (admin, cloud-controlplane, etc.) with concrete operation examples, which the schema does not provide. This makes the api parameter far more understandable and actionable.

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?

Description starts with a clear verb+resource: 'List pages in Redpanda API reference documentation.' It specifies what is returned (endpoints, schemas, topic pages with URL, title, type, description) and distinguishes from siblings by noting 'Use this to browse API structure' and pointing to ask_redpanda_question for general docs.

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 explicitly states when to use this tool ('to browse API structure') and when not to ('For general Redpanda docs, use ask_redpanda_question instead'). The extensive scoping section gives detailed guidance on parameter values, making it clear how to target different APIs.

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