Skip to main content
Glama

DeveloperHub Docs

List pages

list_pages
Read-only

List the pages of one documentation section, nested as its sidebar shows them, each linked by the URL read_page takes.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "section": "<section>"
    },
    "name": "list_pages"
  }
}

Input Schema

NameRequiredDescriptionDefault
sectionYesThe section's slug, from list_sections
versionNoA version slug from list_versions. Leave it out for the default version.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered by structured data. The description adds genuinely useful behavior context — the results are nested to mirror the sidebar hierarchy and each item carries a URL consumable by read_page — but says nothing about ordering guarantees, depth, or whether hidden/unlisted pages appear.

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?

A single compact sentence that front-loads the resource, then the shape of the result, then the consumer of that result. Nothing is redundant or padded.

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 two-parameter read-only lister with no output schema, the description supplies the missing return-shape information (sidebar-nested structure, per-item URLs for read_page). Only the hierarchy depth and ordering behavior remain unspecified, which is minor for this complexity.

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%, with both section and version documented as slugs sourced from list_sections and list_versions. The description adds only the framing 'one documentation section' and does not mention the optional version parameter at all, so it stays at the baseline rather than improving 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?

The description names a specific verb and resource (list the pages) and constrains scope to 'one documentation section', which separates it from list_sections and list_versions. It also ties the result to read_page, so an agent knows what it is getting, though it does not explicitly contrast itself with search.

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 establishes the workflow context implicitly: pick a section, enumerate its pages, then feed those URLs to read_page. There are no exclusions or explicit 'use X instead when...' statements, and the guidance on when to prefer search over this listing is absent.

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