@really-knows-ai/foundry 3.5.6 → 3.5.7

package/dist/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [3.5.7] - 2026-05-23
+
+### Added
+
+- Artefact types can include an `example.md` alongside `definition.md`. When present, the forge skill treats its structure as normative — the forge agent follows the same format, preventing common formatting mistakes like unwanted title headings on haikus.
+
 ## [3.5.6] - 2026-05-23
 
 ### Fixed

package/dist/scripts/lib/config.js

@@ -22,12 +22,20 @@ export async function getCycleDefinition(foundryDir, cycleId, io) {
 }
 
 export async function getArtefactType(foundryDir, typeId, io) {
-  const path = join(foundryDir, 'artefacts', typeId, 'definition.md');
-  if (!(await io.exists(path))) {
+  const dir = join(foundryDir, 'artefacts', typeId);
+  const defPath = join(dir, 'definition.md');
+  if (!(await io.exists(defPath))) {
     throw new Error(`Artefact type not found: ${typeId}`);
   }
-  const text = await io.readFile(path);
-  return parseDoc(text);
+  const text = await io.readFile(defPath);
+  const result = parseDoc(text);
+
+  const examplePath = join(dir, 'example.md');
+  if (await io.exists(examplePath)) {
+    result.example = (await io.readFile(examplePath)).trim();
+  }
+
+  return result;
 }
 
 /**

package/dist/skills/forge/SKILL.md

@@ -40,7 +40,7 @@ Forge runs inside an enforced stage. Your **first** and **last** tool calls are
 
    Then return control to the user and stop.
 3. `foundry_config_cycle` — understand what to produce and what inputs are available.
-4. `foundry_config_artefact_type` with the output type ID — get the artefact type definition, especially its `file-patterns`.
+4. `foundry_config_artefact_type` with the output type ID — get the artefact type definition, `file-patterns`, and any example. When the response includes an `example` field, its structure is normative — your output must follow the same format (no extra headings, metadata blocks, or free-form prose that the example does not include).
 5. `foundry_config_laws` — get all applicable laws (global + type-specific).
 6. If the cycle declares `inputs`, discover input files by filesystem scan:
    - For each type listed in `inputs`, call `foundry_config_artefact_type` to get its `file-patterns`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@really-knows-ai/foundry",
-  "version": "3.5.6",
+  "version": "3.5.7",
   "description": "A skill-driven framework for governed artefact generation with AI coding tools. Define your own artefact types, laws, and flows — Foundry handles the forge → quench → appraise pipeline with deterministic routing, quality gates, and iterative refinement.",
   "type": "module",
   "main": "dist/.opencode/plugins/foundry.js",