From bcda9ad1d72a2715a8b847fcfd399d0cc342b545 Mon Sep 17 00:00:00 2001 From: tegwick Date: Mon, 18 May 2026 16:55:40 +0200 Subject: [PATCH] Refresh agent instruction files --- .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 | 84 ++++++++++++++++++++++++++++ .claude/rules/stack-and-commands.md | 19 +++++++ .claude/rules/workplan-convention.md | 28 ++++++++++ AGENTS.md | 65 +++++---------------- CLAUDE.md | 11 ++++ 10 files changed, 235 insertions(+), 51 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..b9c34d6 --- /dev/null +++ b/.claude/rules/first-session.md @@ -0,0 +1,38 @@ +## First Session Protocol + +Triggered when `get_domain_summary("stack")` shows **no workstreams**. +The project is registered but work has not yet been structured. + +**Step 1 — Read, don't write** +- `~/the-custodian/canon/projects/stack/project_charter_v0.1.md` — purpose, scope +- `~/the-custodian/canon/projects/stack/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/artifact-store-WP-NNNN-.md ← write this first +``` +Then register in the hub: +``` +create_workstream(topic_id="595afc64-bd28-47bf-aafb-ba230b28371b", title="...", owner="...", description="...") +create_task(workstream_id="", title="...", priority="high|medium|low") +``` + +**Step 5 — Record the setup** +``` +add_progress_event( + summary="First session: structured stack into N workstreams, M tasks", + event_type="milestone", + topic_id="595afc64-bd28-47bf-aafb-ba230b28371b", + 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..a0e67e0 --- /dev/null +++ b/.claude/rules/repo-boundary.md @@ -0,0 +1,8 @@ +## Repo boundary + +This repo owns **artifact-store** 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..1d00fdd --- /dev/null +++ b/.claude/rules/repo-identity.md @@ -0,0 +1,5 @@ +**Purpose:** Generic artifact registry and storage gateway for generated outputs, evidence packages, reports, logs, snapshots, exports, and release artifacts. + +**Domain:** stack +**Repo slug:** artifact-store +**Topic ID:** 595afc64-bd28-47bf-aafb-ba230b28371b diff --git a/.claude/rules/session-protocol.md b/.claude/rules/session-protocol.md new file mode 100644 index 0000000..735f789 --- /dev/null +++ b/.claude/rules/session-protocol.md @@ -0,0 +1,84 @@ +## Session Protocol + +State Hub: http://127.0.0.1:8000 + +**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("stack") +``` +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="artifact-store", 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=artifact-store&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 +`todo`/`in_progress` tasks. + +**Step 4 — Present brief** + +1. **Active workstreams** for `stack` — title, task counts, blocking decisions +2. **Pending tasks** from `workplans/` + any `[repo:artifact-store]` 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="595afc64-bd28-47bf-aafb-ba230b28371b", 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":"595afc64-bd28-47bf-aafb-ba230b28371b","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=artifact-store +``` +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=artifact-store +``` +**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..a279912 --- /dev/null +++ b/.claude/rules/workplan-convention.md @@ -0,0 +1,28 @@ +## Workplan Convention (ADR-001) + +File location: `workplans/artifact-store-WP-NNNN-.md` +ID prefix: `ARTIFACT-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-artifact-store-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:artifact-store]` hub tasks — +visible at session start. Pick one up by creating the workplan file, then registering +the workstream. + + diff --git a/AGENTS.md b/AGENTS.md index d1310ba..c7bfce3 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -2,13 +2,12 @@ ## Repo Identity -**Purpose:** Generic artifact registry and storage gateway for generated outputs, -evidence packages, reports, logs, snapshots, exports, and release artifacts. +**Purpose:** Generic artifact registry and storage gateway for generated outputs, evidence packages, reports, logs, snapshots, exports, and release artifacts. **Domain:** stack **Repo slug:** artifact-store **Topic ID:** `595afc64-bd28-47bf-aafb-ba230b28371b` -**Workplan prefix:** `ARTIFACT-STORE-WP-` +**Workplan prefix:** `ARTIFACT-WP-` --- @@ -83,7 +82,7 @@ curl -s -X PATCH "http://127.0.0.1:8000/tasks/" \ **Start:** 1. `cat .custodian-brief.md` — domain goal and open workstreams (offline-safe) 2. Check inbox: `GET /messages/?to_agent=artifact-store&unread_only=true`; mark read -3. Scan workplans: `ls workplans/` — note `status: active` files and open tasks +3. Scan workplans: `ls workplans/` — note `status: ready`, `active`, or `blocked` files and open tasks 4. Check blocked tasks: `GET /tasks/?needs_human=true` **During work:** @@ -94,7 +93,7 @@ curl -s -X PATCH "http://127.0.0.1:8000/tasks/" \ 1. Update workplan file task statuses to reflect progress 2. Log: `POST /progress/` with a summary of what changed 3. Note for the custodian operator: after workplan file changes, run from - `~/the-custodian/state-hub`: + `~/state-hub`: ```bash make fix-consistency REPO=artifact-store ``` @@ -107,10 +106,10 @@ curl -s -X PATCH "http://127.0.0.1:8000/tasks/" \ Work items originate as files in this repo — not in the hub. The hub is a read/cache/index layer that rebuilds from files. -**File location:** `workplans/ARTIFACT-STORE-WP-NNNN-.md` +**File location:** `workplans/ARTIFACT-WP-NNNN-.md` -**Archived location:** completed workplans may move to -`workplans/archived/YYMMDD-ARTIFACT-STORE-WP-NNNN-.md`. The `YYMMDD` prefix is +**Archived location:** finished workplans may move to +`workplans/archived/YYMMDD-ARTIFACT-WP-NNNN-.md`. The `YYMMDD` prefix is the completion/archive date; the frontmatter `id` does not change. **Ad Hoc Tasks:** small opportunistic fixes discovered during a session use @@ -122,12 +121,12 @@ anything needing analysis, design, approval, dependencies, or multiple phases. ```yaml --- -id: ARTIFACT-STORE-WP-NNNN +id: ARTIFACT-WP-NNNN type: workplan title: "..." domain: stack repo: artifact-store -status: active | done +status: proposed | ready | active | blocked | backlog | finished | archived owner: codex topic_slug: ... created: "YYYY-MM-DD" @@ -136,13 +135,17 @@ state_hub_workstream_id: "" # written by fix-consistency — do not edit --- ``` +Use `proposed` for a new draft, `ready` after review against current repo +state, and `finished` after implementation. `stalled` and `needs_review` are +derived health labels, not frontmatter statuses. + **Task block format** (one per `##` section): ``` ## Task Title ` ` `task -id: ARTIFACT-STORE-WP-NNNN-T01 +id: ARTIFACT-WP-NNNN-T01 status: todo | in_progress | done | blocked priority: high | medium | low state_hub_task_id: "" # written by fix-consistency — do not edit @@ -157,43 +160,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=artifact-store` (or send a message to the hub agent via `POST /messages/`) - ---- - -## Current Repo Shape - -v0.1 baseline (WP-0001) is live: library, CLI, minimal HTTP app, local FS -backend, end-to-end ingest + finalize + replay. The pinned tech stack is in -[ADR-0005](docs/adr/0005-v1-tech-stack.md). - -Sources of truth: - -- `INTENT.md` — purpose, product thesis, scope, service boundary. -- `SCOPE.md` — lightweight orientation. -- `docs/OPERATOR.md` — runbook: env vars, DB backends, CLI / HTTP reference, smoke test, replay procedure. -- `docs/ARCHITECTURE-BLUEPRINT.md` — architecture v2: modules, data model, API shape. -- `docs/PLATFORM-AMBITION.md` — longer-horizon thesis and the v1 schema commitments (A1–A9). -- `docs/adr/` — architecture decision records ADR-0001 … ADR-0006 (content-addressed storage, event log as source of truth, canonical CBOR manifests, control/data plane contract, v1 tech stack, OCI reachability). -- `docs/ROADMAP.md` — workplan sequencing across phases. -- `docs/ASSEMBLY-EXPERIMENT.md` — opt-in research line on hand-tuned asm for hot kernels. -- `workplans/ARTIFACT-STORE-WP-0001-service-baseline.md` — Foundation workplan (done). -- `workplans/ARTIFACT-STORE-WP-{0002..0005}-*.md` — planned next workplans. - -Local commands: - -```sh -make install # uv sync --all-extras -make migrate-fresh # drop + re-create the dev SQLite DB -make dev # uvicorn on 127.0.0.1:8000 -make test # pytest -make lint type # ruff + mypy --strict -artifactstore health -``` - -## Repo Boundary - -This repo owns artifact identity, package/file metadata, storage backend -abstraction, retention policy, retrieval metadata, and audit trails. - -It does not own StateHub work records, guide-board assessment semantics, formal -records-management certification, or producer-specific business logic. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..5c56c2a --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,11 @@ +# artifact-store — 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/agents.md