Skip to main content
Glama

docs-mcp

by com.redpanda
OverviewDiscussionsAdmin

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)
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."
    • removedInput schema / required
      Removed value: -[
-  "context"
-]
  2. Added

TDQS

A4.4/5.0
Behavior4/5

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

No annotations are provided, so the description must carry the burden. It uses non-destructive language ('List', 'Returns') and describes browsing, implying a read-only operation. It does not explicitly state the absence of side effects, but no side effects are suggested.

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?

The description is well-structured with a separate SCOPING section and uses concise sentences. It is somewhat lengthy but remains on-topic and easy to scan, aiding comprehension.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The description mentions the output fields (URL, title, type, description) and provides usage context, including the context parameter guidance. It does not address error handling or pagination, but for a simple listing function this is acceptable and sufficiently complete.

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 three parameters (api, url, context) have schema descriptions, and the description adds a scoping section that elaborates on the api parameter values. This significantly enhances understanding beyond the bare 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?

The description clearly states the tool lists pages in Redpapi API reference documentation and specifies what it returns (endpoints, schemas, topic pages with URL, title, type, description). It also contrasts with ask_redpanda_question, making its purpose distinct from a key sibling.

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

Usage Guidelines4/5

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

It explicitly says 'Use this to browse API structure' and contrasts with ask_redpanda_question ('For general Redpanda docs, use ask_redpanda_question instead'). It also provides detailed scoping for the api parameter. However, it does not explicitly differentiate from search_api_reference or get_api_reference_content, leaving some ambiguity.

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