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..7f6c552 --- /dev/null +++ b/.claude/rules/first-session.md @@ -0,0 +1,38 @@ +## First Session Protocol + +Triggered when `get_domain_summary("netkingdom")` shows **no workstreams**. +The project is registered but work has not yet been structured. + +**Step 1 — Read, don't write** +- `~/the-custodian/canon/projects/netkingdom/project_charter_v0.1.md` — purpose, scope +- `~/the-custodian/canon/projects/netkingdom/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/net-kingdom-WP-NNNN-.md ← write this first +``` +Then register in the hub: +``` +create_workstream(topic_id="a6c6e745-bf54-4465-9340-1534a2be493e", title="...", owner="...", description="...") +create_task(workstream_id="", title="...", priority="high|medium|low") +``` + +**Step 5 — Record the setup** +``` +add_progress_event( + summary="First session: structured netkingdom into N workstreams, M tasks", + event_type="milestone", + topic_id="a6c6e745-bf54-4465-9340-1534a2be493e", + 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..68c612a --- /dev/null +++ b/.claude/rules/repo-boundary.md @@ -0,0 +1,8 @@ +## Repo boundary + +This repo owns **NetKingdom** 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..e10dc9a --- /dev/null +++ b/.claude/rules/repo-identity.md @@ -0,0 +1,5 @@ +**Purpose:** NetKingdom infrastructure and IAM platform — orchestrates SSO/MFA, multi-user onboarding, and the Keycape/Keycloak IAM profile across the NetKingdom environment. + +**Domain:** netkingdom +**Repo slug:** net-kingdom +**Topic ID:** a6c6e745-bf54-4465-9340-1534a2be493e diff --git a/.claude/rules/session-protocol.md b/.claude/rules/session-protocol.md new file mode 100644 index 0000000..1e2821f --- /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("netkingdom") +``` +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="net-kingdom", 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=net-kingdom&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 `netkingdom` — title, task counts, blocking decisions +2. **Pending tasks** from `workplans/` + any `[repo:net-kingdom]` 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="a6c6e745-bf54-4465-9340-1534a2be493e", 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":"a6c6e745-bf54-4465-9340-1534a2be493e","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=net-kingdom +``` +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=net-kingdom +``` +**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..8a96828 --- /dev/null +++ b/.claude/rules/workplan-convention.md @@ -0,0 +1,28 @@ +## Workplan Convention (ADR-001) + +File location: `workplans/net-kingdom-WP-NNNN-.md` +ID prefix: `NET-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-net-kingdom-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:net-kingdom]` 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 3f90d56..18c8e83 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,87 +1,162 @@ -# net-kingdom — Codex Instructions +# NetKingdom — Agent Instructions -## Custodian State Hub Integration +## Repo Identity -This project is tracked as the **netkingdom** domain in the Custodian State Hub. -Hub topic ID: `a6c6e745-bf54-4465-9340-1534a2be493e` +**Purpose:** NetKingdom infrastructure and IAM platform — orchestrates SSO/MFA, multi-user onboarding, and the Keycape/Keycloak IAM profile across the NetKingdom environment. -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. +**Domain:** netkingdom +**Repo slug:** net-kingdom +**Topic ID:** `a6c6e745-bf54-4465-9340-1534a2be493e` +**Workplan prefix:** `NET-WP-` -### Session Protocol +--- -**On receiving your first message — before writing any response text — orient -yourself immediately.** Do not greet, do not ask what to do. +## State Hub Integration -**At the start of every session:** -1. Read `.custodian-brief.md` — offline-safe orientation that works without MCP. -2. Call `get_state_summary()` for richer cross-domain context (skip if unreachable). - If it fails, the API is likely offline: - ``` - cd ~/the-custodian/state-hub && make api - ``` -2. Call `get_next_steps()` — surfaces contextual suggestions from recently resolved - decisions and cleared workstream dependencies. Act on these before starting new work. -3. Check whether this domain has any open workstreams in the summary. - - **If workstreams exist:** review blocking decisions before starting work. - - **If no workstreams exist:** follow the First Session Protocol below. +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=a6c6e745-bf54-4465-9340-1534a2be493e&status=active" \ + | python3 -m json.tool + +# Check inbox +curl -s "http://127.0.0.1:8000/messages/?to_agent=net-kingdom&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=net-kingdom&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:** -- 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 — this is one - of the two sanctioned write operations in the hub. +- Update task statuses in workplan files as tasks progress +- Record significant decisions via `POST /decisions/` -> **Design boundary:** The State Hub is a *read model*. Two write operations are -> permanently sanctioned: **Resolving Decisions** and **Suggesting Next Steps** (v0.2). -> The bootstrap tools (`create_workstream`, `create_task`, `update_task_status`) are -> only for First Session Protocol. Formal work structure — requirements, workplans, -> milestones, tasks — belongs in the domain repo, not managed through the hub. +**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=net-kingdom + ``` + This syncs task status from files into the hub DB. -**At the end of every session:** -- Call `add_progress_event()` with a summary of what was accomplished or decided. - Include `topic_id: a6c6e745-bf54-4465-9340-1534a2be493e` and the relevant `workstream_id`. +--- -### First Session Protocol +## Workplan Convention (ADR-001) -Triggered when `get_state_summary()` shows **no workstreams** for the `netkingdom` topic. -This means the project is registered but work has not yet been structured. +Work items originate as files in this repo — not in the hub. The hub is a +read/cache/index layer that rebuilds from files. -**Step 1 — Understand the project (read, don't write)** -- `canon/projects/netkingdom/project_charter_v0.1.md` — purpose, scope, success criteria -- `canon/projects/netkingdom/roadmap_v0.1.md` — planned phases -- Scan the repo root: README, directory structure, any existing code or docs +**File location:** `workplans/NET-WP-NNNN-.md` -**Step 2 — Survey in-progress work** -- Look for TODOs, open branches, half-finished files, or notes -- Note what is already done vs. what is clearly started but incomplete +**Archived location:** finished workplans may move to +`workplans/archived/YYMMDD-NET-WP-NNNN-.md`. The `YYMMDD` prefix is +the completion/archive date; the frontmatter `id` does not change. -**Step 3 — Propose workstreams to Bernd** -Based on what you found, propose 1–3 workstreams. Each workstream should be: -- A coherent strand of work lasting weeks to months (not a single task) -- Named clearly enough that its scope is obvious -- Anchored to a phase in the roadmap if possible +**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. -Present the proposals and **wait for approval before creating anything**. +**Frontmatter:** -**Step 4 — Create and populate (after approval)** -``` -create_workstream(topic_id="a6c6e745-bf54-4465-9340-1534a2be493e", title="...", owner="...", description="...") -create_task(workstream_id="", title="...", priority="high|medium|low") -# repeat for each task in the workstream -``` -Aim for 3–7 tasks per workstream at this stage. Tasks should be concrete and actionable. - -**Step 5 — Record the setup** -``` -add_progress_event( - summary="First session: structured netkingdom work into N workstreams, M tasks", - event_type="milestone", - topic_id="a6c6e745-bf54-4465-9340-1534a2be493e", - detail={"workstreams": [...], "tasks_created": M} -) +```yaml +--- +id: NET-WP-NNNN +type: workplan +title: "..." +domain: netkingdom +repo: net-kingdom +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 +--- ``` -### Quick Reference +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. -See `~/the-custodian/state-hub/mcp_server/TOOLS.md` for a compact tool reference. +**Task block format** (one per `##` section): + +``` +## Task Title + +` ` `task +id: NET-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=net-kingdom` + (or send a message to the hub agent via `POST /messages/`) diff --git a/CLAUDE.md b/CLAUDE.md index 02f7183..1db79c8 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,87 +1,11 @@ -# net-kingdom — Claude Code Instructions +# NetKingdom — Claude Code Instructions -## Custodian State Hub Integration - -This project is tracked as the **netkingdom** domain in the Custodian State Hub. -Hub topic ID: `a6c6e745-bf54-4465-9340-1534a2be493e` - -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 — orient -yourself immediately.** Do not greet, do not ask what to do. - -**At the start of every session:** -1. Read `.custodian-brief.md` — offline-safe orientation that works without MCP. -2. Call `get_state_summary()` for richer cross-domain context (skip if unreachable). - If it fails, the API is likely offline: - ``` - cd ~/the-custodian/state-hub && make api - ``` -2. Call `get_next_steps()` — surfaces contextual suggestions from recently resolved - decisions and cleared workstream dependencies. Act on these before starting new work. -3. Check whether this domain has any open workstreams in the summary. - - **If workstreams exist:** review blocking decisions before starting work. - - **If no workstreams exist:** 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 — this is one - of the two sanctioned write operations in the hub. - -> **Design boundary:** The State Hub is a *read model*. Two write operations are -> permanently sanctioned: **Resolving Decisions** and **Suggesting Next Steps** (v0.2). -> The bootstrap tools (`create_workstream`, `create_task`, `update_task_status`) are -> only for First Session Protocol. Formal work structure — requirements, workplans, -> milestones, tasks — belongs in the domain repo, not managed through the hub. - -**At the end of every session:** -- Call `add_progress_event()` with a summary of what was accomplished or decided. - Include `topic_id: a6c6e745-bf54-4465-9340-1534a2be493e` and the relevant `workstream_id`. - -### First Session Protocol - -Triggered when `get_state_summary()` shows **no workstreams** for the `netkingdom` topic. -This means the project is registered but work has not yet been structured. - -**Step 1 — Understand the project (read, don't write)** -- `canon/projects/netkingdom/project_charter_v0.1.md` — purpose, scope, success criteria -- `canon/projects/netkingdom/roadmap_v0.1.md` — planned phases -- Scan the repo root: README, directory structure, any existing code or docs - -**Step 2 — Survey in-progress work** -- Look for TODOs, open branches, half-finished files, or notes -- Note what is already done vs. what is clearly started but incomplete - -**Step 3 — Propose workstreams to Bernd** -Based on what you found, propose 1–3 workstreams. Each workstream should be: -- A coherent strand of work lasting weeks to months (not a single task) -- Named clearly enough that its scope is obvious -- Anchored to a phase in the roadmap if possible - -Present the proposals and **wait for approval before creating anything**. - -**Step 4 — Create and populate (after approval)** -``` -create_workstream(topic_id="a6c6e745-bf54-4465-9340-1534a2be493e", title="...", owner="...", description="...") -create_task(workstream_id="", title="...", priority="high|medium|low") -# repeat for each task in the workstream -``` -Aim for 3–7 tasks per workstream at this stage. Tasks should be concrete and actionable. - -**Step 5 — Record the setup** -``` -add_progress_event( - summary="First session: structured netkingdom work into N workstreams, M tasks", - event_type="milestone", - topic_id="a6c6e745-bf54-4465-9340-1534a2be493e", - detail={"workstreams": [...], "tasks_created": M} -) -``` - -### Quick Reference - -See `~/the-custodian/state-hub/mcp_server/TOOLS.md` for a compact 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