biz.dfch.SpecMgr

Overview Schema Source Related Servers Discussions Admin

Get System Requirements Specification

get_sysrs

Read and parse a System Requirements Specification document by ID, returning full frontmatter and body, or raw body text with optional line windowing.

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).

Input Schema

TableJSON Schema

Name	Required	Description	Default
`id`	Yes
`raw`	No
`limit`	No
`offset`	No
`numbered`	No

Output Schema

TableJSON Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.36.0Oct 17, 2026

TDQS

A4.3/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 behavioral burden and does a good job: it explains ParseFailureResult behavior for unparseable documents, ValueError for invalid ids raised before file access, and the fact that numbered read of parse-failing doc returns ParseFailureResult. It lacks detail on permissions/auth or whether the read is safe (read-only implied but not stated).

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 description is front-loaded with core purpose but becomes quite long and dense, with multiple nested clauses and parentheticals. While information-rich, it violates conciseness by packing many behavioral rules into a single paragraph without clear structural separation.

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?

Given output schema exists, return value explanations aren't strictly necessary, and the description does not need to enumerate return fields. It is fairly complete for a read tool with complex parameter interactions, covering edge cases, error modes, and tool interop. Minor gap: no mention of authentication/permissions or rate limits.

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 thoroughly: raw toggles frontmatter stripping, offset is 1-based first body line (default 1, clamps out-of-range), limit is line count (default through end), numbered prefixes lines with absolute body-line numbers meaningful only with raw=True. It also explains ValueError conditions from incompatible combinations.

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?

The description states a specific verb and resource: 'Read, parse, and return a full System Requirements Specification document (frontmatter and body) by its id.' This clearly distinguishes get_sysrs from siblings like list_sysrs and parse_sysrs by emphasizing full document retrieval by id.

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 explains when to use raw=True (to get frontmatter-stripped body text verbatim) and how offset/limit/numbered interact with raw mode. It even describes how numbered output connects to the `update` tool's offset parameter. However, it does not explicitly state when to choose get_sysrs vs. parse_sysrs or list_sysrs.

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

Deploy Server