Skip to main content
Glama

Farm.js Docs

Read several docs pages

read_pages
Read-only

Read up to 20 documentation pages in one round trip. Results preserve request order and share a conservative UTF-8 token budget.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathsYesPage slugs or URL paths to read in the requested order.
localeNo
tokenBudgetNo
maxCharsPerPageNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pagesYes
budgetYes
errorsYes
formatYes
resultCountYes
remainingPathsYes
requestedCountYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the description does not need to explain safety. It does add useful behavior beyond annotations: results preserve request order and share a conservative UTF-8 token budget. However, it remains vague about budget defaults, truncation behavior, and what happens when the budget is exceeded.

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?

Two sentences, front-loaded with the core action and scope, with no filler or repetition. The second sentence adds distinct behavioral information about ordering and token budgeting. Every sentence earns its place.

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

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Although an output schema exists so return values need not be explained, the input schema has three undocumented parameters and the description does not compensate. It also omits usage guidance against siblings like read_page. For a multi-page read tool with a token budget and per-page character limit, this leaves key invocation details uncovered.

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 description coverage is only 25%, with just the paths parameter documented. The description repeats the 20-page limit and request-order behavior already stated in the schema, and only vaguely gestures at tokenBudget. It does not explain locale, maxCharsPerPage, or how the shared token budget is applied or overridden.

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 states a specific verb and resource: read documentation pages, with a clear batch scope of up to 20 pages in one round trip. It implicitly distinguishes itself from read_page by emphasizing multiple pages, but does not explicitly name or contrast with the sibling. This is clear but lacks the explicit sibling differentiation seen in top-tier definitions.

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?

The description gives no when-to-use guidance and does not mention alternatives such as read_page or list_pages. The batch limit implies a multi-page use case, but an agent receives no explicit rule for choosing this tool over its siblings. This is a significant gap given the presence of closely related tools.

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.