yaml-jazz

name	yaml-jazz
description	YAML is sheet music. The LLM is the jazz musician. Comments are soul.
license	MIT
tier	1
allowed-tools	["read_file","write_file"]
related	["moollm","postel","mind-mirror","needs","sniffable-python","empathic-templates","plain-text","k-lines","character","schema"]
tags	["moollm","yaml","comments","semantic","llm","interpretation","cop"]

YAML Jazz

"YAML is sheet music. The LLM is the jazz musician. Comments are soul."

---

What Is It?

YAML Jazz is also a schema plugin in the MOOLLM schemapedia: mechanism id yaml-jazz, family notation, profile skills/schema/schemas/mechanisms/yaml-jazz/MECHANISM.yml. It does not compete with JSON Schema—it layers authored meaning (comments, lenses) on the same YAML trees interchange validators care about.

YAML Jazz is how MOOLLM treats structured data: not as rigid schemas, but as semantic improvisation where:

"The source is the destination." — The Markdown/YAML principle

• Structure carries meaning — indentation, ordering, grouping
• Comments ARE data — they're guidance, context, soul
• The LLM interprets — filling gaps, resolving ambiguity, inferring intent
• Schemas are suggestions — starting points, not prisons

# This comment is NOT ignored!
# It tells the LLM: "be gentle with this section"
user_preferences:
  theme: dark    # they mentioned eye strain
  font_size: 16  # ← bump this if they complain again

---

Comment Oriented Programming (COP)

COP is programming in which comments are a first-class surface beside the parsed value tree: instance-specific code and data, constraints to preserve, transformations to apply when the tree changes, and procedural hooks—all traveling with the file. YAML Jazz is the MOOLLM convention that makes COP explicit for YAML sources. Interchange-only artifacts (e.g. JSON) have no COP channel; commentary cannot round-trip through them alone.

Schemapedia: skills/schema/schemas/mechanisms/yaml-jazz/MECHANISM.yml (comment_oriented_programming).

---

Core Principles

Comments Matter

# CRITICAL: Do not modify without user approval
api_key: ${SECRET}

# TODO: migrate to new format after v2 launch
legacy_format: true  # keeping for backwards compat

The LLM reads these. Acts on them. Comments are instructions.

In YAML Jazz, comments are instance-specific code and data: they travel with the file as cargo alongside the parsed tree. Treat them as a parallel channel for constraints, transformations to preserve when edits land, or procedural hooks—distinct from the value layer that JSON Schema validates.

Structure Is Semantic

# Priority by position (first = most important)
tasks:
  - Fix authentication bug     # P0
  - Update documentation       # P1  
  - Refactor old module        # P2

Order matters. Grouping matters. Proximity implies relationship.

Improvise Within Constraints

Given incomplete data:

user:
  name: Alice
  # preferences unknown

The LLM can improvise reasonable defaults while noting uncertainty:

user:
  name: Alice
  preferences:        # inferred from context
    theme: light      # default, unconfirmed
    notifications: on # assumed

---

From YAML standards to domain dialects

Baseline: YAML is defined by the YAML language spec (1.1 and 1.2 are both in the wild). Parsers agree on the tree; many drop comments when loading into objects. YAML Jazz treats the source file as authoritative for humans and LLMs: keep the text, preserve # lines, and prefer tooling that round-trips comments when machines must rewrite files.

Domain packs layer conventions on top of the spec:

Layer	Role in Jazz
Spec	Anchors, aliases, merges, tags, quoting rules — structure you must not break.
Tooling	Kubernetes, Compose, GitHub Actions, MOOLLM skills, etc. — keys and shapes are fixed by the product; Jazz is how you annotate inside that box.
Project	Naming, required keys, *.schema.yml hooks — document in comments why a value exists.

Variations between teams (quote style, folded scalars, explicit null) are Postel: accept liberally when reading; emit consistently when writing.

---

Comment forms: block lines and end-of-line

Both are first-class semantics, different span:

Form	Typical use
Full-line # (including consecutive “blocks” of # lines)	Rationale, narrative, warnings, history, worked examples, multi-sentence teaching.
End-of-line # after a value	Field-local gloss: units, caveats, intent, quick guardrails.

Machines that only see the parsed tree miss both; LLMs and humans reading the file do not. Use block-style runs when the comment is about a whole subtree; use EOL when the remark binds to one key.

---

Documentation by example

YAML Jazz enables documentation by example in the same spirit as programming by example: the instance is the curriculum. A single file can show:

• Valid shape and the story behind it (why these keys, what fails if removed).
• Counterexamples or “do not” lines in comments.
• Before/after or migration notes next to the field that changed.

The data stays executable or portable; the comments carry the lecture. That is not a substitute for external specs when you need normative schemas — pair with schema (schemapedia) when you need registered interchange or validation languages — but for MOOLLM and human–LLM work, the commented YAML is often the canonical explanation.

---

Parallel copies and documentation lenses

The same YAML structure (same keys and values) can appear in more than one file (or more than one tracked revision) where each copy carries a different comment set. Each copy optimizes for one lens:

• Validation and conversion — types, coercion, invariants, what breaks round-trip.
• Usage and metrics — latency, cost, SLOs, who calls what.
• History — when it changed, who decided, ticket or commit pointer.
• Intent — product goal, tradeoff, why not the obvious alternative.

