Skip to main content
Glama

Farm.js Docs

List docs pages

list_pages
Read-only

List the known documentation pages with titles, slugs, and URLs.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
cursorNoOpaque nextCursor from the preceding response page.
localeNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pagesYes
totalYesItems in the complete filtered result set.
hasMoreYesWhether another response page is available.
nextCursorNoOpaque cursor to pass as cursor on the next request.
resultCountYesItems returned in this response page.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

C2.9/5.0
Behavior2/5

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

readOnlyHint=true already establishes this as a safe read. The description adds nothing beyond the annotation: no note on pagination semantics, whether the list is complete or partial ('known' is ambiguous), or scoping to a locale. It restates a return shape that the output schema already provides.

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 front-loaded sentence with zero filler; the core action and payload are stated immediately.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/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 values need not be re-explained, and a cursor param signals pagination. However, the unexplained locale parameter and the failure to distinguish this from read_pages/list_docs leave real gaps for a tool sitting among 15 siblings.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is only 50%: cursor is documented in the schema but locale has no description anywhere. The description does not compensate, saying nothing about how locale filters results or how cursor paging works.

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) and even names the returned fields (titles, slugs, URLs). It does not distinguish itself from semantically close siblings like read_pages or list_docs, so an agent cannot fully resolve routing from the description alone.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no prerequisites, and no named alternative. The agent must infer from the name alone whether this or read_pages/list_page_sections is the right tool.

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.