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..f88b382 --- /dev/null +++ b/.claude/rules/first-session.md @@ -0,0 +1,38 @@ +## First Session Protocol + +Triggered when `get_domain_summary("markitect")` shows **no workstreams**. +The project is registered but work has not yet been structured. + +**Step 1 — Read, don't write** +- `~/the-custodian/canon/projects/markitect/project_charter_v0.1.md` — purpose, scope +- `~/the-custodian/canon/projects/markitect/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/markitect-tool-WP-NNNN-.md ← write this first +``` +Then register in the hub: +``` +create_workstream(topic_id="5571d954-0d30-4950-980d-7bcaaad8e3e2", title="...", owner="...", description="...") +create_task(workstream_id="", title="...", priority="high|medium|low") +``` + +**Step 5 — Record the setup** +``` +add_progress_event( + summary="First session: structured markitect into N workstreams, M tasks", + event_type="milestone", + topic_id="5571d954-0d30-4950-980d-7bcaaad8e3e2", + detail={"workstreams": [...], "tasks_created": M} +) +``` + + diff --git a/.claude/rules/repo-boundary.md b/.claude/rules/repo-boundary.md index d777098..660057b 100644 --- a/.claude/rules/repo-boundary.md +++ b/.claude/rules/repo-boundary.md @@ -1,9 +1,8 @@ -# Repo Boundary +## Repo boundary -Keep `markitect-tool` focused on provider-neutral markdown primitives: -parse, validate, transform, compose, query, template, generate, configure, -cache, and expose through CLI/API. +This repo owns **markitect-tool** only. It does not own: -Leave infospace lifecycle, persistence/orchestration, project-specific -knowledge models, rendering applications, and service infrastructure to -higher-layer repositories. + diff --git a/.claude/rules/repo-identity.md b/.claude/rules/repo-identity.md index 7807de9..abe812f 100644 --- a/.claude/rules/repo-identity.md +++ b/.claude/rules/repo-identity.md @@ -1,9 +1,5 @@ -# Repo Identity +**Purpose:** markitect-tool - (fill in purpose) -- Project: `markitect-tool` -- Domain: `markitect` -- Repo slug: `markitect-tool` -- State Hub topic ID: `5571d954-0d30-4950-980d-7bcaaad8e3e2` - -This repository is the markdown syntax/tooling successor to the in-scope core -of `markitect-main`. +**Domain:** markitect +**Repo slug:** markitect-tool +**Topic ID:** 5571d954-0d30-4950-980d-7bcaaad8e3e2 diff --git a/.claude/rules/session-protocol.md b/.claude/rules/session-protocol.md index 8e30b86..2d59b99 100644 --- a/.claude/rules/session-protocol.md +++ b/.claude/rules/session-protocol.md @@ -1,7 +1,84 @@ -# Session Protocol +## Session Protocol -1. Read `INTENT.md`, the PRD, the FRS, and active workplans. -2. Check State Hub for dispatch and blockers when available. -3. Treat workplan files as authoritative coordination state. -4. Record durable decisions in repository docs before reflecting them in State Hub. -5. Keep the implementation boundary narrow: syntax-layer toolkit, not platform. +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("markitect") +``` +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="markitect-tool", 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=markitect-tool&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 `markitect` — title, task counts, blocking decisions +2. **Pending tasks** from `workplans/` + any `[repo:markitect-tool]` 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="5571d954-0d30-4950-980d-7bcaaad8e3e2", 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":"5571d954-0d30-4950-980d-7bcaaad8e3e2","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=markitect-tool +``` +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=markitect-tool +``` +**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 index bfa771b..4a2fd5b 100644 --- a/.claude/rules/workplan-convention.md +++ b/.claude/rules/workplan-convention.md @@ -1,9 +1,28 @@ -# Workplan Convention +## Workplan Convention (ADR-001) -Workplans live at `workplans/-.md`. +File location: `workplans/markitect-tool-WP-NNNN-.md` +ID prefix: `MARKITECT-WP` -Use IDs with the `MKTT-WP-` prefix for this repository. Embedded tasks use -`MKTT-WP-XXXX-TNNN`. +Work items originate as files in this repo **before** being registered in the hub. -Each workplan should trace back to the PRD/FRS and indicate what is migrated, -reimplemented, deferred, or explicitly out of scope. +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-markitect-tool-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:markitect-tool]` 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..13c4ecf --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,162 @@ +# markitect-tool — Agent Instructions + +## Repo Identity + +**Purpose:** markitect-tool - (fill in purpose) + +**Domain:** markitect +**Repo slug:** markitect-tool +**Topic ID:** `5571d954-0d30-4950-980d-7bcaaad8e3e2` +**Workplan prefix:** `MARKITECT-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=5571d954-0d30-4950-980d-7bcaaad8e3e2&status=active" \ + | python3 -m json.tool + +# Check inbox +curl -s "http://127.0.0.1:8000/messages/?to_agent=markitect-tool&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=markitect-tool&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=markitect-tool + ``` + 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/MARKITECT-WP-NNNN-.md` + +**Archived location:** finished workplans may move to +`workplans/archived/YYMMDD-MARKITECT-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: MARKITECT-WP-NNNN +type: workplan +title: "..." +domain: markitect +repo: markitect-tool +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: MARKITECT-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=markitect-tool` + (or send a message to the hub agent via `POST /messages/`) diff --git a/CLAUDE.md b/CLAUDE.md index 5b6bf7e..1f8cbf8 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,61 +1,11 @@ -# markitect-tool Agent Guide +# markitect-tool — Claude Code Instructions -This repository is tracked in the Custodian State Hub as: - -- Domain: `markitect` -- Repo slug: `markitect-tool` -- Topic ID: `5571d954-0d30-4950-980d-7bcaaad8e3e2` - -At session start, orient from: - -1. `INTENT.md` -2. `wiki/ProductRequirementsDocument.md` -3. `wiki/FunctionalRequirementsSpecification.md` -4. `docs/markitect-main-scope-assessment.md` -5. Active files in `workplans/` - -## State Hub - -This repo is registered with State Hub through the local Custodian service. -State Hub is an index/cache for coordination state; the authoritative work -items live in this repository as Markdown workplans. - -Use State Hub to inspect current dispatch, blockers, progress, and cross-repo -coordination, but write durable plans and decisions into repository files first. - -## Boundary - -`markitect-tool` is the syntax-layer successor to the markdown-core parts of -`markitect-main`. It should stay CLI-first and library-always. - -It owns: - -- Markdown parsing and structured representation -- Schema definition, loading, derivation, validation, and reporting -- Markdown transformation, composition, and transclusion primitives -- Structured query and extraction over markdown documents and corpora -- Deterministic templating and optional LLM-assisted generation hooks -- Configuration, structured errors, caching, and incremental processing - -It does not own: - -- Infospace lifecycle, entity quality evaluation, or domain curation -- Persistent knowledge platform behavior or orchestration -- Provider-specific LLM adapters -- Asset management, rendering plugins, visual editing, finance, or project tooling -- GraphQL/database services except as external consumers of the library - -## Development Posture - -Prefer a clean reimplementation around the new PRD/FRS contract. Migrate -behavior and tests from `markitect-main` only when they fit the new boundary. -Avoid importing legacy platform assumptions just because the old code contains -useful names. - -## Workplans - -Workplans live in `workplans/` and follow the Custodian ADR-001 convention: - -- Frontmatter declares `type: workplan`, `domain: markitect`, and `owner: markitect-tool` -- Tasks are embedded as headed sections with fenced `task` blocks -- State Hub may index these files, but the files remain authoritative +@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