Skip to main content
Glama

SMSPVA Documentation

Read a documentation page

smspva_docs_read_page
Read-onlyIdempotent

Read Markdown for a page in the selected locale, including original parameters, codes and warnings. Follow next_offset until null for the complete page; offsets and max_chars count Unicode code points. No filesystem or external URL access.

Input Schema

NameRequiredDescriptionDefault
pageYesStable page ID from search/list, e.g. api/balance, rental/default-services, email/providers, sdks or index. A matching relative /en/docs/.../ URL also works.
localeYesDocumentation language: English en, español es, 中文 zh. Required; no cross-language fallback.
offsetNo
max_charsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the safety profile is covered. The description earns credit by adding pagination termination semantics, Unicode code-point counting for offsets, and an explicit confirmation that no external URL or filesystem access is possible — behavior not derivable from the annotations.

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?

Three tight sentences with the core action first, then pagination mechanics, then the access boundary. Every clause carries information; nothing is restated from the title or annotations.

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 read-only paginated fetch with no output schema, the description covers how to page, how offsets are measured, and what access is unavailable. Only the return envelope shape (e.g. presence of the next_offset field itself) is left implicit.

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 only 50%, with offset and max_chars carrying no in-schema description; the description compensates by explaining that offsets and max_chars are measured in Unicode code points. It stops short of stating defaults or that next_offset is a return-field sentinel, so page/locale details lean on the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Read Markdown for a page') plus the locale scoping, which is more precise than the title alone. It does not explicitly differentiate itself from siblings like smspva_docs_search or smspva_docs_get_examples, though 'page' vs 'examples'/'list' implies the distinction.

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 gives concrete in-tool guidance ('Follow next_offset until null') and a boundary ('No filesystem or external URL access'), but it never says when to reach for this tool versus search or list_pages. The retrieval workflow is only implied by the schema note that page IDs come 'from search/list'.

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