Skip to main content
Glama

Farm.js Docs

Read a docs page

read_page
Read-only

Read a documentation page by slug or URL path, optionally selecting one heading and limiting returned characters.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
localeNo
sectionNo
maxCharsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageYes
charsYes
anchorNo
sectionNo
documentYes
truncatedYes
totalCharsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior3/5

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

Annotations declare readOnlyHint=true, so the safety profile is already covered and the description does not contradict it. It adds useful behavioral context about scoping output to one heading and capping returned characters, but says nothing about what happens for an unknown slug, missing section, or truncation.

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 no filler; each clause maps to a distinct capability (identifier form, heading selection, output capping). Nothing needs to be cut.

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 described, and readOnlyHint covers safety. However, for a 4-parameter tool with 0% schema coverage, leaving locale undefined and omitting error/truncation behavior leaves the definition only minimally viable.

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 0%, so the description must carry the load: it clarifies path accepts a slug or URL path, that section selects one heading, and that maxChars limits returned characters. It leaves locale entirely unexplained, so one of four parameters is undocumented in both schema and description.

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 and resource ('Read a documentation page') and clarifies the accepted identifier form ('by slug or URL path'), which lets an agent distinguish it from list_pages or get_navigation. It stops short of explicitly contrasting with its closest sibling, read_pages, so sibling differentiation is implied rather than stated.

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 statement of when to prefer this over read_pages (plural) or list_page_sections, and no mention of prerequisites or failure behavior for a bad slug. The optional behaviors are mentioned but never framed as selection criteria.

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.