Skip to main content
Glama

list_docs

List documentation pages from crawled sites, optionally filtered by section or category.

Instructions

List captured pages, optionally filtered to one section or category.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
sectionNo
categoryNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior2/5

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

No annotations are provided, so the description carries full burden. It only states that the tool lists pages with optional filters, but does not disclose whether it is read-only, how pagination works, or what the response format is. The presence of an output schema does not excuse the description from providing behavioral context.

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?

The description is a single sentence that is efficient and front-loaded. It conveys the core purpose and key parameters without unnecessary words. Could be slightly improved with more detail, but remains appropriately concise.

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?

For a simple list tool with three optional parameters and an output schema, the description covers the basic purpose and filter options. However, it lacks details on ordering, default behavior, and total count. The output schema likely provides return value info, but the description could be more complete regarding pagination and scope.

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 compensate. It explains the 'section' and 'category' parameters by mentioning optional filtering. However, the 'limit' parameter is not described, leaving its purpose (e.g., pagination) unclear. Partial coverage but adds value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb 'List' and identifies the resource as 'captured pages'. It distinguishes from sibling tools: search_docs implies query-based search, get_doc retrieves a single document, refresh_docs updates data. Listing with optional filters is a distinct operation.

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?

The description mentions optional filtering by section or category, providing context for when to use those parameters. However, it does not explicitly state when to use this tool over alternatives like search_docs, nor does it mention any exclusions or prerequisites.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/gabrielassisxyz/docs-to-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server