Skip to main content
Glama

List System Requirements Specifications

list_sysrs

Lists System Requirements Specifications with ids, titles, statuses, and refs for context before retrieving one by id. Filter by id glob and page results with max_results/offset.

Instructions

Ids, titles, statuses, and refs of System Requirements Specifications in the configured System Requirements Specification 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_sysrs tool instead. An optional glob pattern (e.g. 'dead*') filters the listing to the System Requirements Specifications 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.4/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 burden and does well: it discloses page size defaults (25) and cap (100), that out-of-range values are clamped rather than errored, that glob=None lists everything while an empty string matches nothing, and that refs are opaque extensionless identifiers not disk filenames. Read-only safety is only implied by 'list', and no auth/permission requirements are mentioned.

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 semantics; every sentence carries information. It is dense and slightly long, but no sentence is filler or redundant with structured fields.

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?

An output schema exists, so return values need not be described, and the description covers filtering, paging, and the ref/id distinction adequately. It could still note ordering of results or that it is a read-only operation, but nothing essential for correct invocation is missing.

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: glob semantics (case-insensitive id match, e.g. 'dead*', None default, empty-string behavior) and max_results/offset paging behavior with defaults, cap, and clamping are all spelled out beyond anything the schema provides.

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 (System Requirements Specifications), names the exact fields returned (ids, titles, statuses, refs), and scopes it to the configured base directory. It also distinguishes itself from the sibling get_sysrs by explaining that 'ref' is not an id and must be resolved via that tool.

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 context ('for context before addressing one by id') and routes the ref case explicitly to get_sysrs. It does not state any exclusion such as when to prefer parse_sysrs or a full read instead, so it stops short of full when/when-not guidance.

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