biz.dfch.SpecMgr

Overview Schema Source Related Servers Discussions Admin

List QA documents

list_qa

Lists QA documents with IDs, titles, statuses, and refs; filter by glob, page results, or select a language directory to find the document to retrieve by ID.

Instructions

Ids, titles, statuses, and refs of QA documents in the configured QA 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_qa tool instead. An optional glob pattern (e.g. 'dead*') filters the listing to the QA 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/qa/ directory (the default behavior, unchanged); any other ISO 639-1-shaped lowercase two-letter code (e.g. 'de') = only that language's docs/qa/{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

Name	Required	Default
`glob`	No
`offset`	No
`language`	No	en
`max_results`	No

Output Schema

Name	Required	Description	Default
`total`	Yes
`offset`	Yes
`results`	Yes
`truncated`	Yes
`error_count`	No
`max_results`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv0.38.0Nov 2, 2026

addedInput schema / properties / language

Added value: +{
+  "default": "en",
+  "title": "Language",
+  "type": "string"
+}

First observedv0.36.0Oct 17, 2026

TDQS

A4.5/5.0

Behavior4/5

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

With no annotations, the description carries the full burden and does so well: it discloses clamping instead of erroring on out-of-range paging, that an invalid-shaped language or one lacking a heading-mapping table raises an actionable ValueError, and that there is deliberately no 'all-languages' mode. The main omission is result ordering and whether the listing is a pure read, which is only implied.

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 purpose and return fields, then parameter behavior in descending importance. It is dense and runs as one long block, and a couple of parenthetical asides (e.g. 'the default behavior, unchanged') could be trimmed, but nearly every sentence carries actionable information.

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?

For a four-parameter listing tool with an output schema, the description covers purpose, filtering, paging, language scoping, and error behavior – everything an agent needs to invoke it correctly without trial and error.

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 coverage is 0%, so the description must compensate, and it does for all four parameters: glob semantics (case-insensitive, extensionless refs excluded, None lists all, empty string matches nothing), offset/max_results (default page size 25, capped at 100, values clamped not errored), and language (default 'en', ISO 639-1 shape validation, subdirectory selection, rejection of unsupported languages).

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?

Opens with a specific verb+resource plus the returned fields ('Ids, titles, statuses, and refs of QA documents'), and explicitly separates itself from get_qa ('for context before addressing one by id' / 'use it with the get_qa tool instead'). An agent can distinguish this from get_qa and the create/parse siblings without opening a 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?

Gives a clear use case (gather context before fetching a single document by id) and routes ref-holders to get_qa. It does not state explicit exclusions or contrast with list-style siblings such as list_req/list_languages, but the context in which to reach for it is unambiguous.

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

Deploy Server