Skip to main content
Glama

List free-form text documents

list_txt

Lists free-form text documents with ids, titles, statuses, and refs page by page, optionally filtered by glob or language, so you can choose a document before retrieving it by id.

Instructions

Ids, titles, statuses, and refs of free-form text documents in the configured free-form text base directory, one page at a time, for context before addressing one by id. 'ref' is an opaque, extensionless identifier -- not a filename to read from disk -- for documents that have no assigned id; use it with the get_txt tool instead. An optional glob pattern (e.g. 'dead*') filters the listing to the free-form text documents whose id matches it, case-insensitively; glob=None (the default) lists everything, and an empty string matches nothing. max_results/offset control paging (default page size 25, capped at 100); out-of-range values are clamped, not errored. The optional language parameter (default 'en') selects the directory scanned: omitted/'en' = the flat docs/txt/ directory (the default behavior, unchanged); any other ISO 639-1-shaped lowercase two-letter code (e.g. 'de') = only that language's docs/txt/{language}/ subdirectory, listing exactly the existing variants of that language (there is deliberately no 'all languages' mode). The language is shape-validated before any file access (an invalid-shaped value is a ValueError, like an invalid id), and a shape-valid language without a packaged heading-mapping table is rejected up front with an actionable ValueError.

Input Schema

NameRequiredDescriptionDefault
globNo
offsetNo
languageNoen
max_resultsNo

Output Schema

NameRequiredDescriptionDefault
totalYes
offsetYes
resultsYes
truncatedYes
error_countNo
max_resultsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.38.0

TDQS

A4.7/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden and does so well: it discloses paging defaults (25, capped at 100), that out-of-range values are clamped rather than errored, that invalid-shaped language codes raise ValueError before any file access, and that a shape-valid language lacking a heading-mapping table is rejected up front. It doesn't explain sorting order or what 'statuses' actually mean, which keeps it just shy of a 5.

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 listing behavior is front-loaded and most sentences earn their place, but the language sentence is dense and repeats itself ('omitted/'en' = the flat docs/txt/ directory (the default behavior, unchanged)'). The parenthetical redundancies and nested clauses make it slower to parse than necessary.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return-value documentation is correctly omitted, and the description covers everything else the agent needs for a filtered, paginated, language-scoped list: filtering semantics, paging limits, error conditions, and the ref-handoff to get_txt. Nothing material is missing for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/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 entirely, and it does: glob is case-insensitive against ids with an example ('dead*'), None lists everything, and empty string matches nothing; max_results/offset have defaults, caps, and clamping semantics; language has a default, an ISO 639-1 shape constraint, and a precise directory-mapping rule. This is meaning the schema cannot convey on its own.

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 opens with a specific verb and resource ('Ids, titles, statuses, and refs of free-form text documents in the configured free-form text base directory') and immediately distinguishes itself from the sibling get_txt, which retrieves a single document by id. An agent can tell list_txt apart from get_txt, list_languages, and the other list_* siblings without opening any schema.

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

Usage Guidelines5/5

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

It states the intended use case ('for context before addressing one by id') and names the alternative explicitly: opaque 'ref' values must be passed to get_txt rather than treated as filenames. It also covers the default behavior (glob=None lists everything) and the deliberate absence of an 'all languages' mode, leaving little to infer.

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

Deploy Server

Other Tools