Skip to main content
Glama

List the documentation pages

list_docs
Read-only

Lists the API documentation pages, grouped by product: general (quickstart, authentication, errors, pricing, webhooks), rfc, cfdi, curp, ine, geo, and cfe. Free, and works without logging in.

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_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
productNoOnly list this product's pages.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds genuinely new behavioral context beyond that: the operation is free and requires no authentication, and the result is grouped by product with the group names listed.

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 sentence, front-loaded with the verb and resource, followed by the grouping scope and the access constraint. No filler or repetition.

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?

For a simple, read-only, parameter-light listing tool, the description covers scope, output grouping, cost, and auth requirements, which is what an agent needs to call it. The only notable omission is routing guidance to read_doc for fetching actual page content.

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 optional enum parameter is fully documented in the schema, so the description need not carry the burden. The phrase "grouped by product" and the product list reinforce what the enum values mean, but add little beyond the schema itself.

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 ("Lists the API documentation pages") and enumerates the product groupings, giving the agent a precise picture of scope. It does not explicitly say it is the discovery counterpart to read_doc, so the boundary with that sibling is left implicit.

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 implied rather than stated: an agent can infer this is the entry point for browsing docs before fetching content. There is no explicit when-to-use, when-not-to-use, or named alternative such as read_doc for retrieving a specific page.

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