List use cases
list_ucList use case IDs, titles, statuses, and refs from the configured base directory with paging, glob filtering, and optional language selection for context before fetching one by ID.
Instructions
Ids, titles, statuses, and refs of use cases in the configured use-case 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_uc tool instead. An optional glob pattern (e.g. 'dead*') filters the listing to the use cases 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/uc/ directory (the default behavior, unchanged); any other ISO 639-1-shaped lowercase two-letter code (e.g. 'de') = only that language's docs/uc/{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 | Description | 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 |