Skip to main content
Glama

List requirements

list_req

List requirement ids, titles, statuses, and refs with paging and optional glob filtering to identify requirements before retrieving one by id.

Instructions

Ids, titles, statuses, and refs of requirements in the configured requirement 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_req tool instead. An optional glob pattern (e.g. 'dead*') filters the listing to the requirements 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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
globNo
offsetNo
max_resultsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
totalYes
offsetYes
resultsYes
truncatedYes
error_countNo
max_resultsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.36.0

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 well: it discloses paging defaults (25, capped at 100), that out-of-range values are clamped rather than errored, that glob matching is case-insensitive, that glob=None lists everything, and that an empty string matches nothing. Auth/error behavior beyond clamping is not covered, keeping it out of the top band.

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 resource and returned fields, then parameters and paging; every sentence is informative. The ref explanation is slightly verbose but earns its place by preventing a filename-vs-identifier misuse.

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 not required, yet the description still names the returned fields. Combined with full parameter and paging semantics, an agent has everything needed to call it correctly.

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, and it does: glob is defined by matching target, case-insensitivity, an example ('dead*'), None vs empty-string semantics; max_results/offset are explained as paging controls with defaults and clamping behavior.

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?

States a specific verb (list) and resource (requirements), and enumerates the returned fields (ids, titles, statuses, refs) plus the source directory, making it immediately distinguishable from get_req. An agent can tell what this does and what it yields 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?

Gives clear context ('for context before addressing one by id') and routes the 'ref' case explicitly to the get_req tool. It stops short of stating negative cases (e.g. do not use this to retrieve full requirement content), so it is strong but not exhaustive.

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