Skip to main content
Glama

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

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

With no annotations, the description carries the burden of behavioral disclosure. It reveals important constraints: 'Returns up to 10 pages per request' and 'URLs must be from docs.redpanda.com/api/doc/*.' It also sets expectations for the response content without describing error handling or authentication, which prevents 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.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is three short paragraphs, each earning its place: the first states purpose, the second gives the usage workflow, and the third lists operational constraints. It is front-loaded with the key verb and resource, with no filler.

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 two-parameter retrieval tool without an output schema or annotations, the description is nearly complete. It explains what is returned, how to use it, and key constraints. It lacks only edge-case behavior like error handling or rate limits, but the core selection and invocation information is present.

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?

The input schema already covers both parameters thoroughly, including the 'context' parameter rules. The description adds value by specifying the URL domain restriction and reiterating the 10-page limit, which goes beyond the schema's description for 'urls'.

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 opens with 'Retrieve full content of API reference pages by URL' and clearly specifies the return value: 'complete endpoint details including parameters, request/response schemas, and examples.' It distinguishes itself from sibling tools by explaining it consumes URLs from 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 Guidelines4/5

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

The description provides clear workflow guidance: 'Use this after finding pages via list_api_reference_pages or search_api_reference. Pass the URLs from those results directly.' It names the relevant sibling tools and implies the intended sequence, though it does not explicitly state when not to use the tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

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.