Skip to main content
Glama

Read a Radix doc

read_radix_doc
Read-only

Returns the full content of one curated documentation page as Markdown, in English or Spanish. Get valid doc ids from search_radix_docs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
docIdYesDocument id, e.g. "scrypto-basics" or "babylon-guide"
localeYesLanguage of the returned content: "en" (English) or "es" (Spanish)en

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior3/5

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

readOnlyHint=true already tells the agent this is a safe read, so the description's added value is the disclosure that the entire page body is returned as Markdown and that content is locale-dependent. It does not address behavior on an invalid or stale docId, page size, or versioning.

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?

Two short sentences, zero filler, with the output format stated up front and the parameter-sourcing hint placed last. Every clause earns its place.

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 simple two-parameter read tool with no output schema, the description covers purpose, how to obtain docId, the return format, and the language dimension, which is enough to invoke it correctly. Only failure behavior for bad ids is unaddressed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and both parameters carry their own descriptions plus an enum for locale, so the schema already does the work. The description only echoes the language option and the source of docId, adding no syntax or format detail beyond the 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?

States a specific verb (returns full content), resource (one curated documentation page), format (Markdown) and supported languages. The 'one page' scope plus the docId sourcing note cleanly separates it from the sibling search_radix_docs.

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 gives the prerequisite workflow explicitly: get valid doc ids from search_radix_docs. What is missing is any when-not-to-use guidance (e.g. don't use it to search or to fetch multiple pages) or a note that ids not from search will fail.

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.

Resources