biz.dfch.SpecMgr

Overview Schema Source Related Servers Discussions Admin

Get goal

get_gol

Read, parse, and return a full goal document (frontmatter and body) by its id. Pass raw=True to return the frontmatter-stripped body text verbatim instead.

Instructions

Read, parse, and return a full goal 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_gol -- 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/gol/ document, exactly the default behavior; any other ISO 639-1-shaped lowercase two-letter code (e.g. 'de') = that language's variant at docs/gol/{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_gol(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 / GolFrontmatter / properties / status / enum

Added value: +[
+  "accepted",
+  "deprecated",
+  "draft",
+  "implemented",
+  "proposed",
+  "rejected",
+  "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, the description carries the full burden and does so: it discloses that invalid ids and path-injection payloads raise ValueError before any file access, that unparseable documents return a ParseFailureResult rather than raising, that out-of-range offset/limit values clamp, and that mixing offset/limit/numbered with raw=False raises ValueError. It even warns that numbered output is not valid input for update content or edit old_str.

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 content is valuable but delivered as one unbroken ~400-word block with no paragraphing or bullets, so the default raw=False path is buried behind secondary raw=True windowing details. The byte-identical ParseFailureResult claim (including a full ADR UUID) is stated twice, once in the middle and again in the final sentence, which is redundant.

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 6-parameter tool with an output schema and zero annotation coverage, the description covers everything an agent needs: parse-failure shape, error paths, parameter interactions, and language-variant parsing semantics. Nothing material about calling it correctly is left unstated.

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%, yet every non-trivial parameter is fully specified: offset is 1-based with default 1 and clamping behavior, limit defaults to through-end-of-body, numbered emits "<n>: " 1-based absolute line numbers that continue past a windowed offset, and language defaults to 'en' with the flat path versus docs/gol/{language}/ variant rule. This compensates entirely for the empty schema descriptions.

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 concrete verb+resource+scope: "Read, parse, and return a full goal document (frontmatter and body) by its id," and immediately contrasts that with the raw=True body-text mode. An agent can tell this apart from list_gol, parse_gol, and create_gol without opening a 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 explicit conditions for the major modes: raw=True for verbatim frontmatter-stripped body, offset/limit only meaningful with raw=True, numbered only with raw=True, and language variants selected via ISO-shaped codes. It never explains when to pick this over the sibling parse_gol tool, which is the one remaining routing ambiguity.

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

Deploy Server