Skip to main content
Glama

LexOpti developer documentation

Read a documentation page

get_page
Read-onlyIdempotent

Reads a page of the documentation as Markdown, or one of its sections (by its heading). A page without French version answers in English, with fallback: true.

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": {
      "slug": "<slug>"
    },
    "name": "get_page"
  }
}

Input Schema

NameRequiredDescriptionDefault
langNoLanguage of the documentation: en (default) or fr.en
slugYesThe page, as list_pages names it.
sectionNoA heading of the page (as list_pages or search_docs gave it).

Output Schema

NameRequiredDescriptionDefault
urlYes
langYes
slugYes
titleYes
sectionYes
fallbackYes
markdownYes
sectionsYes
truncatedYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.7/5.0
Behavior4/5

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

Beyond the readOnly/idempotent annotations, the description discloses a non-obvious fallback rule — requesting French on an untranslated page returns English with a 'fallback: true' marker. It does not explain section-matching behavior (exact heading? case-sensitive? partial?), which is the remaining behavioral gap.

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?

Two sentences, front-loaded with the primary action and followed by the fallback caveat; no filler. The phrase 'with fallback: true' is terse to the point of being slightly opaque to a reader who has not seen the response shape.

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 the core read path is covered. What is missing is routing guidance among siblings and any note on how a section heading is matched, which matters for a tool whose slug enum is this long.

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

Parameters4/5

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive), so the description's real contribution is the language behavior: a page with no French version answers in English and flags 'fallback: true'. That adds meaning beyond the lang enum in the schema, and section-by-heading selection is clarified too.

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 ('Reads a page of the documentation as Markdown, or one of its sections'), which an agent can distinguish from list_pages and search_docs by the fact that it returns content rather than an index or matches. It does not explicitly name the siblings, so differentiation is inferable 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 Guidelines3/5

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

Usage is only implied: the reader must infer that list_pages supplies slugs and search_docs is for discovery, then get_page for reading. There is no explicit when-to-use or when-not-to-use statement, though the schema hints ('as list_pages names it') quietly reinforce the workflow.

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