NinFenz Content Gate

Overview Schema Source Related Servers Discussions Admin

Read engineering pattern

pattern_read

Read-onlyIdempotent

Reads one engineering pattern's full Markdown—frontmatter, rules, and a counterexample—so you can apply the practice behind a specific NF rule. Provide the exact case-sensitive pattern directory name.

Instructions

Read one engineering pattern's full Markdown from patterns//PATTERN.md, including frontmatter, rules, and a counterexample. Use it for the practice behind an NF rule; do not use it to enumerate patterns (pattern_list) or read domain modules (module_read). pattern_id is the exact, case-sensitive directory name such as fail-closed-verification, not the document title. A missing pattern is an error, not an empty result; reads one local file and returns its full text without truncation. Local-only; no auth or rate limits.

Input Schema

TableJSON Schema

Name	Required	Description	Default
`pattern_id`	Yes	Exact pattern directory name (for example fail-closed-verification or single-source-truth).

Output Schema

TableJSON Schema

Name	Required	Description
`id`	Yes	Pattern directory name.
`path`	Yes	Repository-relative Markdown path.
`text`	Yes	Full PATTERN.md body as stored on disk.
`bytes`	Yes	UTF-8 byte length of text.
`found`	Yes	True when the pattern was located.

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.0.1Oct 18, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Beyond the readOnly/idempotent/closed-world annotations, it discloses error semantics ('a missing pattern is an error, not an empty result'), output fidelity ('full text without truncation'), and operational context ('Local-only; no auth or rate limits'). These are non-obvious traits the agent needs and are not in the annotations.

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?

Front-loads purpose then routes alternatives, parameters, and error behavior. Dense but every clause carries information; slightly packed into long sentences rather than cleanly separated.

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?

An output schema exists so return format needn't be restated, and the description still notes full untruncated text. For a single-file read tool, an agent has everything needed to call it correctly and interpret errors.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so baseline is 3, but the description adds real meaning: pattern_id is case-sensitive and is the directory name, not the document title (e.g. fail-closed-verification). That disambiguation goes beyond the schema's own wording.

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?

States a specific verb and resource ('Read one engineering pattern's full Markdown') plus the exact location (patterns/<id>/PATTERN.md) and contents (frontmatter, rules, counterexample). It also names the sibling tools it is not, so an agent can distinguish it 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 Guidelines5/5

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

Gives an explicit use case ('for the practice behind an NF rule') and explicit exclusions with named alternatives: pattern_list for enumeration and module_read for domain modules. Nothing is left to inference about when to pick this tool.

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

Deploy Server