You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Updated README.md to reflect new pattern files and their purposes.
- Enhanced index.md with binding legends for applicable agents and updated skill file references.
- Revised completeness-traceability.md to correct the number of skill files in the index.
- Added decision rules and clarified usage in idea-to-prompt.md and spec-driven-development.md.
- Improved llm-behavior-guidelines.md by condensing anti-pattern examples and enhancing clarity.
- Updated memory-promotion-candidates.md to clarify provenance of the checklist.
- Streamlined repo-memory-hygiene.md for clarity and conciseness in the pre-write checklist.
- Adjusted security-review-discipline.md to specify provenance of the discipline.
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,7 @@ When status is `FAILED`, `NEEDS_INPUT`, `NEEDS_REVISION`, or `REJECTED`, include
26
26
-`fixable` — Small correctable issue (typo, missing import, config value); retry with fix hint.
27
27
-`needs_replan` — Architecture mismatch or missing dependency; delegate to Planner for targeted replan.
28
28
-`escalate` — Security vulnerability, data integrity risk, or unresolvable blocker; stop and await human approval.
29
+
-`model_unavailable` — the routed/primary model is unavailable or unreachable; substitute per model-routing fallback and retry up to `model_unavailable_max` (see runtime-policy.json), then escalate. Distinct from `transient`; the PlanAuditor/AssumptionVerifier `transient`-exclusion does NOT exclude `model_unavailable`.
29
30
30
31
## NOTES.md
31
32
Maintain/update `NOTES.md` for persistent state across context resets:
@@ -59,7 +60,7 @@ Agent engineering policies are in `docs/agent-engineering/`:
59
60
- Failure taxonomy applies to all agents; PlanAuditor and AssumptionVerifier exclude `transient`.
60
61
- P.A.R.T. section order in every agent file: **Prompt → Archive → Resources → Tools** (see `PART-SPEC.md`).
61
62
- Orchestrator and Planner must delegate only to project-internal agents documented in `plans/project-context.md`; external/third-party agents are strictly prohibited.
62
-
- Adding/editing agents or skills: follow the 4-step process in `CONTRIBUTING.md` (create agent file, schema, eval scenarios, register in `plans/project-context.md`).
63
+
- Adding/editing agents or skills: follow the agent-contribution process in `CONTRIBUTING.md` (create agent file, schema, eval scenarios, register in `plans/project-context.md`).
63
64
- Tool and agent permission grants are in `governance/` (`agent-grants.json`, `tool-grants.json`, `runtime-policy.json`, `rename-allowlist.json`). Update these when changing an agent's tool profile.
Copy file name to clipboardExpand all lines: CHANGELOG.md
+19-57Lines changed: 19 additions & 57 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,76 +11,38 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
11
11
### Added
12
12
13
13
-**Cursor IDE Support**: Added `.cursor/rules` to provide high-level guidance to the Cursor agent, along with documentation in `docs/agent-engineering/CURSOR-SUPPORT.md`.
14
-
15
-
---
16
-
17
-
## [Unreleased] — Claude Code Plugin (Phase 6)
18
-
19
-
### Added - Claude Code Plugin
20
-
21
14
-**Claude Code Plugin**: Shipped a first-class plugin adaptation for Anthropic's Claude Code at `plugins/controlflow-claude-code/`.
22
15
- Includes 10 ControlFlow workflow skills adapted for Claude native slash-invocation.
23
16
- Adds 6 native plugin agents for isolated review, research, mapping, and verification tasks.
24
17
- Ships local validation scripts and local development lifecycle documentation.
25
18
- Adds project-level references inside `README.md`, `CONTRIBUTING.md`, and quickstart docs.
-**Plugin First-Class Status**: Upgraded `controlflow-codex` to a first-class plugin deliverable in `AGENTS.md` and `README.md`.
40
-
41
-
---
42
-
43
-
## [Unreleased] — Model Routing Stage C Matrix
44
-
45
-
### Added - Model Routing
46
-
47
-
-`feat: add optional final review gate via final_review_gate policy flag` — Adds opt-in Completion Gate sub-step that dispatches CodeReviewer with review_scope=final for holistic scope-drift detection. Auto-triggers for LARGE tier plans. Configured via governance/runtime-policy.json.
48
-
-**Stage C Final (Consolidated)**: Model Routing Stage C has fully landed. Stage D is a forward pointer only.
21
+
-**Optional final review gate** via the `final_review_gate` policy flag — adds an opt-in Completion Gate sub-step that dispatches CodeReviewer with `review_scope=final` for holistic scope-drift detection. Auto-triggers for LARGE tier plans. Configured via `governance/runtime-policy.json`.
22
+
-**Model Routing Stage C Matrix (Consolidated)**: Model Routing Stage C has fully landed. Stage D is a forward pointer only.
49
23
- All 13 agents now declare `model_role:` frontmatter.
50
24
-`governance/model-routing.json` extended with optional `by_tier` matrix (10 roles × 4 complexity tiers with `inherit_from: "default"` for non-divergent cases).
- Structural gained +1 (Check #1 real implementation).
54
-
- Total eval suite: 358 → 370.
55
27
- VS Code runtime tolerance PASS recorded in `plans/artifacts/model-routing-stage-c/phase-1-spike-result.md`.
28
+
-**ControlFlow Comprehensive Revision** — ten-phase revision and modernization program delivered per `plans/controlflow-comprehensive-revision-plan.md`:
29
+
-**Phase 1 — Researcher validation + `plans_classification`.** Evidence-first confirmation of all 10 audit findings and per-plan classification artifact gating downstream archival decisions.
30
+
-**Phase 2 — CodeMapper drift inventory.** Mechanical cross-reference of agent model pins, tool grants, schema references, skill registrations, executor-enum alignment, and PreFlect baseline line counts.
31
+
-**Phase 3 — Consistency fixes (relabel-only; archival gated).** Phase Executor Agents table reduced to 8 rows matching the `executor_agent` enum; three-way check-count reconciliation; in-place status relabels without destructive moves.
32
+
-**Phase 4 — Model Routing (logical-index-only; spike deferred).** Published `governance/model-routing.json` with 10 logical roles covering all 13 agents and `docs/agent-engineering/MODEL-ROUTING.md`. Runtime opt-in via agent frontmatter `model_role:` is held pending VS Code frontmatter-tolerance verification; drift Check #1 remains gated off.
33
+
-**Phase 5 — Observability & `trace_id` schema hardening.** UUIDv4 `trace_id` added as additive-optional field across 13 report / verdict / audit / discovery / research / clarification / plan schemas; `docs/agent-engineering/OBSERVABILITY.md` documents generation, propagation, and the NDJSON sink convention at `plans/artifacts/observability/<task-id>.ndjson`.
34
+
-**Phase 6 — Agentic Memory layering.** Three-layer memory model (session / task-episodic / repo-persistent) codified in `docs/agent-engineering/MEMORY-ARCHITECTURE.md`; `NOTES.md` scoped to repo-persistent state with reversible migration manifest.
35
+
-**Phase 7 — PreFlect canonicalization.** Single `skills/patterns/preflect-core.md` replaces per-agent PreFlect restatements with pointer + ≤5 domain lines; Orchestrator-enforced cross-plan entry gate against `plans/performance-optimization-plan.md`.
36
+
-**Phase 8 — SOTA pattern integration (additive, no budget compounding).**`skills/patterns/reflection-loop.md` (pre-retry hook; default disabled; draws from existing `retry_budgets`), `skills/patterns/budget-tracking.md` (`budget_defaults` orthogonal to `retry_budgets`), and `docs/agent-engineering/AGENT-AS-TOOL.md` (MCP forward-compatible input contract).
37
+
-**Phase 9 — Additive drift-detection evals.** Four new drift checks (roster ↔ enum bidirectional alignment, agent `Resources` ↔ schemas existence, cross-plan file-overlap with anchor-map gate, multi-doc check-count consistency) in `evals/tests/drift-detection.test.mjs`; `model_role` resolution check staged but gated off until Phase 4 spike re-enables it.
38
+
-**Phase 10 — README & engineering-docs refresh.** Measured-value badges, new Feature rows for the six shipped capabilities, and `docs/agent-engineering/README.md` index for the 14 engineering documents.
39
+
40
+
### Changed
56
41
57
-
### Changed - Model Routing
58
-
59
-
-**Eval suite (410 checks)** — 227 structural + 78 behavior + 63 orchestration-handoff + 42 drift-detection. Advertised counts in `README.md`, `.github/copilot-instructions.md`, `CONTRIBUTING.md`, `evals/README.md`, `SECURITY.md`, and `.github/PULL_REQUEST_TEMPLATE.md` reconciled to the measured value and enforced by drift Check #5.
Ten-phase revision and modernization program delivered per `plans/controlflow-comprehensive-revision-plan.md`.
66
-
67
-
### Added - Comprehensive Revision
68
-
69
-
-**Phase 1 — Researcher validation + `plans_classification`.** Evidence-first confirmation of all 10 audit findings and per-plan classification artifact gating downstream archival decisions.
70
-
-**Phase 2 — CodeMapper drift inventory.** Mechanical cross-reference of agent model pins, tool grants, schema references, skill registrations, executor-enum alignment, and PreFlect baseline line counts.
71
-
-**Phase 3 — Consistency fixes (relabel-only; archival gated).** Phase Executor Agents table reduced to 8 rows matching the `executor_agent` enum; three-way check-count reconciliation; in-place status relabels without destructive moves.
72
-
-**Phase 4 — Model Routing (logical-index-only; spike deferred).** Published `governance/model-routing.json` with 10 logical roles covering all 13 agents and `docs/agent-engineering/MODEL-ROUTING.md`. Runtime opt-in via agent frontmatter `model_role:` is held pending VS Code frontmatter-tolerance verification; drift Check #1 remains gated off.
73
-
-**Phase 5 — Observability & `trace_id` schema hardening.** UUIDv4 `trace_id` added as additive-optional field across 13 report / verdict / audit / discovery / research / clarification / plan schemas; `docs/agent-engineering/OBSERVABILITY.md` documents generation, propagation, and the NDJSON sink convention at `plans/artifacts/observability/<task-id>.ndjson`.
74
-
-**Phase 6 — Agentic Memory layering.** Three-layer memory model (session / task-episodic / repo-persistent) codified in `docs/agent-engineering/MEMORY-ARCHITECTURE.md`; `NOTES.md` scoped to repo-persistent state with reversible migration manifest.
75
-
-**Phase 7 — PreFlect canonicalization.** Single `skills/patterns/preflect-core.md` replaces per-agent PreFlect restatements with pointer + ≤5 domain lines; Orchestrator-enforced cross-plan entry gate against `plans/performance-optimization-plan.md`.
76
-
-**Phase 8 — SOTA pattern integration (additive, no budget compounding).**`skills/patterns/reflection-loop.md` (pre-retry hook; default disabled; draws from existing `retry_budgets`), `skills/patterns/budget-tracking.md` (`budget_defaults` orthogonal to `retry_budgets`), and `docs/agent-engineering/AGENT-AS-TOOL.md` (MCP forward-compatible input contract).
77
-
-**Phase 9 — Additive drift-detection evals.** Four new drift checks (roster ↔ enum bidirectional alignment, agent `Resources` ↔ schemas existence, cross-plan file-overlap with anchor-map gate, multi-doc check-count consistency) in `evals/tests/drift-detection.test.mjs`; `model_role` resolution check staged but gated off until Phase 4 spike re-enables it.
78
-
-**Phase 10 — README & engineering-docs refresh.** Measured-value badges, new Feature rows for the six shipped capabilities, and `docs/agent-engineering/README.md` index for the 11 engineering documents.
79
-
80
-
### Changed - Comprehensive Revision
81
-
82
-
-**Eval suite (358 checks)** — 212 structural + 74 behavior + 49 orchestration-handoff + 23 drift-detection. Advertised counts in `README.md`, `.github/copilot-instructions.md`, `CONTRIBUTING.md`, `evals/README.md`, `SECURITY.md`, and `.github/PULL_REQUEST_TEMPLATE.md` reconciled to the measured value and enforced by drift Check #5.
83
-
- Phase Executor Agents table reduced to 8 rows aligned with the `executor_agent` enum; AssumptionVerifier and ExecutabilityVerifier reclassified as review-only roles outside the executor enum.
-**Plugin First-Class Status**: Upgraded `controlflow-codex` to a first-class plugin deliverable in `AGENTS.md` and `README.md`.
44
+
-**Eval suite count reconciliation** — Advertised eval counts in `README.md`, `.github/copilot-instructions.md`, `CONTRIBUTING.md`, `evals/README.md`, `SECURITY.md`, and `.github/PULL_REQUEST_TEMPLATE.md` were reconciled to the measured value. There is no live count-enforcement pass; the current total is reported by `cd evals && npm test`.
45
+
-**Phase Executor Agents table** reduced to 8 rows aligned with the `executor_agent` enum; AssumptionVerifier and ExecutabilityVerifier reclassified as review-only roles outside the executor enum.
- Tool routing compliance if the agent uses external tools
62
64
63
-
5.**Register the agent in governance files**:
64
-
- Add it to `governance/agent-grants.json` with its canonical tool grants.
65
+
5.**Register the agent in governance files** (see AGENTS.md §4 editing checklist):
66
+
- Add it to `governance/agent-grants.json` with its canonical agent/tool grants.
67
+
- Add it to `governance/tool-grants.json` when the agent's tool surface changes — the eval suite enforces consistency.
68
+
- Update `governance/runtime-policy.json` and `governance/rename-allowlist.json` where relevant (e.g. review routing/retry knobs or rename permissions).
65
69
- Add it to `plans/project-context.md` (agent roster table).
66
70
67
71
6.**Update `README.md`**:
@@ -93,6 +97,24 @@ For project-wide orchestration audits, prefer `skills/patterns/orchestration-aud
93
97
94
98
---
95
99
100
+
## Adding or modifying eval scenarios and validator passes
101
+
102
+
The eval suite is the only verification gate (`cd evals && npm test`).
103
+
104
+
1. Scenario fixtures live in `evals/scenarios/`; add or edit the fixture that exercises the behavior, validated against the matching schema in `schemas/`.
105
+
2. Validator passes live in `evals/validate.mjs` (structural/schema/P.A.R.T) and drift checks in `evals/drift-checks.mjs`. Add a pass only when an existing one cannot express the contract; keep new passes offline and network-free.
106
+
3. Run `cd evals && npm test` (or the faster `test:structural` / `test:behavior`) and confirm green before opening a PR. See `evals/README.md` for pass descriptions.
1. Most knobs in `governance/` are referenced by Orchestrator/Planner prompt text — re-read the consumers and update the prompt wording when knob semantics change (per AGENTS.md §4).
113
+
2. Keep grants consistent: `governance/agent-grants.json` and `governance/tool-grants.json` are enforced against agent frontmatter by the eval suite.
114
+
3. Run `cd evals && npm test` after any governance edit to catch drift — changes here affect all agents.
115
+
116
+
---
117
+
96
118
## Contributing to Plugins (Codex and Claude Code)
97
119
98
120
Changes to files under `plugins/controlflow-codex/` and `plugins/controlflow-claude-code/` require their own validation in addition to the repository eval suite:
Copy file name to clipboardExpand all lines: NOTES.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,6 @@
2
2
3
3
Repo-persistent active-objective state only. See `docs/agent-engineering/MEMORY-ARCHITECTURE.md` for the three-layer memory model; task-episodic history lives under `plans/artifacts/<task-slug>/`.
4
4
5
-
- Active objective: capability-matrix registry follow-up cleanup is complete; runtime uses registry metadata and strict file-level anchor-map coverage.
5
+
- Active objective: comprehensive cleanup effort is complete; full eval gate (`cd evals && npm test`) is green.
6
6
- Blockers: none.
7
7
- Pending: optional follow-up to investigate pre-existing capability-matrix live-tree drift flags surfaced by the smoke test.
0 commit comments