Skip to main content
Glama

docs-mcp

by com.redpanda
OverviewDiscussionsAdmin

Get API Reference Content

get_api_reference_content

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.5/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It implies a read-only operation ('Retrieve', 'Returns') but does not explicitly state side effects, permissions, or error behaviors. It lacks detail on what happens if URLs are invalid or if limits are exceeded.

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 concise and well-structured, with three short sentences covering purpose, usage guidance, and constraints. No redundant or vague phrasing.

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 simple retrieval tool, the description provides sufficient context: what it returns (endpoint details, schemas, examples), how to use it (after list/search), and resource limits. The lack of an output schema is acceptable given the straightforward purpose.

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% for both parameters. The description adds value beyond the schema by explaining the URLs parameter's source (results from sibling tools) and max limit (10), and the optional context parameter's content requirements and exclusion of sensitive data.

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 verb 'Retrieve' and the resource 'full content of API reference pages by URL'. It explicitly distinguishes itself from sibling tools by instructing to use it after list_api_reference_pages or search_api_reference.

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 guidance: 'Use this after finding pages via list_api_reference_pages or search_api_reference. Pass the URLs from those results directly.' It also gives operational constraints (max 10 pages, URL domain restriction).

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