Skip to main content
Glama

Lium Docs

read_page

Return the raw Markdown source for a documentation page. Accepts a full URL, absolute slug (e.g. /providers/quickstart), or basename (e.g. quickstart). On tie among basenames, prefers pages in audience order: Providers > Validators > Renters > Developers.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
url_or_slugYesFull URL (https://docs.lium.io/providers/quickstart), absolute slug (/providers/quickstart), or basename (quickstart)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/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 and discloses a non-obvious behavioral trait: tie-breaking among basenames by audience order (Providers > Validators > Renters > Developers). It does not cover failure behavior (what happens on a miss) or rate limits, but for a read-only fetch of raw Markdown the disclosure level is solid.

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 sentences, zero filler, with the core action front-loaded before the input-format and tie-break details. Every clause adds information an agent needs.

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 one-parameter, no-output-schema read tool, the description covers what is returned, what inputs are accepted, and how ambiguity resolves. Only error/miss handling is left unstated, which is a minor gap at this complexity level.

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% and there is a single parameter, so the schema already documents the three accepted input formats. The description adds value beyond that by defining the resolution behavior when a basename is ambiguous, which the schema cannot express.

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 precise verb and resource: 'Return the raw Markdown source for a documentation page.' An agent can immediately tell this is a fetch-by-identifier operation, which is plainly distinct from the sibling 'search' tool's query-based retrieval.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

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

The description explains accepted input forms (URL, absolute slug, basename) and the basename tie-break rule, which implies when the tool is usable. However, it never states when to prefer read_page over the sibling 'search' tool, so the selection guidance is left to inference.

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.