No single comment block needs to carry every lens at once; doing so often creates noise and merge pain. Splitting by file or by branch of docs keeps each read path short. Conventions that work in practice:

• Sibling files: deploy.intent.yml / deploy.validation.yml (same tree, different comments) — sync values with tests or codegen if drift is risky.
• Section banners: a top-level # lens: metrics (or frontmatter in a wrapper doc) so readers know what was omitted on purpose.
• Git as differ: intent in main comments; history sometimes left to git blame unless audit requires inline provenance.

See examples/lens-intent.yml and examples/lens-validation.yml for a minimal pair.

---

The Jazz Metaphor

"Start with jazz, end with standards."

Jazz	YAML Jazz
Sheet music	Schema / template
Chord changes	Required fields
Improvisation	LLM interpretation
Soul	Comments
Ensemble	Multiple agents
Standards	Protocol conventions

Like John Coltrane playing "My Favorite Things" — the structure is there, but every performance is unique, responsive, alive.

The pun is deliberate: jazz standards are the classic songs every musician knows — and software standards are what you crystallize once patterns stabilize. Start improvising, end with reusable structures!

Character souls can sing their own favorite things in YAML Jazz!

And listen: "YAML" sounds like jazz scat! yaml aml ding dong! -- echoing The Edsels' doo-wop classic "Rama Lama Ding Dong" (1957). The name itself wants to be sung, improvised, riffed on. It's not an accident that this format became the soul carrier for LLM collaboration.

---

When to Use

• Configuration files — comments explain why, not just what
• State files — annotations track history and intent
• Data exchange — structured enough to parse, loose enough to extend
• Human-LLM collaboration — both can read and write it

---

Empirical Evidence: Entropy Collapse

The Discovery (April 2025)

Sunil Kumar (Groundlight AI, ex-Meta, Harvey Mudd) discovered that switching from JSON to YAML for tool calling massively improved model performance:

"Changing my model's tool calling interface from JSON to YAML had surprising side effects."

"Entropy collapse is one of the biggest issues with GRPO. Surprisingly, changing from JSON to YAML massively improved generation entropy stability, yielding much stronger performance."

"Forcing a small model to generate properly structured JSON massively constrains the model's ability to search and reason."

Why JSON Hurts LLMs

JSON Requirement	LLM Impact
Strict bracket matching {}[]	Reduces search space
Mandatory commas	Catastrophic forgetting during training
Quote escaping \"	Token overhead, error-prone
No comments allowed	Lost context between fields
Rigid syntax	Entropy collapse — model becomes brittle

Why YAML Helps LLMs

YAML Feature	LLM Benefit
Minimal syntax overhead	More tokens for reasoning
Indentation = structure	Natural for text models
Comments allowed	Context preserved
Flexible formatting	Entropy preserved
Human-readable	Training data overlap

Sunil's Simplified Schema

<tool>  
name: <tool name>  
arg1: value1  
arg2: value2  
</tool>

No spacing requirements. No bracket matching. Just semantic structure.

The Insight

"Anything to reduce syntax is a win!" — Sunil Kumar

This validates MOOLLM's approach: YAML Jazz isn't just aesthetic preference — it's computationally advantageous for LLMs.

---

The "Source is Destination" Principle

From Anil Dash's "How Markdown Took Over the World" (January 2025):

"The purpose of Markdown is really simple: It lets you use the regular characters on your keyboard... to make fancy formatting of text for the web."

YAML Jazz applies the same principle to data:

Format	Source	Destination	Gap
XML	.xml	Parsed DOM	Medium
JSON	.json	Parsed objects	Small
YAML Jazz	.yml	.yml (understood)	None

The YAML you write is the YAML the LLM reads. The comments are preserved. The structure carries meaning. No transformation gap.

Why This Matters

# Adele Goldberg (Smalltalk-80):
# "Documentation is not afterthought — it is CO-DESIGN.
#  The documentation IS part of the system."

room:
  name: Start           # Where the adventure begins
  atmosphere: welcoming  # Sets the tone for new players

These comments aren't stripped for parsing. They ARE the specification. The LLM reads them. Acts on them.

---

Anti-Patterns

❌ Rigid schema enforcement — "field X is required" without context
❌ Stripping comments — losing the soul
❌ Machine-only YAML — if humans can't read it, use JSON
❌ Over-specification — killing the jazz
❌ JSON for tool calls — entropy collapse, catastrophic forgetting ❌ Transformation gaps — compile steps that hide meaning

---

Dovetails With

Sister Skills

• schema/ — Schemapedia when you need normative interchange or validation layers alongside Jazz
• markdown/ — The prose format; YAML is the data format
• plain-text/ — The durability philosophy
• format-design/ — Why simple formats win
• postel/ — Be liberal in accepting ambiguous YAML
• soul-chat/ — Markdown with embedded YAML Jazz

Kernel

• kernel/constitution-core.md — Section 3: YAML Jazz Principle

---

Protocol Symbol

YAML-JAZZ

Invoke when: Interpreting YAML semantically, not just syntactically.

See: PROTOCOLS.yml