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..8157225 --- /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/EMAIL-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 infotech 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..7f5b6f9 --- /dev/null +++ b/.claude/rules/repo-boundary.md @@ -0,0 +1,8 @@ +## Repo boundary + +This repo owns **email-connect** 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..9c82d2b --- /dev/null +++ b/.claude/rules/repo-identity.md @@ -0,0 +1,5 @@ +**Purpose:** Headless provider-neutral email communication and evidence service for sending, tracking, diagnosing, and normalizing email-channel events. + +**Domain:** infotech +**Repo slug:** email-connect +**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..85850d0 --- /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="email-connect", 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=email-connect&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:email-connect]` 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=email-connect +``` +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=email-connect +``` +**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..1640d9a --- /dev/null +++ b/.claude/rules/workplan-convention.md @@ -0,0 +1,40 @@ +## Workplan Convention (ADR-001) + +File location: `workplans/EMAIL-WP-NNNN-.md` +ID prefix: `EMAIL-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-EMAIL-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:email-connect]` 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: EMAIL-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 81c472b..3a86c8f 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -2,41 +2,15 @@ ## Repo Identity -**Purpose:** Headless, provider-neutral email communication and evidence service -for sending, tracking, diagnosing, and normalizing email-channel events without -overclaiming delivery, awareness, or result satisfaction. +**Purpose:** Headless provider-neutral email communication and evidence service for sending, tracking, diagnosing, and normalizing email-channel events. -**Domain:** custodian +**Domain:** infotech **Repo slug:** email-connect **Topic ID:** `cee7bedf-2b48-46ef-8601-006474f2ad7a` **Workplan prefix:** `EMAIL-WP-` --- -## Repo Orientation - -This repository is currently in planning/specification shape. Treat -`INTENT.md` as the canonical product intent and -`spec/ProductRequirementsDocument.md` as the detailed requirements source until -implementation architecture is added. - -Preserve the core principle: email events are evidence, not result -satisfaction. Provider acceptance, MX acceptance, inbox placement, opens, -clicks, replies, complaints, suppressions, and bounces must remain distinct. -Do not collapse them into "delivered", "read", "accepted", or any similar -business conclusion. - -Keep the product provider-neutral and adapter-friendly. It should be useful as -a standalone email communication/evidence service and as the reference -`coordination-engine` adapter. It should not drift into newsletter campaign -management, broad marketing automation, or legal/business outcome adjudication. - -There is no runtime stack committed yet. Any stack, API, storage, or provider -choice should be introduced through a workplan and anchored in the current -intent/PRD. - ---- - ## State Hub Integration The Custodian State Hub tracks work across all domains. Interact via HTTP REST — @@ -50,8 +24,8 @@ there is no MCP server for Codex agents. ### Orient at session start ```bash -# Offline brief, when present -test -f .custodian-brief.md && cat .custodian-brief.md +# 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" \ @@ -106,7 +80,7 @@ curl -s -X PATCH "http://127.0.0.1:8000/tasks/" \ ## Session Protocol **Start:** -1. `test -f .custodian-brief.md && cat .custodian-brief.md` — domain goal and open workstreams, when present +1. `cat .custodian-brief.md` — domain goal and open workstreams (offline-safe) 2. Check inbox: `GET /messages/?to_agent=email-connect&unread_only=true`; mark read 3. Scan workplans: `ls workplans/` — note `status: ready`, `active`, or `blocked` files and open tasks 4. Check human-needed tasks: `GET /tasks/?needs_human=true` @@ -177,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) @@ -202,7 +181,7 @@ anything needing analysis, design, approval, dependencies, or multiple phases. id: EMAIL-WP-NNNN type: workplan title: "..." -domain: custodian +domain: infotech repo: email-connect status: proposed | ready | active | blocked | backlog | finished | archived owner: codex diff --git a/CLAUDE.md b/CLAUDE.md index 9917290..ba5f0bf 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -1,21 +1,12 @@ -# email-connect - Claude Code Instructions +# email-connect — Claude Code Instructions -This repository uses `AGENTS.md` as the canonical local agent instruction file. -Claude Code agents should read `AGENTS.md` first and follow the same State Hub -identity, workplan convention, and repo-specific semantic guardrails. - -State Hub identity: - -- Domain: `custodian` -- Repo slug: `email-connect` -- Topic ID: `cee7bedf-2b48-46ef-8601-006474f2ad7a` -- Workplan prefix: `EMAIL-WP-` - -Core product rule: email events are evidence, not result satisfaction. Do not -treat provider acceptance, MX acceptance, inbox placement, opens, clicks, -replies, complaints, or suppressions as proof of human awareness or business -outcome completion. - -Start with `INTENT.md`, then `spec/ProductRequirementsDocument.md`, then the -active files under `workplans/`. +@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/EMAIL-WP-0001-repo-onboarding.md b/workplans/EMAIL-WP-0001-repo-onboarding.md index 0a6c9ee..d864577 100644 --- a/workplans/EMAIL-WP-0001-repo-onboarding.md +++ b/workplans/EMAIL-WP-0001-repo-onboarding.md @@ -2,7 +2,7 @@ id: EMAIL-WP-0001 type: workplan title: "Repository Onboarding and Implementation Foundation" -domain: custodian +domain: infotech repo: email-connect status: finished owner: codex diff --git a/workplans/EMAIL-WP-0002-mvp-mailbox-evidence-scanner.md b/workplans/EMAIL-WP-0002-mvp-mailbox-evidence-scanner.md index 7b802ca..915f94e 100644 --- a/workplans/EMAIL-WP-0002-mvp-mailbox-evidence-scanner.md +++ b/workplans/EMAIL-WP-0002-mvp-mailbox-evidence-scanner.md @@ -2,7 +2,7 @@ id: EMAIL-WP-0002 type: workplan title: "MVP Mailbox Evidence Scanner" -domain: custodian +domain: infotech repo: email-connect status: finished owner: codex @@ -653,7 +653,8 @@ This allows rescanning old messages after parser improvements. Initial mappings: | Parsed class | Normalized event | Assessment | -| ------------------------- | ------------------------------------------- | ------------------------------- | +| ------------------------- | ------------------------------------ +------- | ------------------------------- | | `hard_bounce` | `notification.endpoint.rejected_permanent` | `fail.hard_bounce` | | `soft_bounce` | `notification.endpoint.rejected_temporary` | `undef.deferred` | | `delayed_delivery_notice` | `notification.endpoint.deferred` | `undef.deferred` | @@ -672,7 +673,8 @@ The scanner should update basic endpoint quality. Examples: | Evidence | Endpoint quality update | -| ------------- | ---------------------------------------------------------- | +| ------------- | ------------------------------------ +---------------------- | | Hard bounce | `reachability = unreachable`, `last_failure_at = now` | | Soft bounce | `reachability = degraded`, `last_failure_at = now` | | Complaint | `suppression_state = suppressed` | diff --git a/workplans/EMAIL-WP-0003-expected-recipient-reporting-and-mailbox-tutorial.md b/workplans/EMAIL-WP-0003-expected-recipient-reporting-and-mailbox-tutorial.md index 59e2e96..da937b2 100644 --- a/workplans/EMAIL-WP-0003-expected-recipient-reporting-and-mailbox-tutorial.md +++ b/workplans/EMAIL-WP-0003-expected-recipient-reporting-and-mailbox-tutorial.md @@ -2,7 +2,7 @@ id: EMAIL-WP-0003 type: workplan title: "Expected Recipient Reporting and Mailbox Tutorial" -domain: custodian +domain: infotech repo: email-connect status: finished owner: codex