biz.dfch.SpecMgr

Overview Schema Source Related Servers Discussions Admin

Get use case

get_uc

Read and parse a full use-case document by its ID, returning frontmatter and body, or use raw mode to retrieve verbatim body text with optional line windowing and language variants.

Instructions

Read, parse, and return a full use-case 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_uc -- 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/uc/ document, exactly the default behavior; any other ISO 639-1-shaped lowercase two-letter code (e.g. 'de') = that language's variant at docs/uc/{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_uc(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 / UcFrontmatter / properties / status / enum
```
Added value: +[
+  "accepted",
+  "deprecated",
+  "draft",
+  "proposed",
+  "superseded"
+]
```
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 supplied, the description carries the full burden and does so: it discloses that parse failures return a ParseFailureResult rather than raising, that invalid ids and path-injection payloads raise ValueError before any file access, that out-of-range offset/limit clamp, and that cross-parameter combinations (numbered with raw=False, coordinates with raw=False) raise ValueError. It also flags the real hazard of feeding numbered text back into content/old_str, which no structured field conveys.

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?

Purpose is correctly front-loaded in sentence one and the content is substantive, but the prose is dense and over-stuffed for a read tool: the byte-identical ParseFailureResult claim is made twice (default and variant), the ADR id and the trailing-pydantic-documentation detail add little to tool selection, and the parenthetical '(like offset/limit)' restatements recur. Several sentences could be consolidated without losing behavioral signal.

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 a language-variant dimension and three distinct failure modes, the description covers what an agent needs: mode selection, windowing, numbering semantics, variant resolution and its pre-access validation, plus the shape of ParseFailureResult. An output schema exists, so the description is not obliged to document success payloads, and the extra error-shape detail is a bonus rather than a gap.

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% across six parameters, so the description must compensate and largely does: raw, offset (1-based default 1), limit (default through end), numbered (with its "<n>: " format and non-restarting numbering), and language (default 'en' vs a lowercase two-letter variant path) are all given semantics the schema lacks. Only `id`'s accepted format is described negatively ('wrong format' → ValueError) rather than positively.

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?

Opens with a specific verb+resource ('Read, parse, and return a full use-case document (frontmatter and body) by its id') and immediately names the sibling behavior it is not (raw body extraction). It also names the related tools an agent might otherwise confuse it with (list_uc, update, create_uc, edit), so it is distinguishable from siblings without opening any 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 a strong decision rule between the two operating modes (raw=False for the parsed document, raw=True for frontmatter-stripped verbatim body) plus windowing, and explains when numbered output is useful (feeding line numbers back into update's offset). What it does not state explicitly is when to prefer get_uc over list_uc/parse_uc for retrieval — that is left to inference from 'by its id'.

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

Deploy Server