Guide

Authoring

What a superlore document is — MDX, a typed frontmatter envelope, and dual-representation components — and how to write one.

A superlore document is MDX: a typed frontmatter block, then Markdown prose enriched with superlore components. You write it once, and the same file becomes two things — a polished page for humans and a structured node in the corpus the MCP serves to agents.

One file, two faces

You never author the human page and the agent data separately. The frontmatter and the components carry both. Get the source right and the two faces can't drift.

The three parts of a page

Frontmatter — the knowledge envelope

A YAML block at the top: title, plus optional summary, tags, icon, and description. It's what search ranks on and what get_page returns as the page's header. See Frontmatter.

Prose — the connective tissue

Plain Markdown between components. Headings become stable section ids the MCP can address as $ {path}#${id}, so keep them meaningful.

Components — the structured knowledge

Reach for a component instead of a prose table or a screenshot. Each one renders for humans and serializes a typed knowledge face for agents — the dual-representation contract.

Where to next

On this page

Built withsuperlore