Skip to main content
Glama

docs-mcp

by com.redpanda
OverviewDiscussionsAdmin

Get API Reference Content

get_api_reference_content
Read-only

Retrieve full content of API reference pages by URL. Returns complete endpoint details including parameters, request/response schemas, and examples.

Use this after finding pages via list_api_reference_pages or search_api_reference. Pass the URLs from those results directly.

Returns up to 10 pages per request. URLs must be from docs.redpanda.com/api/doc/*.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlsYesPage URLs to retrieve (max 10). Use URLs from list_api_reference_pages or search_api_reference results.
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: -[
-  "urls",
-  "context"
-]New value: +[
+  "urls"
+]
  2. Added

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds genuinely useful context beyond that: a hard batch limit of 10 pages per request and the constraint that URLs must live under docs.redpanda.com/api/doc/*. It does not describe pagination or response format, but the domain and batch constraints are the material extras here.

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?

Four short sentences, each carrying distinct information: what it returns, when to call it, input sourcing, and hard limits. The core purpose is front-loaded and nothing is padded.

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?

With no output schema, the description carries the burden of explaining returns and does so ('complete endpoint details including parameters, request/response schemas, and examples'). The only minor gap is the absence of any note on what happens with invalid or partially-failing URLs when multiple are batched.

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 both parameters including the optional 'context' field are documented in the schema, setting a floor of 3. The description adds meaning beyond the schema by naming the permitted URL domain and reiterating where the URLs should originate, which constrains what a valid value actually is.

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 ('Retrieve full content of API reference pages by URL') and immediately distinguishes itself from siblings by positioning as the follow-up to list_api_reference_pages and search_api_reference. An agent can tell it fetches full page bodies rather than listing or searching.

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?

Explicitly states when to use it ('Use this after finding pages via list_api_reference_pages or search_api_reference') and how to source inputs ('Pass the URLs from those results directly'). It routes the agent away from using it for discovery, which is the sibling tools' job.

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
Shareable, User-Owned Context BackendPeople, applications, and agents read, write, and coordinate together in one context lake. Reach it over MCP, a CLI, a Python SDK, or REST.fulcradynamics.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources