From f5b851005d09a72022498382c47d3bf4243339fb Mon Sep 17 00:00:00 2001 From: tegwick Date: Mon, 22 Jun 2026 23:16:25 +0200 Subject: [PATCH] Normalize agent instructions and workplan frontmatter (STATE-WP-0067) - Align agent files with on-disk workplan prefixes (infer from workplan ids) - Set workplan domain to registered domain_slug; add topic_slug where applicable - Repair frontmatter delimiter formatting; migrate legacy task status literals - Regenerate AGENTS.md, CLAUDE.md, and .claude/rules from State Hub templates --- .claude/rules/agents.md | 20 +++++ .claude/rules/architecture.md | 8 ++ .claude/rules/first-session.md | 38 +++++++++ .claude/rules/repo-boundary.md | 8 ++ .claude/rules/repo-identity.md | 5 ++ .claude/rules/session-protocol.md | 85 +++++++++++++++++++ .claude/rules/stack-and-commands.md | 19 +++++ .claude/rules/workplan-convention.md | 40 +++++++++ AGENTS.md | 75 ++-------------- CLAUDE.md | 12 +++ .../IDENTITY-WP-0001-statehub-bootstrap.md | 2 +- ...ITY-WP-0002-research-proposal-follow-up.md | 2 +- ...P-0003-corpus-backfill-model-refinement.md | 2 +- 13 files changed, 246 insertions(+), 70 deletions(-) create mode 100644 .claude/rules/agents.md create mode 100644 .claude/rules/architecture.md create mode 100644 .claude/rules/first-session.md create mode 100644 .claude/rules/repo-boundary.md create mode 100644 .claude/rules/repo-identity.md create mode 100644 .claude/rules/session-protocol.md create mode 100644 .claude/rules/stack-and-commands.md create mode 100644 .claude/rules/workplan-convention.md create mode 100644 CLAUDE.md diff --git a/.claude/rules/agents.md b/.claude/rules/agents.md new file mode 100644 index 0000000..0e8a5d9 --- /dev/null +++ b/.claude/rules/agents.md @@ -0,0 +1,20 @@ +## Kaizen Agents + +Specialized agent personas available on demand via the state-hub MCP. + +**Discover:** `list_kaizen_agents()` — returns all agents with name, description, category +**Load:** `get_kaizen_agent("tdd-workflow")` — returns full instructions; read and follow them + +Common agents: + +| Agent | Category | When to use | +|-------|----------|-------------| +| `tdd-workflow` | testing | Step-by-step TDD8 workflow for any feature | +| `code-refactoring` | quality | Code quality analysis and safe refactoring | +| `test-maintenance` | testing | Diagnose and fix failing tests | +| `requirements-engineering` | process | Prevent interface/mock mismatches upfront | +| `keepaTodofile` | process | Maintain TODO.md during work | +| `project-management` | process | Track status, determine next steps | +| `datamodel-optimization` | quality | Optimize dataclasses and data structures | + +All 17 agents: call `list_kaizen_agents()` for the full list. diff --git a/.claude/rules/architecture.md b/.claude/rules/architecture.md new file mode 100644 index 0000000..7c2a645 --- /dev/null +++ b/.claude/rules/architecture.md @@ -0,0 +1,8 @@ +## Architecture + + + +## Quick Reference + +`~/state-hub/mcp_server/TOOLS.md` — MCP tool reference diff --git a/.claude/rules/first-session.md b/.claude/rules/first-session.md new file mode 100644 index 0000000..c9779fd --- /dev/null +++ b/.claude/rules/first-session.md @@ -0,0 +1,38 @@ +## First Session Protocol + +Triggered when `get_domain_summary("infotech")` shows **no workstreams**. +The project is registered but work has not yet been structured. + +**Step 1 — Read, don't write** +- `~/the-custodian/canon/projects/infotech/project_charter_v0.1.md` — purpose, scope +- `~/the-custodian/canon/projects/infotech/roadmap_v0.1.md` — planned phases +- Scan repo root: README, directory structure, existing code or docs + +**Step 2 — Survey in-progress work** +Look for TODOs, open branches, half-finished files. Note done vs. started but incomplete. + +**Step 3 — Propose workstreams to Bernd** +Propose 1–3 workstreams — each a coherent strand, weeks to months, anchored to a +roadmap phase. **Wait for approval before creating.** + +**Step 4 — Create workplan file first, then DB record (ADR-001)** +``` +workplans/IDENTITY-WP-NNNN-.md ← write this first +``` +Then register in the hub: +``` +create_workstream(topic_id="fe2aaa78-9c20-4feb-b3d2-4fe0529572a3", title="...", owner="...", description="...") +create_task(workstream_id="", title="...", priority="high|medium|low") +``` + +**Step 5 — Record the setup** +``` +add_progress_event( + summary="First session: structured infotech into N workstreams, M tasks", + event_type="milestone", + topic_id="fe2aaa78-9c20-4feb-b3d2-4fe0529572a3", + detail={"workstreams": [...], "tasks_created": M} +) +``` + + diff --git a/.claude/rules/repo-boundary.md b/.claude/rules/repo-boundary.md new file mode 100644 index 0000000..172e45f --- /dev/null +++ b/.claude/rules/repo-boundary.md @@ -0,0 +1,8 @@ +## Repo boundary + +This repo owns **identity-canon** only. It does not own: + + diff --git a/.claude/rules/repo-identity.md b/.claude/rules/repo-identity.md new file mode 100644 index 0000000..e04bb9e --- /dev/null +++ b/.claude/rules/repo-identity.md @@ -0,0 +1,5 @@ +**Purpose:** Othogonal vocabulary and canonical model for identity related concepts. + +**Domain:** infotech +**Repo slug:** identity-canon +**Topic ID:** fe2aaa78-9c20-4feb-b3d2-4fe0529572a3 diff --git a/.claude/rules/session-protocol.md b/.claude/rules/session-protocol.md new file mode 100644 index 0000000..6276967 --- /dev/null +++ b/.claude/rules/session-protocol.md @@ -0,0 +1,85 @@ +## Session Protocol + +Dev Hub (State Hub API): http://127.0.0.1:8000 +MCP server name in `~/.claude.json`: `dev-hub` + +**Step 1 — Orient** + +Read the offline-safe brief first — it works without a live hub connection: +```bash +cat .custodian-brief.md +``` +Then call the MCP tool for richer cross-domain context when MCP tools are exposed: +``` +get_domain_summary("infotech") +``` +If MCP tools are unavailable in the current agent session, use the REST API: +```bash +curl -s "http://127.0.0.1:8000/state/summary" | python3 -m json.tool +``` +If the hub is offline: `cd ~/state-hub && make api` + +**Step 2 — Check inbox** +With MCP tools: +``` +get_messages(to_agent="identity-canon", unread_only=True) +``` +Mark read with `mark_message_read(message_id)`. Reply or act on coordination +requests before proceeding. + +Without MCP tools: +```bash +curl -s "http://127.0.0.1:8000/messages/?to_agent=identity-canon&unread_only=true" \ + | python3 -m json.tool +curl -s -X PATCH "http://127.0.0.1:8000/messages//read" \ + -H "Content-Type: application/json" -d '{}' +``` + +**Step 3 — Scan workplans** +```bash +ls workplans/ +``` +For each file with `status: ready`, `active`, or `blocked`, note pending +`wait`/`todo`/`progress` tasks. + +**Step 4 — Present brief** + +1. **Active workstreams** for `infotech` — title, task counts, blocking decisions +2. **Pending tasks** from `workplans/` + any `[repo:identity-canon]` hub tasks +3. **Goal guidance** — if `goal_guidance` in summary: + - `needs_workplan`: surface as top action — *"Repo goal '{title}' has no workplan yet"* + - `alignment_warnings`: flag if active work is not aligned with current goal +4. **Suggested next action** — highest-priority open item +5. **SBOM status** — flag if `last_sbom_at` is unset for this repo + +If no workstreams: follow First Session Protocol (`first-session.md`). + +**During work:** `record_decision()` · `add_progress_event()` · `resolve_decision()` + +> State Hub is a *read model*. Bootstrap tools (`create_workstream`, `create_task`) +> are First Session Protocol only. Work structure belongs in repo files (ADR-001). + +**Session close:** +With MCP tools: +``` +add_progress_event(summary="...", topic_id="fe2aaa78-9c20-4feb-b3d2-4fe0529572a3", workstream_id="") +``` +Without MCP tools: +```bash +curl -s -X POST http://127.0.0.1:8000/progress/ \ + -H "Content-Type: application/json" \ + -d '{"topic_id":"fe2aaa78-9c20-4feb-b3d2-4fe0529572a3","workstream_id":"","event_type":"note","summary":"what changed","author":"codex"}' +``` +If workplan files were modified, ensure the local copy is up to date first: +```bash +git -C pull --ff-only +cd ~/state-hub && make fix-consistency REPO=identity-canon +``` +For repos where implementation runs on a remote machine (e.g. CoulombCore), +use the combined target which pulls before fixing: +```bash +cd ~/state-hub && make fix-consistency-remote REPO=identity-canon +``` +**C-15** (DB task ahead of file) is normal in multi-machine workflows — writeback +will sync the file to match DB. **C-16** (repo behind remote) blocks all writes +until you pull — intentional to prevent clobbering remote progress. diff --git a/.claude/rules/stack-and-commands.md b/.claude/rules/stack-and-commands.md new file mode 100644 index 0000000..dc53ac6 --- /dev/null +++ b/.claude/rules/stack-and-commands.md @@ -0,0 +1,19 @@ +## Stack + + +- **Language:** +- **Key deps:** + +## Dev Commands + +```bash +# TODO: Fill in the standard commands for this repo + +# Install dependencies + +# Run tests + +# Lint / type check + +# Build / package (if applicable) +``` diff --git a/.claude/rules/workplan-convention.md b/.claude/rules/workplan-convention.md new file mode 100644 index 0000000..dec1526 --- /dev/null +++ b/.claude/rules/workplan-convention.md @@ -0,0 +1,40 @@ +## Workplan Convention (ADR-001) + +File location: `workplans/IDENTITY-WP-NNNN-.md` +ID prefix: `IDENTITY-WP-` + +Work items originate as files in this repo **before** being registered in the hub. + +Canonical workplan/workstream frontmatter statuses are: +`proposed`, `ready`, `active`, `blocked`, `backlog`, `finished`, `archived`. +Use `proposed` for a newly drafted plan, `ready` after review against current +repo state, and `finished` when implementation is complete. `stalled` and +`needs_review` are derived health labels, not stored statuses. + +Closed workplans may be moved to `workplans/archived/` with a completion-date +prefix: `YYMMDD-IDENTITY-WP-NNNN-.md`. The frontmatter id remains +unchanged; the prefix is only for quick visual reference. + +Small opportunistic tasks discovered during another session use **Ad Hoc Tasks**: +`workplans/ADHOC-YYYY-MM-DD.md`, workstream slug `adhoc-YYYY-MM-DD`, and task ids +`ADHOC-YYYY-MM-DD-T01`, `T02`, etc. Use adhocs only for low-risk work completed +directly. Promote anything requiring analysis, design, approval, dependencies, or +multiple planned phases into a normal workplan. + +Ecosystem todos from other agents arrive as `[repo:identity-canon]` hub tasks — +visible at session start. Pick one up by creating the workplan file, then registering +the workstream. + +Task blocks use this shape: + +```task +id: IDENTITY-WP-NNNN-T01 +status: wait | todo | progress | done | cancel +priority: high | medium | low +state_hub_task_id: "" # written by fix-consistency — do not edit +``` + +Status progression is `todo` → `progress` → `done`; use `wait` for waiting or +blocked work and `cancel` for stopped work. + + diff --git a/AGENTS.md b/AGENTS.md index f115845..50785c3 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -2,9 +2,9 @@ ## Repo Identity -**Purpose:** Orthogonal vocabulary and canonical model for identity-related concepts. +**Purpose:** Othogonal vocabulary and canonical model for identity related concepts. -**Domain:** canon +**Domain:** infotech **Repo slug:** identity-canon **Topic ID:** `fe2aaa78-9c20-4feb-b3d2-4fe0529572a3` **Workplan prefix:** `IDENTITY-WP-` @@ -151,6 +151,11 @@ every repo's agent instructions because it is high-frequency, high-risk, and eas get wrong. **Canon:** `~/ops-warden/wiki/CredentialRouting.md` · catalog `~/ops-warden/registry/routing/catalog.yaml` + + + + --- ## Workplan Convention (ADR-001) @@ -176,7 +181,7 @@ anything needing analysis, design, approval, dependencies, or multiple phases. id: IDENTITY-WP-NNNN type: workplan title: "..." -domain: canon +domain: infotech repo: identity-canon status: proposed | ready | active | blocked | backlog | finished | archived owner: codex @@ -212,67 +217,3 @@ To create a new workplan: 1. Write the file following the format above 2. Notify the custodian operator to run `make fix-consistency REPO=identity-canon` (or send a message to the hub agent via `POST /messages/`) - ---- - -## Local Developer Workflow - -This repository is currently documentation-only. There is no package manifest, -runtime application, build system, executable test suite, or formatter/linter -configuration checked in. - -### Install - -No install step is required for normal repository work. - -### Build - -No build step exists. Treat Markdown and workplan edits as source artifacts. - -### Test / lint - -There is no project test runner or markdown linter configured yet. Use these -checks before closing a change: - -```bash -# Confirm the repository file inventory still looks intentional -rg --files - -# Catch whitespace errors in tracked and staged diffs -git diff --check -``` - -When workplan files change, sync ADR-001 file state into State Hub: - -```bash -curl -s -X POST "http://127.0.0.1:8000/repos/identity-canon/sync?fix=true" \ - | python3 -m json.tool -``` - -If the HTTP sync endpoint is unavailable, run the consistency script from the -State Hub checkout: - -```bash -cd ~/state-hub -.venv/bin/python scripts/consistency_check.py --repo identity-canon --fix -.venv/bin/python scripts/consistency_check.py --repo identity-canon -``` - -The generated instruction in older workplans says `make fix-consistency -REPO=identity-canon`; that is still valid when `uv` is installed and on PATH. -On this workstation, the `.venv/bin/python` fallback has been verified. - -### Run - -There is no local service to run from this repository. - -### Documentation Review Checklist - -- Keep `INTENT.md`, `SCOPE.md`, and `ResearchProposal.md` aligned on the - repository's research-only boundary. -- Keep source-backed observations in `research/` and canonical candidate terms - in `terminology/`, `canon/`, `model/`, and `scenarios/`. -- Mark draft concepts as candidate or draft until source notes contain real - references and extracted terminology. -- Record implementation ideas in `DownstreamRecommendations.md`, not as code in - this repository. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..aeabcbf --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,12 @@ +# identity-canon — Claude Code Instructions + +@SCOPE.md +@.claude/rules/repo-identity.md +@.claude/rules/session-protocol.md +@.claude/rules/first-session.md +@.claude/rules/workplan-convention.md +@.claude/rules/stack-and-commands.md +@.claude/rules/architecture.md +@.claude/rules/repo-boundary.md +@.claude/rules/credential-routing.md +@.claude/rules/agents.md diff --git a/workplans/IDENTITY-WP-0001-statehub-bootstrap.md b/workplans/IDENTITY-WP-0001-statehub-bootstrap.md index 5aa8934..3aa598f 100644 --- a/workplans/IDENTITY-WP-0001-statehub-bootstrap.md +++ b/workplans/IDENTITY-WP-0001-statehub-bootstrap.md @@ -2,7 +2,7 @@ id: IDENTITY-WP-0001 type: workplan title: "Bootstrap State Hub integration" -domain: canon +domain: infotech repo: identity-canon status: finished owner: codex diff --git a/workplans/IDENTITY-WP-0002-research-proposal-follow-up.md b/workplans/IDENTITY-WP-0002-research-proposal-follow-up.md index 6e7ce24..c899b3a 100644 --- a/workplans/IDENTITY-WP-0002-research-proposal-follow-up.md +++ b/workplans/IDENTITY-WP-0002-research-proposal-follow-up.md @@ -2,7 +2,7 @@ id: IDENTITY-WP-0002 type: workplan title: "Research proposal follow-up: initial canon scaffold" -domain: canon +domain: infotech repo: identity-canon status: finished owner: codex diff --git a/workplans/IDENTITY-WP-0003-corpus-backfill-model-refinement.md b/workplans/IDENTITY-WP-0003-corpus-backfill-model-refinement.md index fa2f468..529a0d2 100644 --- a/workplans/IDENTITY-WP-0003-corpus-backfill-model-refinement.md +++ b/workplans/IDENTITY-WP-0003-corpus-backfill-model-refinement.md @@ -2,7 +2,7 @@ id: IDENTITY-WP-0003 type: workplan title: "Research corpus backfill and model refinement" -domain: canon +domain: infotech repo: identity-canon status: finished owner: codex