biz.dfch.SpecMgr

Overview Schema Source Related Servers Discussions Admin

Get requirement

get_req

Retrieve and parse a requirement document by its id. Returns full structure or raw body text with optional offset, limit, and line numbering.

Instructions

Read, parse, and return a full requirement 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_req -- 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.7/5.0

Behavior4/5

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

No annotations are provided, so the description carries the full behavioral burden. It discloses parsing failure behavior (returns ParseFailureResult rather than raising), invalid id raising ValueError before file access, offset/limit clamping semantics, and the error text being byte-identical to the list tool's failed-row error. It does not describe authentication, rate limits, or output schema details, but output schema exists.

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?

The description is dense but front-loads the core purpose, then layers optional behavior in a logical order. It is longer than ideal, with some redundancy around raw=True semantics and numbered output warnings, but each sentence adds distinct information that an agent needs to invoke correctly.

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?

Given 5 parameters, 0% schema coverage, no annotations, but an existing output schema, the description covers input semantics, failure modes, constraint interactions, and downstream tool contract warnings. It is complete enough for correct invocation without needing to inspect the schema or other tools.

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 fully compensate. It documents raw (frontmatter-stripped body verbatim), offset (1-based, default 1, first body line), limit (line count, default through end), numbered (prefixes lines with absolute body-line number, meaningful only with raw=True), and the coordinate constraints 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?

The description opens with a specific verb+resource: 'Read, parse, and return a full requirement document (frontmatter and body) by its id.' It immediately distinguishes itself from siblings like get_req_template or parse_req by stating what it returns and how raw mode changes behavior.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly states when to use raw=True vs raw=False, when offset/limit apply, when numbered applies, and what combinations raise ValueError. Names the downstream tools (update, create_req, edit) that must not receive numbered output, giving clear when-not-to-use guidance.

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

Deploy Server