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..6b6f52d --- /dev/null +++ b/.claude/rules/first-session.md @@ -0,0 +1,38 @@ +## First Session Protocol + +Triggered when `get_domain_summary("custodian")` shows **no workstreams**. +The project is registered but work has not yet been structured. + +**Step 1 — Read, don't write** +- `~/the-custodian/canon/projects/custodian/project_charter_v0.1.md` — purpose, scope +- `~/the-custodian/canon/projects/custodian/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/activity-core-WP-NNNN-.md ← write this first +``` +Then register in the hub: +``` +create_workstream(topic_id="cee7bedf-2b48-46ef-8601-006474f2ad7a", title="...", owner="...", description="...") +create_task(workstream_id="", title="...", priority="high|medium|low") +``` + +**Step 5 — Record the setup** +``` +add_progress_event( + summary="First session: structured custodian into N workstreams, M tasks", + event_type="milestone", + topic_id="cee7bedf-2b48-46ef-8601-006474f2ad7a", + 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..5086826 --- /dev/null +++ b/.claude/rules/repo-boundary.md @@ -0,0 +1,8 @@ +## Repo boundary + +This repo owns **activity-core** 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..ebe2b60 --- /dev/null +++ b/.claude/rules/repo-identity.md @@ -0,0 +1,5 @@ +**Purpose:** Durable task factory built on Temporal. Manages ActivityDefinitions, schedules recurring workflows via Temporal Schedules, routes events via NATS JetStream, and exposes a FastAPI CRUD surface for the custodian domain. + +**Domain:** custodian +**Repo slug:** activity-core +**Topic ID:** cee7bedf-2b48-46ef-8601-006474f2ad7a diff --git a/.claude/rules/session-protocol.md b/.claude/rules/session-protocol.md new file mode 100644 index 0000000..b08b921 --- /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("custodian") +``` +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="activity-core", 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=activity-core&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 `custodian` — title, task counts, blocking decisions +2. **Pending tasks** from `workplans/` + any `[repo:activity-core]` 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="cee7bedf-2b48-46ef-8601-006474f2ad7a", 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":"cee7bedf-2b48-46ef-8601-006474f2ad7a","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=activity-core +``` +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=activity-core +``` +**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..ead1421 --- /dev/null +++ b/.claude/rules/workplan-convention.md @@ -0,0 +1,28 @@ +## Workplan Convention (ADR-001) + +File location: `workplans/activity-core-WP-NNNN-.md` +ID prefix: `ACTIVITY-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-activity-core-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:activity-core]` 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 new file mode 100644 index 0000000..ef5eef1 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,162 @@ +# activity-core — Agent Instructions + +## Repo Identity + +**Purpose:** Durable task factory built on Temporal. Manages ActivityDefinitions, schedules recurring workflows via Temporal Schedules, routes events via NATS JetStream, and exposes a FastAPI CRUD surface for the custodian domain. + +**Domain:** custodian +**Repo slug:** activity-core +**Topic ID:** `cee7bedf-2b48-46ef-8601-006474f2ad7a` +**Workplan prefix:** `ACTIVITY-WP-` + +--- + +## State Hub Integration + +The Custodian State Hub tracks work across all domains. Interact via HTTP REST — +there is no MCP server for Codex agents. + +| Context | URL | +|---------|-----| +| Local workstation | `http://127.0.0.1:8000` | +| Remote via tunnel | `http://127.0.0.1:18000` | + +### Orient at session start + +```bash +# Offline brief — works without hub connection +cat .custodian-brief.md + +# Active workstreams for this domain +curl -s "http://127.0.0.1:8000/workstreams/?topic_id=cee7bedf-2b48-46ef-8601-006474f2ad7a&status=active" \ + | python3 -m json.tool + +# Check inbox +curl -s "http://127.0.0.1:8000/messages/?to_agent=activity-core&unread_only=true" \ + | python3 -m json.tool +``` + +Mark a message read: +```bash +curl -s -X PATCH "http://127.0.0.1:8000/messages//read" \ + -H "Content-Type: application/json" -d '{}' +``` + +### Log progress (required at session close) + +```bash +curl -s -X POST http://127.0.0.1:8000/progress/ \ + -H "Content-Type: application/json" \ + -d '{ + "summary": "what was done", + "event_type": "note", + "author": "codex", + "workstream_id": "", + "task_id": "" + }' +``` + +Omit `workstream_id` / `task_id` when not applicable. + +### Update task status + +```bash +curl -s -X PATCH "http://127.0.0.1:8000/tasks/" \ + -H "Content-Type: application/json" \ + -d '{"status": "in_progress"}' +# values: todo | in_progress | done | blocked +``` + +### Flag a task for human review + +```bash +curl -s -X PATCH "http://127.0.0.1:8000/tasks/" \ + -H "Content-Type: application/json" \ + -d '{"needs_human": true, "intervention_note": "reason"}' +``` + +--- + +## Session Protocol + +**Start:** +1. `cat .custodian-brief.md` — domain goal and open workstreams (offline-safe) +2. Check inbox: `GET /messages/?to_agent=activity-core&unread_only=true`; mark read +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:** +- Update task statuses in workplan files as tasks progress +- Record significant decisions via `POST /decisions/` + +**Close:** +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 + `~/state-hub`: + ```bash + make fix-consistency REPO=activity-core + ``` + This syncs task status from files into the hub DB. + +--- + +## Workplan Convention (ADR-001) + +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/ACTIVITY-WP-NNNN-.md` + +**Archived location:** finished workplans may move to +`workplans/archived/YYMMDD-ACTIVITY-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 +`workplans/ADHOC-YYYY-MM-DD.md` with task ids `ADHOC-YYYY-MM-DD-T01`, etc. Use +this only for low-risk work completed directly; create a normal workplan for +anything needing analysis, design, approval, dependencies, or multiple phases. + +**Frontmatter:** + +```yaml +--- +id: ACTIVITY-WP-NNNN +type: workplan +title: "..." +domain: custodian +repo: activity-core +status: proposed | ready | active | blocked | backlog | finished | archived +owner: codex +topic_slug: ... +created: "YYYY-MM-DD" +updated: "YYYY-MM-DD" +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: ACTIVITY-WP-NNNN-T01 +status: todo | in_progress | done | blocked +priority: high | medium | low +state_hub_task_id: "" # written by fix-consistency — do not edit +` ` ` + +Task description text. +``` + +Status progression: `todo` → `in_progress` → `done` (or `blocked`) + +To create a new workplan: +1. Write the file following the format above +2. Notify the custodian operator to run `make fix-consistency REPO=activity-core` + (or send a message to the hub agent via `POST /messages/`) diff --git a/CLAUDE.md b/CLAUDE.md index e812c28..6008585 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,205 +1,11 @@ -# CLAUDE.md +# activity-core — Claude Code Instructions -This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. - -## Project Overview - -`activity-core` is the backbone service for a robust, event-driven "task factory" architecture. The core concept: an `ActivityDefinition` (stored in Postgres) defines a trigger (time-based or event-driven), a context resolver, and task templates. When triggered, a durable workflow evaluates the current context and spawns 0..N `TaskInstance`s. - -**Technology choices (from planning docs in `wiki/`):** -- **Temporal** (self-hosted) as the orchestration engine — replaces Celery/APScheduler/cron -- **PostgreSQL** for app data (ActivityDefinitions, run logs, task instances) and Temporal persistence -- **Python SDK** (primary) for Temporal workflows and activities - -**Domain model:** -- `ActivityDefinition` — versioned record with trigger config (cron/event), context sources, task templates -- `TriggerEvent` — time-based (Temporal Schedule) or external event (broker → Event Router → `client.start_workflow`) -- `RunActivityWorkflow` — durable Temporal workflow: load definition → resolve context → evaluate rules → spawn tasks → log run -- `TaskInstance` — child workflow or activity; human-facing tasks persisted to DB - -**Planned directory structure (not yet scaffolded):** -``` -workplans/ # ADR-001: workplan .md files (created before hub registration) -contrib/ # upstream contribution artifacts (bug-reports/, feature-requests/, extension-points/, upstream-prs/) -workflows.py # Temporal workflow definitions -activities.py # Temporal activity implementations -``` - ---- - -## Custodian State Hub Integration - -This project is tracked as the **custodian** domain in the Custodian State Hub. -Hub topic ID: `cee7bedf-2b48-46ef-8601-006474f2ad7a` - -The State Hub runs locally at http://127.0.0.1:8000. The MCP server (`state-hub`) -exposes tools for reading and writing state without touching the API directly. - -### Session Protocol - -**On receiving your first message — before writing any response text — execute -this orientation sequence. Do not greet, do not ask what to do first.** - -**Step 1 — Read the offline-safe brief** -```bash -cat .custodian-brief.md -``` -This always works — no MCP, no network required. - -**Step 1b — Call the State Hub for richer context** (skip if MCP unreachable) -``` -get_domain_summary("custodian") # workstreams, blocking decisions, recent progress, SBOM status -``` -If the call fails, the API is offline: `cd ~/the-custodian/state-hub && make api` - -**Step 1c — Check the agent inbox** -``` -get_messages(to_agent="activity-core", unread_only=True) -``` -Mark messages read with `mark_message_read(message_id)`. Act on any coordination requests before proceeding. - -**Step 2 — Scan local workplans** - -Read every `.md` file under `workplans/`. For each file with `status: active`, extract and note: -- The workplan title and ID -- All tasks whose `status` is `todo` or `in_progress` - -**Step 3 — Present orientation to the user** - -Output a concise brief covering: -1. **Active workstreams** (from state hub) for the `custodian` domain — title, task counts, any blocking decisions -2. **Pending tasks for this repo** — from local `workplans/` files plus any state hub tasks with `[repo:activity-core]` in their title -3. **Goal guidance** — if the summary contains a `goal_guidance` key, act on it: - - **`needs_workplan`** entries: for each active repo goal with no linked workstream, - surface it as the top suggested action — *"Repo goal '{title}' has no workplan yet. - Suggest: create workplans/ACT-WP-NNNN-.md and register a workstream - with repo_goal_id='{goal_id}'"*. Treat this as higher priority than continuing - existing work unless Bernd says otherwise. - - **`alignment_warnings`** entries: if active workstreams exist but are not linked - to the current repo goal, name the most recently active one and note: - *"Current work on '{recent_workstream_title}' may not be aligned with the active - goal '{active_goal_title}'. Continue unless you hear otherwise — but flag it."* -4. **Suggested next action** — the highest-priority open item across all sources, - with goal alignment taken into account -5. **SBOM status** — is `last_sbom_at` set for this repo? If not, note it as a gap - -If there are no workstreams at all: follow the First Session Protocol below. - -**During work:** -- Use `record_decision()` for any decision that affects direction or dependencies. -- Use `add_progress_event()` for notable events (milestones, blockers, insights). -- Use `resolve_decision()` to close a decision once the choice is made. - -> **Design boundary:** The State Hub is a *read model*. Two write operations are -> permanently sanctioned: **Resolving Decisions** and **Suggesting Next Steps**. -> The bootstrap tools (`create_workstream`, `create_task`, `update_task_status`) -> are only for First Session Protocol. Formal work structure — workplans, tasks — -> belongs in the domain repo as files (ADR-001), not managed through the hub alone. - -**At the end of every session:** -- Call `add_progress_event()` with a summary of what was accomplished or decided. - Include `topic_id: cee7bedf-2b48-46ef-8601-006474f2ad7a` and the relevant `workstream_id`. - ---- - -### Repo Boundary Rule - -This agent is responsible for files **in this repo only**. - -- **Do not** write files or make commits in any other repository -- When you identify work for another registered repo (**ecosystem todo**): create a state hub task with `[repo:]` in the title -- When you identify work for an upstream repo (**third-party todo**): create a contribution artifact in `contrib/` and register it - ---- - -### First Session Protocol - -Triggered when `get_state_summary()` shows **no workstreams** for the `custodian` topic. - -**Step 1 — Understand the project (read, don't write)** -- `~/the-custodian/canon/projects/custodian/project_charter_v0.1.md` — purpose, scope -- `~/the-custodian/canon/projects/custodian/roadmap_v0.1.md` — planned phases -- `wiki/` — proto-plans from ChatGPT and Grok (architecture reference, not yet compiled into a workplan) - -**Step 2 — Survey in-progress work** — look for TODOs, open branches, half-finished files. - -**Step 3 — Propose workstreams to Bernd.** Wait for approval before creating. - -**Step 4 — Create workplan file first, then DB record (ADR-001):** -``` -workplans/-WP-NNNN-.md ← write this first -``` -Then register in the hub: -``` -create_workstream(topic_id="cee7bedf-2b48-46ef-8601-006474f2ad7a", title="...", owner="...", description="...") -create_task(workstream_id="", title="...", priority="high|medium|low") -``` - -**Step 5 — Record the setup:** -``` -add_progress_event(summary="First session: ...", event_type="milestone", - topic_id="cee7bedf-2b48-46ef-8601-006474f2ad7a", detail={...}) -``` - ---- - -### Workplan Convention (ADR-001) - -Work items MUST originate as files in this repo before being registered in the hub. - -**File location:** `workplans/-.md` -**Frontmatter required:** `id`, `type: workplan`, `domain`, `repo`, `status`, -`state_hub_workstream_id`, `state_hub_task_id` (per task) - ---- - -### Contribution Tracking - -Track upstream contributions in `contrib/`: -``` -contrib/ - bug-reports/ # br-YYYY-MM-DD--org--repo--slug.md - feature-requests/ # fr-YYYY-MM-DD--org--repo--slug.md - extension-points/ # EP-custodian-NNN--org--repo--slug.md - upstream-prs/ # upr-YYYY-MM-DD--org--repo--slug.md -``` -Templates: `~/the-custodian/canon/standards/contrib-templates/` - -``` -register_contribution(type="br|fr|ep|upr", title="...", target_org="...", - target_repo="...", body_path="contrib/...", related_workstream_id="") -``` - ---- - -### SBOM - -After updating dependencies: -```bash -cd ~/the-custodian/state-hub -make ingest-sbom REPO=activity-core SCAN=1 REPO_PATH=$(pwd) -``` - ---- - -### Ralph Loop — Workplan-Tied Usage - -**Rule: always use `/ralph-workplan` instead of `/ralph-loop` directly.** - -``` -/ralph-workplan workplans/-.md [--max-iterations 20] -``` - -This skill guards against runaway loops: -1. **Refuses to start** if the workplan `status` is already `done` -2. **Self-retires** — re-reads the workplan file each iteration; outputs `HEUREKA` the moment all tasks are `done` -3. Always sets `--completion-promise HEUREKA` and a bounded iteration count - -**Never** start a ralph loop with a raw static implementation prompt. A static prompt -has no completion awareness and will loop forever even after the work is done. - ---- - -### Quick Reference - -`~/the-custodian/state-hub/mcp_server/TOOLS.md` — compact MCP tool reference +@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