Skip to main content
Glama

JSONPad documentation

Read a JSONPad docs page

read_doc
Read-onlyIdempotent

Read a documentation page as markdown, or one section of it. Give a page slug ("indexing"), a /docs path, a jsonpad.io URL (with or without .md, and with an optional #anchor), "sdk/jsonpad-sdk", "sdk/jsonpad-realtime-sdk", "cli/reference" or "cli/readme". Long pages are cut at a section boundary; read on with the returned nextSection.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageYesThe page: a slug, path or URL
sectionNoA heading anchor ("filtering-items") or heading text; overrides a #anchor in page
maxCharsNoThe most characters of markdown to return

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYes
titleYes
markdownYes
truncatedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so safety is covered structurally. The description adds real operational context beyond them: long pages are cut at a section boundary, and nextSection is the continuation handle. It still doesn't say how the section boundary is chosen or what happens with an unmatched section value.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

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

The core behavior leads and the accepted input list is packed into a single sentence rather than scattered. The enumeration is dense but each item carries distinct information, and the truncation caveat is placed last where it belongs.

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?

An output schema exists, so return shapes need no explanation, and the description correctly focuses on the two things structured fields don't cover: what counts as a valid page reference and how truncated reads continue. Only the routing question (when to use this vs search_docs) remains unanswered.

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%, so the baseline is 3, but the description enriches the 'page' parameter with concrete accepted values ('sdk/jsonpad-sdk', 'cli/reference'), the fact that jsonpad.io URLs work with or without .md and with an optional #anchor. It also reinforces that 'section' overrides an inline #anchor, matching 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 and resource ('Read a documentation page as markdown, or one section of it') and enumerates the accepted page forms. An agent can distinguish it from list_docs and search_docs purely from this text, since it is the retrieval-by-identity tool rather than a discovery tool.

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 tells you what input shapes are accepted and how to continue a truncated read ('read on with the returned nextSection'), which implies usage. However it never states when to prefer this over siblings like search_docs, list_docs, or get_cli_command, and gives no exclusions or prerequisites. Usage is implied rather than directed.

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