Skip to main content
Glama

List what the documents cover

list_documents
Read-onlyIdempotent

Lists every document, optionally filtered by kind ('guide', 'article' or 'faq'), by category, or, for guides, by the reader they are written for. Guides are shelved by perspective: 'considering', 'buying', 'selling', 'installing' and 'learning'. The first four are plain language and name no standards; 'learning' carries the methods and the citations. Match the perspective to the person asking. Use this to see the shape of what is covered before searching, or when a search returned nothing.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindNoFilter by kind: 'guide', 'article' or 'faq'. Optional.
levelNoArticles only. Filter by how much the piece assumes: 'beginner', 'intermediate' or 'advanced'. Use it to match the person asking, so somebody new is not sent to an advanced piece.
categoryNoFilter by category: 'heat-pumps', 'solar-pv', 'batteries', 'standards' or 'paperwork'. Optional.
perspectiveNoGuides only. Filter by who the guide is written for: 'considering' (still deciding), 'buying' (about to commit), 'selling' (sells these systems), 'installing' (fits them) or 'learning' (wants the technical detail). Use this to match the reader: the first four are plain language and name no standards, the fifth carries the methods and citations.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteNo
countYes
levelsYesHow much articles assume of the reader. Match it to the person asking.
documentsYes
categoriesYes
perspectivesYesWho the guides are written for. Match the reader before quoting one at them.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is fully covered. The description adds content-shape context (guides are shelved by perspective, first four plain-language, 'learning' carries methods and citations) but adds nothing behavioral beyond that, and return format is covered by the output schema.

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?

Front-loaded with the core action and then usage, which is good ordering. However, the perspective enumeration is repeated verbatim in the schema, making the middle of the description somewhat redundant rather than earning its place.

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?

With an output schema present, return values need not be explained, and the description covers purpose, filter dimensions and usage context adequately. It leaves minor gaps around result volume/pagination, but nothing that would prevent correct invocation.

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%, so the schema already documents all four filters, including the perspective values. The description largely restates the same perspective/category semantics the schema provides, so it adds little new parameter meaning beyond the baseline.

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 states a specific verb and resource ('Lists every document') plus the optional filter dimensions, and it is clearly separable from search_documents through the phrase 'before searching, or when a search returned nothing'. An agent can tell what enumeration means here without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

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

It gives explicit when-to-use conditions against the search sibling ('to see the shape of what is covered before searching, or when a search returned nothing'). It does not name get_document or state when not to use this tool, so it falls just short of full routing guidance.

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