Skip to main content
Glama

JSONPad documentation

List the JSONPad docs pages

list_docs
Read-onlyIdempotent

List the documentation pages by section, with a description of each: the table of contents.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sectionNoOnly list one section

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
sectionsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is fully covered structurally. The description adds that entries include a description of each page, but says nothing about ordering, size, or pagination behavior of the listing.

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?

One compact sentence that front-loads the action and the grouping, with the 'table of contents' gloss appended. The trailing colon phrase is slightly awkward but consumes no real space.

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 single-parameter read-only listing with an output schema, the description is sufficient: it explains what is returned conceptually and leaves item shapes to the output schema. Nothing critical is missing, though a nod to listing-without-filter behavior would help.

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 coverage is 100% and the single 'section' parameter already carries its enum and the note 'Only list one section'. The phrase 'by section' in the description aligns with the schema but adds no format or scoping detail beyond it, so baseline 3 applies.

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 (List) and resource (documentation pages / table of contents) and notes it is grouped by section with descriptions. An agent can distinguish it from read_doc or search_docs, though it never names those siblings explicitly.

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?

Usage is only implied: listing is the natural first step before read_doc or search_docs, but the description never states when to use this versus those alternatives or whether the section filter is required.

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