Skip to main content
Glama

LexOpti developer documentation

List the documentation pages

list_pages
Read-onlyIdempotent

Lists every page of the documentation with its slug, title and description.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

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

Input Schema

NameRequiredDescriptionDefault
langNoLanguage of the documentation: en (default) or fr.en

Output Schema

NameRequiredDescriptionDefault
pagesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile needs no restating. The description adds that results are a complete enumeration with summary fields, but says nothing about pagination, result size limits, or whether the listing is scoped by the lang parameter.

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?

One sentence, front-loaded with the verb and scope, with no filler or redundant restatement of the title. Every clause carries information.

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?

The tool is simple (zero required parameters), has full annotation coverage and an output schema, so the description needn't explain return values and correctly focuses on scope. It falls just short of complete because it omits behavior around the lang filter and any note on how many pages come back.

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% and the single lang parameter is fully documented in the schema with its enum and default, so the baseline of 3 applies. The description never mentions that the listing is language-specific, which is a missed opportunity but not a defect given the schema already covers it.

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 gives a specific verb and resource ('Lists every page of the documentation') and even names the returned fields (slug, title, description), so an agent knows exactly what it does. It does not differentiate itself from siblings like get_page or search_docs, which is the only thing keeping it from a 5.

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 exclusions, and no reference to alternatives such as search_docs for filtered lookup or get_page for retrieving a single page's content. The word 'every' hints at enumeration, but the agent is left to infer that this is the bulk-listing 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.

Resources