Skip to Content
ConceptsFrontmatter

Frontmatter

Every Context Nest document begins with a YAML frontmatter block delimited by ---. The frontmatter contains structured metadata that the resolver, validator, and index generator use.

Required fields

FieldTypeDescription
titlestringHuman-readable title (1–200 characters)

Standard fields

FieldTypeDefaultDescription
typestringdocumentNode type (see Node Types)
tagsstring[][]Tags prefixed with # (e.g. ["#engineering", "#api"])
statusstringdraftdraft or published
versioninteger1Current version number (auto-incremented on publish)
authorstringAuthor identifier
descriptionstringBrief description for index listings
created_atISO 8601Creation timestamp
updated_atISO 8601Last update timestamp
derived_fromstringcontextnest:// URI of the source document

Source node fields

Source nodes include an additional source block:

source: transport: mcp # mcp, rest, cli, or file server: jira # Server name from config.yaml registry tools: # Tools used by this source - jira_get_sprint_issues depends_on: # Other sources this depends on - contextnest://sources/project-config cache_ttl: 300 # Cache lifetime in seconds

See Source Nodes for the full source frontmatter reference.

Example

--- title: "Architecture Overview" type: document tags: ["#engineering", "#architecture"] status: published version: 4 author: "alice@example.com" description: "High-level system architecture and key decisions" created_at: "2026-01-15T10:00:00Z" updated_at: "2026-03-10T14:30:00Z" ---
Last updated on