@sabaiway/agent-workflow-engine 1.2.0 → 1.4.0

package/CHANGELOG.md

@@ -4,6 +4,50 @@ All notable changes to the methodology engine. Versions are this **package's** n
 they are distinct from the **deployment-lineage** stamp written into a project's `docs/ai/`
 (which tracks the shared `agent-workflow` lineage, head `1.3.0`).
 
+## 1.4.0 — Durable session contracts in the canon: read-at-start, Definition of Done, communication
+
+A **feature** release. The activity-procedures canon (`references/procedures.md`, read **live** by the
+composition root) gains three durable-session contracts, and the two bounded slot fragments gain the
+matching clauses so the composition root's canonical-refresh can push them to existing deployments:
+
+- **Read-at-start.** The canon tells the agent to read the project's standing recipe preference in
+  `docs/ai/orchestration.json` at the start of a planning/execution session (set it with the `set-recipe`
+  writer) — no re-asking what is already configured.
+- **plan-authoring Definition of Done.** A planning session must produce a self-contained plan **and** a
+  cold-start execution prompt for the next session — both **without the user asking**.
+- **Communication contract.** User-facing messages deliver the artifact **inline** (never a bare "see
+  §X" as a substitute), lead with the result, with a large-artifact carve-out.
+- **Slot fragments.** `orchestration-slot.md` gains the read-at-start clause (points at `set-recipe`);
+  `methodology-slot.md` gains the communication clause. Both stay one bounded content line, under the
+  deployed-`AGENTS.md` cap.
+
+Generic as ever — no project release-publishing bake-in. The deployment-lineage head stays **`1.3.0`**
+(stamp-independent reconciles reach the base; the engine **package** version is a separate axis).
+
+## 1.3.0 — Activity procedures: named, recipe-aware playbooks
+
+The engine now also owns the **activity-procedures** canon — *how to perform* a named workflow
+activity, as ordered steps with **typed recipe slots** that bind to the orchestration recipes (Solo /
+Reviewed / Council / Delegated). Two v1 activities: **`plan-authoring`** (slot: `review`) and
+**`plan-execution`** (slots: `execute`, `review`). The canon composes with `planning.md` (it binds to
+the §7 structure, §8 self-review, and §4 Cleanup without restating them) and stays **generic** — it
+bakes in no single project's stages, deferring any project-declared release/publishing to that
+project's `workflow:methodology` slot. The kit reads this canon **live** and surfaces a read-only
+`/agent-workflow-kit procedures <activity>` that renders the steps + the resolved effective recipe per
+slot (from `docs/ai/orchestration.json` + backend readiness).
+
+### Added
+- **`references/procedures.md`** — the canonical activity-procedures canon: `plan-authoring` +
+  `plan-execution` as `## <activity>` sections, each opening with a machine-parseable `Slots:` line
+  (the only line the kit parses, drift-guarded against its activity table). It carries the
+  load-bearing "Delegated → dispatch execution first" rule and restates the commit contract as a
+  commit-BOUNDARY rule (when an activity has a commit boundary the orchestrator owns that commit; a
+  backend never commits — `plan-authoring` ends at approval with no commit, `plan-execution` commits
+  per Step).
+
+The deployment-lineage head stays **`1.3.0`** (no `docs/ai` structural change; no migration file). The
+npm package version is a separate axis.
+
 ## 1.2.0 — Orchestration recipes: a named vocabulary for composing the bridges
 
 The engine now also owns the **orchestration-recipe** canon — the named patterns an agent uses to

package/README.md

@@ -50,12 +50,15 @@ the canonical methodology reference on disk:
 - [`references/orchestration-slot.md`](references/orchestration-slot.md) — the **bounded** one-line
   orchestration fragment the composition root injects into a deployed `AGENTS.md`, routing to the
   in-project recipes surface.
+- [`references/procedures.md`](references/procedures.md) — the canonical **activity-procedures** canon:
+  the named activities (`plan-authoring`, `plan-execution`) as ordered steps with typed recipe slots,
+  read live and rendered by the read-only `/agent-workflow-kit procedures <activity>`.
 
 ## What this package ships
 
-`SKILL.md` (the canon overview + ownership rule), `references/` (the full methodology + orchestration
-references + the two bounded slot fragments), `capability.json` (the family manifest), and this
-installer. It ships **no** family-wide tooling (the schema/validator/injection live in the
+`SKILL.md` (the canon overview + ownership rule), `references/` (the full methodology + the
+orchestration + activity-procedures references + the two bounded slot fragments), `capability.json`
+(the family manifest), and this installer. It ships **no** family-wide tooling (the schema/validator/injection live in the
 composition root) and mutates nothing — preserving "knows nobody".
 
 ## License

package/SKILL.md

@@ -1,9 +1,9 @@
 ---
 name: agent-workflow-engine
-description: Canonical home of the agent-workflow planning methodology — the Plan→Phase→Step→Substep vocabulary, plan lifecycle, queue.md series index, mandatory Cleanup phase, the bounded methodology slot fragment, and the orchestration-recipe vocabulary (Solo / Reviewed / Council / Delegated). A published, installable npm package (available:true) that *provides* the methodology text; it mutates nothing. The composition root (agent-workflow-kit) reads this canon LIVE from the installed engine and injects the bounded slots from it — one source of truth, no bundled mirror; `npx @sabaiway/agent-workflow-kit@latest init` installs the engine.
+description: Canonical home of the agent-workflow planning methodology — the Plan→Phase→Step→Substep vocabulary, plan lifecycle, queue.md series index, mandatory Cleanup phase, the bounded methodology slot fragment, the orchestration-recipe vocabulary (Solo / Reviewed / Council / Delegated), and the activity-procedures canon (plan-authoring / plan-execution, with typed recipe slots). A published, installable npm package (available:true) that *provides* the methodology text; it mutates nothing. The composition root (agent-workflow-kit) reads this canon LIVE from the installed engine and injects the bounded slots from it — one source of truth, no bundled mirror; `npx @sabaiway/agent-workflow-kit@latest init` installs the engine.
 disable-model-invocation: true
 metadata:
-  version: '1.2.0'
+  version: '1.4.0'
 ---
 
 # agent-workflow-engine
@@ -34,6 +34,11 @@ slot fill is needed but the engine is absent, the kit's reconcile **fails loudly
   orchestration fragment the composition root injects into a deployed `AGENTS.md`, between the
   `<!-- workflow:orchestration:start -->` / `<!-- workflow:orchestration:end -->` markers. It names the
   four recipes and routes to `/agent-workflow-kit recipes`, never to this engine-internal reference.
+- [`references/procedures.md`](references/procedures.md) — the canonical **activity-procedures** canon:
+  the ordered steps of the named activities (`plan-authoring`, `plan-execution`) with **typed recipe
+  slots** that bind to the orchestration recipes, composing with `planning.md` without restating it. It
+  stays generic (no project-specific stages baked in). The kit reads it live and renders the steps +
+  the resolved effective recipe per slot via the read-only `/agent-workflow-kit procedures <activity>`.
 
 ## Ownership rule (the engine knows nobody)
 

package/capability.json

@@ -3,7 +3,7 @@
   "schema": 1,
   "name": "agent-workflow-engine",
   "kind": "methodology-engine",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "available": true,
   "provides": ["plan"],
   "roles": {},

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sabaiway/agent-workflow-engine",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "Canonical home of the agent-workflow planning methodology — the Plan→Phase→Step vocabulary, plan lifecycle, queue.md series index, and mandatory Cleanup phase, consumed by the kit (composition root). The methodology engine of the agent-workflow family.",
   "keywords": [
     "ai-agents",

package/references/methodology-slot.md

@@ -1 +1 @@
-> **Workflow methodology** — plan → execute → review. Plans are ephemeral `docs/plans/*.md` (gitignored, **never committed**); every Plan ends with a mandatory **Phase: Cleanup**; series order lives in `docs/plans/queue.md`. Full vocabulary, lifecycle, and the plan-then-execute split live in the project's **planning skill** (it overrides the generic `writing-plans`); summary in `docs/ai/agent_rules.md` §5.
+> **Workflow methodology** — plan → execute → review. Plans are ephemeral `docs/plans/*.md` (gitignored, **never committed**); every Plan ends with a mandatory **Phase: Cleanup**; series order lives in `docs/plans/queue.md`. Full vocabulary, lifecycle, and the plan-then-execute split live in the project's **planning skill** (it overrides the generic `writing-plans`); summary in `docs/ai/agent_rules.md` §5. Named activities (plan-authoring, plan-execution) have procedures — see `/agent-workflow-kit procedures <activity>` for the steps + resolved recipe. **Communication:** user-facing messages deliver the artifact inline (paste the prompt / diff / command — never "see §X" as a substitute), lead with the result, show exactly what was asked, and never read as mockery (a large artifact: a real summary inline + a link).

package/references/orchestration-slot.md

@@ -1 +1 @@
-> **Orchestration recipes** — compose plan → execute → review with a named recipe: **Solo** (no backend), **Reviewed** (one backend reviews), **Council** (both review, you synthesize), **Delegated** (a backend executes a bounded sub-task); the orchestrator always commits, a backend is never autonomous. Pick + plan one for this environment with `/agent-workflow-kit recipes` (read-only); the deployed how/why lives in your `docs/ai/` workflow docs.
+> **Orchestration recipes** — compose plan → execute → review with a named recipe: **Solo** (no backend), **Reviewed** (one backend reviews), **Council** (both review, you synthesize), **Delegated** (a backend executes a bounded sub-task); the orchestrator always commits, a backend is never autonomous. Pick + plan one for this environment with `/agent-workflow-kit recipes` (read-only); the deployed how/why lives in your `docs/ai/` workflow docs. At the start of a planning/execution session, read your standing recipe preference in `docs/ai/orchestration.json` — set it in plain language with `/agent-workflow-kit set-recipe` (previews first; hand-edit stays supported).

package/references/procedures.md

@@ -0,0 +1,87 @@
+# Activity Procedures
+
+Canonical, on-demand reference for **how an orchestrating agent performs a named activity** — the
+ordered steps of a workflow activity with **typed recipe slots** that bind to the
+[orchestration recipes](orchestration.md) (Solo / Reviewed / Council / Delegated). This is the
+*how to perform* source of truth; it composes with — and never restates — the plan structure and
+lifecycle in [`planning.md`](planning.md). The composition root (`agent-workflow-kit`) reads this
+canon LIVE and renders the requested activity's steps + the resolved effective recipe per slot via
+the read-only `/agent-workflow-kit procedures <activity>`; it parses ONLY each section's `Slots:`
+line (drift-guarded against its activity table), never the steps.
+
+A **recipe slot** is a point in an activity where a recipe applies: `review` accepts
+`solo | reviewed | council`; `execute` accepts `solo | delegated`. The per-project default lives in
+`docs/ai/orchestration.json` and is resolved against backend readiness by the kit — never decided in
+this canon. Each activity section below begins with a machine-parseable `Slots:` line (the only line
+the kit parses) and then its ordered steps. Terse by design: it points at the canon it binds to, it
+does not restate it.
+
+The commit rule holds across every activity: **when an activity has a commit boundary, the
+orchestrator owns that commit; a backend is advisory or delegated, never autonomous, and never
+commits** (see [`orchestration.md`](orchestration.md) §6). Not every activity commits —
+`plan-authoring` ends at **approval** and produces **no** commit (plans are ephemeral, never
+committed); `plan-execution` commits **per Step**. Any project-declared release/publishing or extra
+stages are honored per the project's `workflow:methodology` slot — this generic canon bakes in no
+single project's stages.
+
+**Read your preference at session start.** At the start of a planning or execution session, read the
+project's standing recipe preference in `docs/ai/orchestration.json` (set it in plain language with
+`/agent-workflow-kit set-recipe` — it previews then writes; hand-editing the file stays supported); the
+kit resolves it against backend readiness. Do not re-ask each session what is already configured there.
+
+**Communication contract.** Every user-facing message delivers the artifact **inline** — the plan, the
+next-session prompt, the diff, the value asked for — never a bare pointer ("see §X / open the file") as a
+*substitute* for showing it; lead with the result, show exactly what was asked, and never read as
+mockery. For a genuinely large artifact, deliver a real summary or the key excerpt inline **and** link
+the file — never flood, never hide.
+
+---
+
+## plan-authoring
+
+Slots: review
+
+Produce a self-contained, cold-readable plan, reviewed to the configured depth before approval.
+
+1. **Research** — gather the exact files, contracts, and constraints the plan will touch.
+2. **Draft** — write the plan to the document structure defined in [`planning.md`](planning.md) §7,
+   with exact paths and commands per Step. Bind to that structure; do not restate it here.
+3. **Self-review** — run the [`planning.md`](planning.md) §8 checklist (exact paths/commands, strict
+   vocabulary, every out-of-plan recommendation folded into a Step, `queue.md` updated for a series).
+4. **review {recipe}** — review the draft at the depth the resolved `review` recipe selects: Solo
+   (self-review only), Reviewed (one backend reviews), or Council (both backends review, you
+   synthesize). The kit resolves the effective recipe from `docs/ai/orchestration.json` + readiness.
+5. **Fold + loop** — fold every finding back into the draft and re-review until the review is clean.
+6. **Present for approval** — surface the finished plan to the user; do not begin execution here.
+
+**Required output (Definition of Done):** a planning session produces a self-contained plan in
+`docs/plans/` **and** a cold-start execution prompt to begin the next session — **both produced without
+the user asking**. A planning session that ends without both is not done.
+
+The plan MUST end with the mandatory **Phase: Cleanup** ([`planning.md`](planning.md) §4) — a plan
+without it is not done.
+
+## plan-execution
+
+Slots: execute, review
+
+Execute an approved plan Step by Step; each Step is one logical commit.
+
+1. **Per Step, resolve the recipe** — the kit resolves `execute` and `review` for this run from
+   `docs/ai/orchestration.json` + readiness (a per-run `--override <slot>=<recipe>` is allowed).
+2. **If `execute` resolved to Delegated, dispatch execution FIRST** — hand the bounded sub-task to the
+   backend (codex-exec → a diff) *before* integrating; otherwise the orchestrator implements the Step
+   directly.
+3. **Implement / integrate** — apply the change (your own edits, or the reviewed delegated diff),
+   following the project's reuse + clean-code rules.
+4. **Self-review** — run the [`planning.md`](planning.md) §8 self-review on the change.
+5. **review {recipe}** — review the result at the resolved `review` depth (Solo / Reviewed / Council),
+   exactly as in plan-authoring.
+6. **Gates** — run the project's verification gate (tests + checks) to green before committing.
+7. **Commit boundary** — the orchestrator makes the single commit for the Step; a backend never
+   commits. The project's commit-approval policy (e.g. ask first) lives in the project's own rules.
+
+**Output:** each Step lands as one logical commit with its gates green; the orchestrator owns the commit.
+
+Honor any project-declared release/publishing or extra stages (per the `workflow:methodology` slot)
+before the plan's Cleanup — this generic canon does not enumerate them.