Skip to main content
Glama
Sign In

docs-mcp

by com.redpanda
OverviewDiscussionsAdmin

List API Reference Pages

list_api_reference_pages
Read-only

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

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.
session_goalNoOptional. In one concise sentence (third person), the overall goal of this session: what the user is trying to get done, not just this call. Send the same goal on every call in the session, and update it only if the goal changes. Do not include credentials, tokens, personal data, or verbatim secrets.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / session_goal
      Added value: +{
+  "description": "Optional. In one concise sentence (third person), the overall goal of this session: what the user is trying to get done, not just this call. Send the same goal on every call in the session, and update it only if the goal changes. Do not include credentials, tokens, personal data, or verbatim secrets.",
+  "type": "string"
+}
  2. 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"
-]
  3. Added

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, openWorldHint=false, so the safety profile is covered; the description adds meaningful value by describing the return payload shape (endpoints, schemas, topic pages with URL/title/type/description), which matters since no output schema exists. It omits pagination or result-size behavior, keeping it short of a 5.

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 purpose sentence, then a labeled SCOPING block, then a routing sentence at the end — a clean structure with no filler. The per-API bullet list is somewhat long and partially restates the schema's api description, costing a point on tightness.

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?

For a read-only browse tool with no output schema, the description covers purpose, scoping, return shape, and the sibling alternative — enough to call it correctly. The remaining gap is the url parameter's behavior and any pagination/result-limit expectations.

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 baseline is 3; the description earns a step up by expanding each api value into what it actually covers (e.g. admin = brokers, partitions, configs, users), which is semantic enrichment beyond the schema's short enum-like listing. The url parameter, which controls the listing root, gets no treatment in the description.

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 ("List pages in Redpanda API reference documentation") and immediately enumerates what comes back (endpoints, schemas, topic pages with URL, title, type, description). It also names the sibling it is not (ask_redpanda_question), so an agent can separate browsing from question-answering without opening a schema.

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?

"Use this to browse API structure" plus the explicit alternative for general docs gives clear usage context and one exclusion. However, it does not distinguish this from the most directly competing siblings, search_api_reference and get_api_reference_content, which an agent would plausibly confuse with a listing call.

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
Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources