biz.dfch.SpecMgr

Overview Schema Source Related Servers Discussions Admin

Get System Requirements Specification

get_sysrs

Retrieve and parse a System Requirements Specification by ID, returning structured frontmatter and body. Raw mode returns body text verbatim, optionally line-windowed or for a language variant.

Instructions

Read, parse, and return a full System Requirements Specification document (frontmatter and body) by its id. Pass raw=True to return the frontmatter-stripped body text verbatim instead. With raw=True, optional read-style offset/limit window the raw read: offset (1-based, default 1) is the first body line to return, limit (line count, default through end of body) how many; out-of-range values clamp (offset > N returns the empty string), and coordinates with raw=False raise ValueError. A document that exists but fails to parse returns a ParseFailureResult (error/path/id) instead of raising; its error text is byte-identical to the domain's own list tool's failed-row error for the same file (identical field path and cause, including the trailing pydantic documentation line; ADR 9080b37c-82b3-4f63-81f1-79641d0bf14c). An invalid id (path-injection attempt or wrong format) is also a ValueError, raised before any file access. With raw=True, an optional numbered=True prefixes every returned body line with its 1-based absolute body-line number in the "<n>: " form (plain decimal, no padding) -- under offset/limit windowing the numbers start at the clamped offset and never restart at 1, so a number seen in the output can be fed straight back into the generic update tool's offset. numbered is meaningful only with raw=True: combining it with raw=False raises ValueError (like offset/limit), and a numbered read of a document that fails to parse returns the ParseFailureResult described above, never numbered text. Numbered output must never be fed back verbatim into content for update or create_sysrs -- strip the "<n>: " prefix from each line first (it is likewise never a valid edit old_str). The optional language parameter (default 'en') selects the language variant to read: omitted/'en' = the flat docs/sysrs/ document, exactly the default behavior; any other ISO 639-1-shaped lowercase two-letter code (e.g. 'de') = that language's variant at docs/sysrs/{language}/ (the EN source's exact basename). The language is shape-validated before any file access (a path-injection-shaped payload 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, also before any file access. A raw=True read of a variant returns the variant's on-disk body verbatim (translation preserved); a raw=False read parses it through the variant's heading table, so the structured model holds canonical heading text. The ParseFailureResult error of a broken variant is byte-identical to list_sysrs(language=...)'s failed row for the same file.

Input Schema

Name	Required	Default
`id`	Yes
`raw`	No
`limit`	No
`offset`	No
`language`	No	en
`numbered`	No

Output Schema

Name	Required	Description	Default
`result`	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"
+}

Changed1 schema field changedv0.37.0Oct 24, 2026
- addedOutput schema / $defs / SysrsFrontmatter / properties / status / enum
```
Added value: +[
+  "active",
+  "approved",
+  "draft",
+  "retired",
+  "review"
+]
```
First observedv0.36.0Oct 17, 2026

TDQS

A4.6/5.0

Behavior5/5

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

With no annotations, the description carries the entire behavioral burden and does so thoroughly: parse failures return a ParseFailureResult rather than raising, its `error` is byte-identical to the sibling list tool's failed row, invalid ids and path-injection payloads raise ValueError before any file access, and language shape validation and heading-table rejection both occur up front. It even distinguishes raw-variant reads (translation preserved) from parsed-variant reads (canonical headings). Nothing material about failure modes or side effects is left undisclosed.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core operation is front-loaded and nearly every clause carries real information, but the body is a single dense paragraph of em-dash-chained run-ons that is hard to scan. The ADR identifier and the repeated restatement of the ParseFailureResult error-equivalence add bulk relative to their decision value. Structure is the weak point of an otherwise informative definition.

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 six-parameter read tool with an output schema, the description supplies everything the agent needs: mode interactions, clamping semantics, failure representation, validation ordering, and cross-tool constraints. Despite the output schema existing, it still characterizes the ParseFailureResult shape, which removes ambiguity about non-raising failures.

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 supply all parameter meaning, and it does: `offset` is 1-based with default 1 and clamps out-of-range (offset > N yields empty string), `limit` defaults through end of body, `raw` toggles frontmatter-stripped verbatim output, `numbered` prepends absolute 1-based line numbers that do not restart under windowing, and `language` defaults to 'en' with variants at docs/sysrs/{language}/. It also states the invalid combinations that raise ValueError.

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?

First sentence gives a specific verb-plus-resource: 'Read, parse, and return a full System Requirements Specification document (frontmatter and body) by its id.' The sibling distinction is implicit but strong, since the raw/numbered/language semantics clearly separate it from list_sysrs and parse_sysrs. An agent can identify the operation and its scope immediately.

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?

The description is explicit about mode selection (raw=True vs default, numbered only with raw, language variants) and names the ValueError conditions that gate each mode. It also warns about the concrete downstream flows: numbered output must not go into `content` or `edit` `old_str`, and numbers can be fed back into `update`'s `offset`. It stops short of stating outright when to prefer list_sysrs/parse_sysrs instead, which is the only gap.

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

Deploy Server