From 57b346bb8b63a612e37671d30963c057c88f6e83 Mon Sep 17 00:00:00 2001 From: tegwick Date: Wed, 1 Apr 2026 23:15:29 +0200 Subject: [PATCH] chore(custodian): add CLAUDE.md and .claude/rules/ orientation files Registers llm-connect with the Custodian agent system: - CLAUDE.md: thin @-import index pointing to modular rules - .claude/rules/session-protocol.md: orient with get_domain_summary("custodian") - .claude/rules/repo-identity.md: domain=custodian, slug=llm-connect - .claude/rules/first-session.md, workplan-convention.md, stack-and-commands.md, architecture.md, repo-boundary.md, agents.md, scope.md (stubs to fill in) - session-protocol notes both local (:8000) and CoulombCore bridge (:18000) URLs Co-Authored-By: Claude Sonnet 4.6 --- .claude/rules/agents.md | 20 ++++ .claude/rules/architecture.md | 8 ++ .claude/rules/claude-md.md | 11 +++ .claude/rules/first-session.md | 38 ++++++++ .claude/rules/repo-boundary.md | 8 ++ .claude/rules/repo-identity.md | 5 + .claude/rules/scope.md | 137 +++++++++++++++++++++++++++ .claude/rules/session-protocol.md | 63 ++++++++++++ .claude/rules/stack-and-commands.md | 19 ++++ .claude/rules/workplan-convention.md | 12 +++ CLAUDE.md | 11 +++ 11 files changed, 332 insertions(+) create mode 100644 .claude/rules/agents.md create mode 100644 .claude/rules/architecture.md create mode 100644 .claude/rules/claude-md.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/scope.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..4f6c74c --- /dev/null +++ b/.claude/rules/architecture.md @@ -0,0 +1,8 @@ +## Architecture + + + +## Quick Reference + +`~/the-custodian/state-hub/mcp_server/TOOLS.md` — MCP tool reference diff --git a/.claude/rules/claude-md.md b/.claude/rules/claude-md.md new file mode 100644 index 0000000..bb274fb --- /dev/null +++ b/.claude/rules/claude-md.md @@ -0,0 +1,11 @@ +# {PROJECT_NAME} — 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 diff --git a/.claude/rules/first-session.md b/.claude/rules/first-session.md new file mode 100644 index 0000000..c9089db --- /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/llm-connect-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..ea4e1f5 --- /dev/null +++ b/.claude/rules/repo-boundary.md @@ -0,0 +1,8 @@ +## Repo boundary + +This repo owns **{PROJECT_NAME}** 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..10470bd --- /dev/null +++ b/.claude/rules/repo-identity.md @@ -0,0 +1,5 @@ +**Purpose:** Multi-provider LLM client library — unified adapter interface for OpenAI, Claude, Gemini, OpenRouter with embedding support, token estimation, and TOML-based config. + +**Domain:** custodian +**Repo slug:** llm-connect +**Topic ID:** cee7bedf-2b48-46ef-8601-006474f2ad7a diff --git a/.claude/rules/scope.md b/.claude/rules/scope.md new file mode 100644 index 0000000..d48e39a --- /dev/null +++ b/.claude/rules/scope.md @@ -0,0 +1,137 @@ +# SCOPE + +> This file helps you quickly understand what this repository is about, +> when it is relevant, and when it is not. +> It is intentionally lightweight and may be incomplete. + +--- + +## One-liner + + + + +--- + +## Core Idea + + + + +--- + +## In Scope + + + + +- +- +- + +--- + +## Out of Scope + + + + +- +- +- + +--- + +## Relevant When + + + +- +- +- + +--- + +## Not Relevant When + + + +- +- +- + +--- + +## Current State + + + +- Status: +- Implementation: +- Stability: +- Usage: + + + +--- + +## How It Fits + + + +- Upstream dependencies: +- Downstream consumers: +- Often used with: + +--- + +## Terminology + + + + +- Preferred terms: +- Also known as: +- Potentially confusing terms: + +--- + +## Related / Overlapping Repositories + + + + +- — + +--- + +## Getting Oriented + + + +- Start with: +- Key files / directories: +- Entry points: + +--- + +## Provided Capabilities + + + + + + + +--- + +## Notes + + diff --git a/.claude/rules/session-protocol.md b/.claude/rules/session-protocol.md new file mode 100644 index 0000000..0394618 --- /dev/null +++ b/.claude/rules/session-protocol.md @@ -0,0 +1,63 @@ +## Session Protocol + +State Hub: http://127.0.0.1:8000 (local) · http://127.0.0.1:18000 (CoulombCore via ops-bridge) + +**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 (skip if unreachable): +``` +get_domain_summary("custodian") +``` +If the hub is offline: `cd ~/the-custodian/state-hub && make api` + +**Step 2 — Check inbox** +``` +get_messages(to_agent="llm-connect", unread_only=True) +``` +Mark read with `mark_message_read(message_id)`. Reply or act on coordination +requests before proceeding. + +**Step 3 — Scan workplans** +```bash +ls workplans/ +``` +For each file with `status: active`, 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:llm-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:** +``` +add_progress_event(summary="...", topic_id="cee7bedf-2b48-46ef-8601-006474f2ad7a", workstream_id="") +``` +If workplan files were modified, ensure the local copy is up to date first: +```bash +git -C pull --ff-only +cd ~/the-custodian/state-hub && make fix-consistency REPO=llm-connect +``` +For repos where implementation runs on a remote machine (e.g. CoulombCore), +use the combined target which pulls before fixing: +```bash +cd ~/the-custodian/state-hub && make fix-consistency-remote REPO=llm-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..5618a44 --- /dev/null +++ b/.claude/rules/workplan-convention.md @@ -0,0 +1,12 @@ +## Workplan Convention (ADR-001) + +File location: `workplans/llm-connect-WP-NNNN-.md` +ID prefix: `LLM-WP` + +Work items originate as files in this repo **before** being registered in the hub. + +Ecosystem todos from other agents arrive as `[repo:llm-connect]` hub tasks — +visible at session start. Pick one up by creating the workplan file, then registering +the workstream. + + diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..299988d --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,11 @@ +# llm-connect — 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