Skip to main content
Glama

List documentation pages

list_docs
Read-only

Lists available documentation pages with IDs, titles, and URLs, optionally filtered to Marko or evo-web docs so you can locate relevant references.

Instructions

List available documentation pages (id, title, URL), optionally limited to Marko docs or evo-web docs.

Input Schema

NameRequiredDescriptionDefault
sourceNoDefault: all.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description adds returned fields (id, title, URL) and filter behavior, but omits ordering, pagination, or rate-limit details.

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 purpose and return fields, with no wasted wording.

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 list tool with one optional enum parameter and no output schema, the description covers purpose, return fields, and filtering. It could mention ordering or pagination, but those may not apply.

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 coverage is 100% and the enum already defines all/marko/evo with a default of all. The description clarifies that marko and evo correspond to Marko docs and evo-web docs, adding minor semantic value beyond the schema.

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 ('List') and resource ('documentation pages'), plus the returned fields and optional source filter. It does not explicitly name search_docs as the alternative, but the list-vs-search distinction is clear enough.

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?

Explains that results can optionally be limited to Marko docs or evo-web docs, which implies when to use the source filter. It does not state when to prefer search_docs or get_doc, nor any exclusions.

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