Regenerate agent instructions from state-hub templates (CUST-WP-0055 T01)
Sync AGENTS.md, CLAUDE.md, and .claude/rules from updated project_rules templates: workplan-first session protocol, legacy terminology footnote, and GET /workplans/ examples.
This commit is contained in:
parent
8ea196298b
commit
f8d0ef3c0f
8 changed files with 249 additions and 88 deletions
|
|
@ -19,8 +19,8 @@ Requires the `warden` CLI from `~/ops-warden` (`uv tool install .` or `uv run wa
|
||||||
|
|
||||||
| Agent runtime | How to orient |
|
| Agent runtime | How to orient |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| **Codex / Grok** (shell, HTTP State Hub) | `warden route` commands above; inbox `to_agent=repo-seed` is for coordination, not secret vending |
|
| **Codex / Grok** (shell, HTTP State Hub) | `warden route` commands above; inbox `to_agent=core-hub` is for coordination, not secret vending |
|
||||||
| **Claude Code** (MCP when available) | `get_domain_summary("custodian")` for workstreams; **still** use `warden route` for credential ownership |
|
| **Claude Code** (MCP when available) | `get_domain_summary("custodian")` for workplans; **still** use `warden route` for credential ownership |
|
||||||
| **llm-connect** (inference service) | Never put secret retrieval in prompts; route custody to OpenBao/operator paths surfaced by `warden route` |
|
| **llm-connect** (inference service) | Never put secret retrieval in prompts; route custody to OpenBao/operator paths surfaced by `warden route` |
|
||||||
|
|
||||||
### Quick routing table
|
### Quick routing table
|
||||||
|
|
|
||||||
|
|
@ -1,26 +1,42 @@
|
||||||
## First Session Protocol
|
## First Session Protocol
|
||||||
|
|
||||||
Triggered when State Hub shows no workstreams for `core-hub`.
|
Triggered when `get_domain_summary("infotech")` shows **no workplans**.
|
||||||
|
The project is registered but work has not yet been structured.
|
||||||
|
|
||||||
**Step 1 - Read, do not write yet**
|
**Step 1 — Read, don't write**
|
||||||
- `INTENT.md`
|
- `~/the-custodian/canon/projects/infotech/project_charter_v0.1.md` — purpose, scope
|
||||||
- `SCOPE.md`
|
- `~/the-custodian/canon/projects/infotech/roadmap_v0.1.md` — planned phases
|
||||||
- `docs/research/2026-06-27-core-hub-lineage-and-platform-reset.md`
|
- Scan repo root: README, directory structure, existing code or docs
|
||||||
- `docs/specs/README.md`
|
|
||||||
- Existing files under `workplans/`
|
|
||||||
|
|
||||||
**Step 2 - Survey in-progress work**
|
**Step 2 — Survey in-progress work**
|
||||||
Look for untracked files, open workplans, and half-finished specs. Note done vs. started but incomplete.
|
Look for TODOs, open branches, half-finished files. Note done vs. started but incomplete.
|
||||||
|
|
||||||
**Step 3 - Structure work in files first**
|
**Step 3 — Propose workplans to Bernd**
|
||||||
Create or update `workplans/CORE-WP-NNNN-<slug>.md` before relying on State Hub records.
|
Propose 1–3 workplans — each a coherent strand, weeks to months, anchored to a
|
||||||
|
roadmap phase. **Wait for approval before creating.**
|
||||||
**Step 4 - Sync the read model**
|
|
||||||
After workplan changes, run from `~/state-hub`:
|
|
||||||
|
|
||||||
|
**Step 4 — Write the workplan file; fix-consistency registers it (ADR-001)**
|
||||||
|
```
|
||||||
|
workplans/CORE-WP-NNNN-<slug>.md ← write this, commit it
|
||||||
|
```
|
||||||
|
Then register by running the consistency check — do **not** call
|
||||||
|
`create_workplan`/`create_task` yourself; manual registration duplicates what
|
||||||
|
C-06 creates from the file:
|
||||||
```bash
|
```bash
|
||||||
make fix-consistency REPO=core-hub
|
statehub fix-consistency --repo core-hub
|
||||||
|
```
|
||||||
|
C-06 creates the hub workplan + tasks and writes `state_hub_workstream_id`
|
||||||
|
(legacy frontmatter name — holds the workplan UUID) and `state_hub_task_id`
|
||||||
|
back into the file.
|
||||||
|
|
||||||
|
**Step 5 — Record the setup**
|
||||||
|
```
|
||||||
|
add_progress_event(
|
||||||
|
summary="First session: structured infotech into N workplans, M tasks",
|
||||||
|
event_type="milestone",
|
||||||
|
topic_id="cee7bedf-2b48-46ef-8601-006474f2ad7a",
|
||||||
|
detail={"workplans": [...], "tasks_created": M}
|
||||||
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
**Step 5 - Record progress**
|
<!-- Delete or archive this file once past first session -->
|
||||||
Post a non-secret progress note to State Hub summarizing the setup or implementation work.
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
## Repo boundary
|
## Repo boundary
|
||||||
|
|
||||||
This repo owns **Repo Seed** only. It does not own:
|
This repo owns **core-hub** only. It does not own:
|
||||||
|
|
||||||
<!-- TODO: List what belongs in adjacent repos, e.g.:
|
<!-- TODO: List what belongs in adjacent repos, e.g.:
|
||||||
- SSH key management → railiance-infra/
|
- SSH key management → railiance-infra/
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,5 @@
|
||||||
**Purpose:** 3rd-generation production interaction framework for Coulomb / Helixforge.
|
**Purpose:** Core Hub is the 3rd-generation production interaction and coordination framework for Coulomb / Helixforge, intended to supersede the 1st-generation state-hub and 2nd-generation inter-hub infrastructure.
|
||||||
|
|
||||||
**Domain:** infotech
|
**Domain:** infotech
|
||||||
**Repo slug:** core-hub
|
**Repo slug:** core-hub
|
||||||
**Topic ID:** cee7bedf-2b48-46ef-8601-006474f2ad7a
|
**Topic ID:** cee7bedf-2b48-46ef-8601-006474f2ad7a
|
||||||
**Workplan prefix:** CORE-WP-
|
|
||||||
|
|
|
||||||
|
|
@ -1,48 +1,92 @@
|
||||||
## Session Protocol
|
## Session Protocol
|
||||||
|
|
||||||
Dev Hub (State Hub API): http://127.0.0.1:8000
|
Dev Hub (State Hub API): http://127.0.0.1:8000
|
||||||
|
MCP server name in `~/.claude.json`: `dev-hub`
|
||||||
|
|
||||||
**Step 1 - Orient**
|
**Step 1 — Orient**
|
||||||
|
|
||||||
|
Read the offline-safe brief first — it works without a live hub connection:
|
||||||
```bash
|
```bash
|
||||||
cat .custodian-brief.md
|
cat .custodian-brief.md
|
||||||
cat INTENT.md
|
|
||||||
cat SCOPE.md
|
|
||||||
ls workplans/
|
|
||||||
```
|
```
|
||||||
|
Then call the MCP tool for richer cross-domain context when MCP tools are exposed:
|
||||||
Use REST when MCP tools are unavailable:
|
```
|
||||||
|
get_domain_summary("infotech")
|
||||||
|
```
|
||||||
|
If MCP tools are unavailable in the current agent session, use the REST API:
|
||||||
```bash
|
```bash
|
||||||
curl -s "http://127.0.0.1:8000/workstreams/?topic_id=cee7bedf-2b48-46ef-8601-006474f2ad7a&status=active" | python3 -m json.tool
|
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**
|
**Step 2 — Check inbox**
|
||||||
|
With MCP tools:
|
||||||
|
```
|
||||||
|
get_messages(to_agent="core-hub", unread_only=True)
|
||||||
|
```
|
||||||
|
Mark read with `mark_message_read(message_id)`. Reply or act on coordination
|
||||||
|
requests before proceeding.
|
||||||
|
|
||||||
|
Without MCP tools:
|
||||||
```bash
|
```bash
|
||||||
curl -s "http://127.0.0.1:8000/messages/?to_agent=core-hub&unread_only=true" | python3 -m json.tool
|
curl -s "http://127.0.0.1:8000/messages/?to_agent=core-hub&unread_only=true" \
|
||||||
|
| python3 -m json.tool
|
||||||
|
curl -s -X PATCH "http://127.0.0.1:8000/messages/<id>/read" \
|
||||||
|
-H "Content-Type: application/json" -d '{}'
|
||||||
```
|
```
|
||||||
|
|
||||||
Mark read when handled.
|
**Step 3 — Scan workplans**
|
||||||
|
|
||||||
**Step 3 - Scan workplans**
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
ls workplans/
|
ls workplans/
|
||||||
```
|
```
|
||||||
|
For each file with `status: ready`, `active`, or `blocked`, note pending
|
||||||
|
`wait`/`todo`/`progress` tasks.
|
||||||
|
|
||||||
For each file with `status: ready`, `active`, or `blocked`, note pending `wait`/`todo`/`progress` tasks.
|
**Step 4 — Present brief**
|
||||||
|
|
||||||
**Step 4 - Work file-first**
|
1. **Active workplans** for `infotech` — title, task counts, blocking decisions
|
||||||
|
2. **Pending tasks** from `workplans/` + any `[repo:core-hub]` 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
|
||||||
|
|
||||||
State Hub is a read/cache/index layer. Work structure belongs in repo files under ADR-001.
|
If no workplans: follow First Session Protocol (`first-session.md`).
|
||||||
|
|
||||||
**Session close**
|
**During work:** `record_decision()` · `add_progress_event()` · `resolve_decision()`
|
||||||
|
|
||||||
|
> State Hub is a *read model*. **Never register workplans or tasks by hand**
|
||||||
|
> (`create_workplan`, `create_task`) — write the workplan file in `workplans/`
|
||||||
|
> and run `fix-consistency`; C-06 registers the workplan and tasks and writes
|
||||||
|
> IDs back into the file. Manual registration creates duplicates when
|
||||||
|
> fix-consistency runs. Work structure belongs in repo files (ADR-001).
|
||||||
|
>
|
||||||
|
> Legacy: `create_workstream` and `/workstreams/` remain as metered aliases —
|
||||||
|
> see `workplan-convention.md` (compatibility footnote).
|
||||||
|
|
||||||
|
**Session close:**
|
||||||
|
With MCP tools:
|
||||||
|
```
|
||||||
|
add_progress_event(summary="...", topic_id="cee7bedf-2b48-46ef-8601-006474f2ad7a", workplan_id="<uuid>")
|
||||||
|
```
|
||||||
|
Without MCP tools:
|
||||||
```bash
|
```bash
|
||||||
cd ~/state-hub
|
|
||||||
make fix-consistency REPO=core-hub
|
|
||||||
curl -s -X POST http://127.0.0.1:8000/progress/ \
|
curl -s -X POST http://127.0.0.1:8000/progress/ \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"topic_id":"cee7bedf-2b48-46ef-8601-006474f2ad7a","event_type":"note","summary":"what changed","author":"codex"}'
|
-d '{"topic_id":"cee7bedf-2b48-46ef-8601-006474f2ad7a","workplan_id":"<uuid>","event_type":"note","summary":"what changed","author":"codex"}'
|
||||||
```
|
```
|
||||||
|
If workplan files were modified, ensure the local copy is up to date first,
|
||||||
|
then sync from the repo checkout:
|
||||||
|
```bash
|
||||||
|
git pull --ff-only
|
||||||
|
statehub fix-consistency
|
||||||
|
```
|
||||||
|
For repos where implementation runs on a remote machine (e.g. CoulombCore),
|
||||||
|
use the pull-before-fix mode from any shell with the State Hub CLI:
|
||||||
|
```bash
|
||||||
|
statehub fix-consistency --repo core-hub --remote
|
||||||
|
```
|
||||||
|
**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.
|
||||||
|
|
|
||||||
|
|
@ -1,34 +1,35 @@
|
||||||
## Workplan Convention (ADR-001)
|
## Workplan Convention (ADR-001)
|
||||||
|
|
||||||
File location: `workplans/REPO-WP-NNNN-<slug>.md`
|
File location: `workplans/CORE-WP-NNNN-<slug>.md`
|
||||||
ID prefix: `REPO-WP-`
|
ID prefix: `CORE-WP-`
|
||||||
|
|
||||||
Work items originate as files in this repo **before** being registered in the hub.
|
Work items originate as files in this repo **before** being registered in the hub.
|
||||||
|
|
||||||
Canonical workplan/workstream frontmatter statuses are:
|
Canonical workplan frontmatter statuses are:
|
||||||
`proposed`, `ready`, `active`, `blocked`, `backlog`, `finished`, `archived`.
|
`proposed`, `ready`, `active`, `blocked`, `backlog`, `finished`, `archived`.
|
||||||
Use `proposed` for a newly drafted plan, `ready` after review against current
|
Use `proposed` for a newly drafted plan, `ready` after review against current
|
||||||
repo state, and `finished` when implementation is complete. `stalled` and
|
repo state, and `finished` when implementation is complete. `stalled` and
|
||||||
`needs_review` are derived health labels, not stored statuses.
|
`needs_review` are derived health labels, not stored statuses.
|
||||||
|
|
||||||
Closed workplans may be moved to `workplans/archived/` with a completion-date
|
Closed workplans may be moved to `workplans/archived/` with a completion-date
|
||||||
prefix: `YYMMDD-REPO-WP-NNNN-<slug>.md`. The frontmatter id remains
|
prefix: `YYMMDD-CORE-WP-NNNN-<slug>.md`. The frontmatter id remains
|
||||||
unchanged; the prefix is only for quick visual reference.
|
unchanged; the prefix is only for quick visual reference.
|
||||||
|
|
||||||
Small opportunistic tasks discovered during another session use **Ad Hoc Tasks**:
|
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
|
`workplans/ADHOC-YYYY-MM-DD.md`, workplan slug `adhoc-YYYY-MM-DD`, and task ids
|
||||||
`ADHOC-YYYY-MM-DD-T01`, `T02`, etc. Use adhocs only for low-risk work completed
|
`ADHOC-YYYY-MM-DD-T01`, `T02`, etc. Use adhocs only for low-risk work completed
|
||||||
directly. Promote anything requiring analysis, design, approval, dependencies, or
|
directly. Promote anything requiring analysis, design, approval, dependencies, or
|
||||||
multiple planned phases into a normal workplan.
|
multiple planned phases into a normal workplan.
|
||||||
|
|
||||||
Ecosystem todos from other agents arrive as `[repo:repo-seed]` hub tasks —
|
Ecosystem todos from other agents arrive as `[repo:core-hub]` hub tasks —
|
||||||
visible at session start. Pick one up by creating the workplan file, then registering
|
visible at session start. Pick one up by creating the workplan file, committing,
|
||||||
the workstream.
|
and running `statehub fix-consistency` — C-06 registers the workplan in the hub.
|
||||||
|
Never register by hand with `create_workplan` (legacy MCP alias: `create_workstream`).
|
||||||
|
|
||||||
Task blocks use this shape:
|
Task blocks use this shape:
|
||||||
|
|
||||||
```task
|
```task
|
||||||
id: REPO-WP-NNNN-T01
|
id: CORE-WP-NNNN-T01
|
||||||
status: wait | todo | progress | done | cancel
|
status: wait | todo | progress | done | cancel
|
||||||
priority: high | medium | low
|
priority: high | medium | low
|
||||||
state_hub_task_id: "<uuid>" # written by fix-consistency — do not edit
|
state_hub_task_id: "<uuid>" # written by fix-consistency — do not edit
|
||||||
|
|
@ -37,4 +38,18 @@ state_hub_task_id: "<uuid>" # written by fix-consistency — do not edit
|
||||||
Status progression is `todo` → `progress` → `done`; use `wait` for waiting or
|
Status progression is `todo` → `progress` → `done`; use `wait` for waiting or
|
||||||
blocked work and `cancel` for stopped work.
|
blocked work and `cancel` for stopped work.
|
||||||
|
|
||||||
|
Workplan frontmatter carries `state_hub_workstream_id` — a legacy field name
|
||||||
|
kept for compatibility; it holds the hub workplan UUID and is written by
|
||||||
|
fix-consistency. Do not edit or rename it.
|
||||||
|
|
||||||
|
### Legacy terminology (compatibility footnote)
|
||||||
|
|
||||||
|
**Workplan** is the fleet term — see
|
||||||
|
`the-custodian/canon/standards/workplan-terminology-fleet_v0.1.md`.
|
||||||
|
**Workstream** is legacy only: some API routes (`/workstreams/`), params
|
||||||
|
(`workstream_id`), MCP aliases (`create_workstream`), and the frontmatter field
|
||||||
|
above remain until `STATE-WP-0069` retires them via legacy-meter. Treat those
|
||||||
|
identifiers as workplan IDs. Prefer `GET /workplans/` and `workplan_id` in new
|
||||||
|
examples and scripts.
|
||||||
|
|
||||||
<!-- Ralph Loop rules and HEUREKA sequence: ~/.claude/CLAUDE.md — do not duplicate here -->
|
<!-- Ralph Loop rules and HEUREKA sequence: ~/.claude/CLAUDE.md — do not duplicate here -->
|
||||||
|
|
|
||||||
157
AGENTS.md
157
AGENTS.md
|
|
@ -1,8 +1,8 @@
|
||||||
# Core Hub - Agent Instructions
|
# core-hub — Agent Instructions
|
||||||
|
|
||||||
## Repo Identity
|
## Repo Identity
|
||||||
|
|
||||||
**Purpose:** 3rd-generation production interaction framework for Coulomb / Helixforge. Reimagines and replaces the 2nd-generation Inter-Hub framework goals on a practical contract-first Python/FastAPI/Postgres platform.
|
**Purpose:** Core Hub is the 3rd-generation production interaction and coordination framework for Coulomb / Helixforge, intended to supersede the 1st-generation state-hub and 2nd-generation inter-hub infrastructure.
|
||||||
|
|
||||||
**Domain:** infotech
|
**Domain:** infotech
|
||||||
**Repo slug:** core-hub
|
**Repo slug:** core-hub
|
||||||
|
|
@ -13,29 +13,42 @@
|
||||||
|
|
||||||
## State Hub Integration
|
## State Hub Integration
|
||||||
|
|
||||||
The Custodian State Hub tracks work across all domains. Interact via HTTP REST - there is no MCP server for Codex agents.
|
The Custodian State Hub tracks work across all domains. Interact via HTTP REST —
|
||||||
|
there is no MCP server for Codex agents.
|
||||||
|
|
||||||
| Context | URL |
|
| Context | URL |
|
||||||
|---------|-----|
|
|---------|-----|
|
||||||
| Local workstation | `http://127.0.0.1:8000` |
|
| Local workstation | `http://127.0.0.1:8000` |
|
||||||
| Remote via tunnel | `http://127.0.0.1:18000` |
|
| Remote via tunnel | `http://127.0.0.1:18000` |
|
||||||
|
| Optional local edge relay | http://127.0.0.1:18080 |
|
||||||
|
|
||||||
|
When an operator has enabled the edge relay, set API_BASE to the relay URL.
|
||||||
|
Queueable writes return an explicit queued receipt if the central hub is
|
||||||
|
unreachable. Treat that as pending local evidence, then ask the operator to run
|
||||||
|
statehub outbox status/replay after connectivity returns.
|
||||||
|
|
||||||
### Orient at session start
|
### Orient at session start
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# Offline brief — works without hub connection
|
||||||
cat .custodian-brief.md
|
cat .custodian-brief.md
|
||||||
curl -s "http://127.0.0.1:8000/workstreams/?topic_id=cee7bedf-2b48-46ef-8601-006474f2ad7a&status=active" | python3 -m json.tool
|
|
||||||
curl -s "http://127.0.0.1:8000/messages/?to_agent=core-hub&unread_only=true" | python3 -m json.tool
|
# Active workplans for this domain
|
||||||
|
curl -s "http://127.0.0.1:8000/workplans/?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=core-hub&unread_only=true" \
|
||||||
|
| python3 -m json.tool
|
||||||
```
|
```
|
||||||
|
|
||||||
Mark a message read:
|
Mark a message read:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -s -X PATCH "http://127.0.0.1:8000/messages/<id>/read" \
|
curl -s -X PATCH "http://127.0.0.1:8000/messages/<id>/read" \
|
||||||
-H "Content-Type: application/json" -d '{}'
|
-H "Content-Type: application/json" -d '{}'
|
||||||
```
|
```
|
||||||
|
|
||||||
### Log progress at session close
|
### Log progress (required at session close)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -s -X POST http://127.0.0.1:8000/progress/ \
|
curl -s -X POST http://127.0.0.1:8000/progress/ \
|
||||||
|
|
@ -44,12 +57,12 @@ curl -s -X POST http://127.0.0.1:8000/progress/ \
|
||||||
"summary": "what was done",
|
"summary": "what was done",
|
||||||
"event_type": "note",
|
"event_type": "note",
|
||||||
"author": "codex",
|
"author": "codex",
|
||||||
"workstream_id": "<uuid>",
|
"workplan_id": "<uuid>",
|
||||||
"task_id": "<uuid>"
|
"task_id": "<uuid>"
|
||||||
}'
|
}'
|
||||||
```
|
```
|
||||||
|
|
||||||
Omit `workstream_id` / `task_id` when not applicable.
|
Omit `workplan_id` / `task_id` when not applicable.
|
||||||
|
|
||||||
### Update task status
|
### Update task status
|
||||||
|
|
||||||
|
|
@ -57,54 +70,115 @@ Omit `workstream_id` / `task_id` when not applicable.
|
||||||
curl -s -X PATCH "http://127.0.0.1:8000/tasks/<task_id>" \
|
curl -s -X PATCH "http://127.0.0.1:8000/tasks/<task_id>" \
|
||||||
-H "Content-Type: application/json" \
|
-H "Content-Type: application/json" \
|
||||||
-d '{"status": "progress"}'
|
-d '{"status": "progress"}'
|
||||||
|
# values: wait | todo | progress | done | cancel
|
||||||
```
|
```
|
||||||
|
|
||||||
Status values: `wait | todo | progress | done | cancel`.
|
### Flag a task for human review
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -s -X PATCH "http://127.0.0.1:8000/tasks/<task_id>" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"needs_human": true, "intervention_note": "reason"}'
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Session Protocol
|
## Session Protocol
|
||||||
|
|
||||||
**Start:**
|
**Start:**
|
||||||
1. `cat .custodian-brief.md` - domain goal and open workstreams.
|
1. `cat .custodian-brief.md` — domain goal and open workplans (offline-safe)
|
||||||
2. Check inbox: `GET /messages/?to_agent=core-hub&unread_only=true`; mark read when acted on.
|
2. Check inbox: `GET /messages/?to_agent=core-hub&unread_only=true`; mark read
|
||||||
3. Scan workplans: `ls workplans/` and inspect `ready`, `active`, or `blocked` files.
|
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` when the work may touch operational gates.
|
4. Check human-needed tasks: `GET /tasks/?needs_human=true`
|
||||||
|
|
||||||
**During work:**
|
**During work:**
|
||||||
- Update workplan files first; State Hub is the read/cache/index layer.
|
- Update task statuses in workplan files as tasks progress
|
||||||
- Record significant decisions via `POST /decisions/` when available.
|
- Record significant decisions via `POST /decisions/`
|
||||||
- Keep secrets out of Git, State Hub, workplans, logs, and chat.
|
|
||||||
|
|
||||||
**Close:**
|
**Close:**
|
||||||
1. Update workplan statuses.
|
1. Update workplan file task statuses to reflect progress
|
||||||
2. From `~/state-hub`, run `make fix-consistency REPO=core-hub` after workplan changes.
|
2. Log: `POST /progress/` with a summary of what changed
|
||||||
3. Log progress with `POST /progress/`.
|
3. After workplan file changes, run:
|
||||||
|
```bash
|
||||||
|
statehub fix-consistency
|
||||||
|
```
|
||||||
|
Coding agents should run this directly; ask the operator only if the CLI or
|
||||||
|
State Hub API is unavailable. This syncs task status from files into the hub DB.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Credential and Access Routing
|
## Credential and access routing
|
||||||
|
|
||||||
Before requesting secrets, API keys, SSH access, login tokens, or database passwords, route the need through ops-warden/OpenBao/key-cape ownership.
|
**Audience:** Codex, Claude Code, Grok, and custodian agents that call **llm-connect**
|
||||||
|
for inference. Run this check **before** requesting secrets, API keys, SSH access,
|
||||||
|
login tokens, or database passwords — in any repo, not only `ops-warden`.
|
||||||
|
|
||||||
|
ops-warden **issues SSH certificates only** (`warden sign`, `cert_command`). Every
|
||||||
|
other credential need belongs to another subsystem. **Do not** message
|
||||||
|
`ops-warden` on State Hub expecting a secret value; the reply is a pointer, not a key.
|
||||||
|
|
||||||
|
### Lookup (do this first)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
warden route find "<describe your need>" --json
|
warden route find "<describe your need>" --json
|
||||||
warden route show <catalog-id> --json
|
warden route show <catalog-id> --json
|
||||||
```
|
```
|
||||||
|
|
||||||
ops-warden issues SSH certificates only. API keys, DB passwords, provider tokens, login/OIDC/MFA, authorization decisions, and OpenBao leases belong to their owning subsystems. Do not paste secrets into Git, State Hub, workplans, logs, or chat.
|
Requires the `warden` CLI from `~/ops-warden` (`uv tool install .` or `uv run warden`).
|
||||||
|
|
||||||
|
| Agent runtime | How to orient |
|
||||||
|
| --- | --- |
|
||||||
|
| **Codex / Grok** (shell, HTTP State Hub) | `warden route` commands above; inbox `to_agent=core-hub` is for coordination, not secret vending |
|
||||||
|
| **Claude Code** (MCP when available) | `get_domain_summary("custodian")` for workplans; **still** use `warden route` for credential ownership |
|
||||||
|
| **llm-connect** (inference service) | Never put secret retrieval in prompts; route custody to OpenBao/operator paths surfaced by `warden route` |
|
||||||
|
|
||||||
|
### Quick routing table
|
||||||
|
|
||||||
|
| I need… | Owner | ops-warden executes? |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| SSH cert (`adm`/`agt`/`atm`) | ops-warden | **Yes** — `warden sign` |
|
||||||
|
| API key, DB password, provider token | OpenBao (`railiance-platform`) | No — route only |
|
||||||
|
| Login / OIDC / MFA | key-cape / Keycloak | No — route only |
|
||||||
|
| Authorization decision | flex-auth | No — route only |
|
||||||
|
| activity-core → issue-core emission | activity-core + issue-core | No — `warden route show activity-core-issue-sink` |
|
||||||
|
| SSH tunnel | ops-bridge (+ `cert_command` from warden) | No — route only |
|
||||||
|
|
||||||
|
### Anti-patterns (do not do these)
|
||||||
|
|
||||||
|
- `POST /messages/` to `ops-warden` asking for `ISSUE_CORE_API_KEY`, `OPENROUTER_API_KEY`, etc.
|
||||||
|
- Inventing `warden secret`, `warden login`, `warden bao`, `warden tunnel` — they do not exist
|
||||||
|
- Pasting secrets into Git, State Hub, workplans, logs, or chat
|
||||||
|
|
||||||
|
### Other capabilities (reuse-surface)
|
||||||
|
|
||||||
|
Non-credential capabilities are usually discovered through **reuse-surface** federation
|
||||||
|
(`reuse-surface` registry / `capability.*` indexes). Credential routing is inlined in
|
||||||
|
every repo's agent instructions because it is high-frequency, high-risk, and easy to
|
||||||
|
get wrong.
|
||||||
|
|
||||||
|
**Canon:** `~/ops-warden/wiki/CredentialRouting.md` · catalog `~/ops-warden/registry/routing/catalog.yaml`
|
||||||
|
|
||||||
|
<!-- REPO-AGENTS-EXTENSIONS -->
|
||||||
|
<!-- Append repo-specific agent instructions below this marker.
|
||||||
|
The state-hub template sync preserves content after this line. -->
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Workplan Convention (ADR-001)
|
## Workplan Convention (ADR-001)
|
||||||
|
|
||||||
Work items originate as files in this repo, not in the hub. The hub rebuilds from files.
|
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/CORE-WP-NNNN-<slug>.md`
|
**File location:** `workplans/CORE-WP-NNNN-<slug>.md`
|
||||||
|
|
||||||
**Archived location:** finished workplans may move to `workplans/archived/YYMMDD-CORE-WP-NNNN-<slug>.md`. The `YYMMDD` prefix is the completion/archive date; the frontmatter `id` does not change.
|
**Archived location:** finished workplans may move to
|
||||||
|
`workplans/archived/YYMMDD-CORE-WP-NNNN-<slug>.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.
|
**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:**
|
**Frontmatter:**
|
||||||
|
|
||||||
|
|
@ -117,26 +191,39 @@ domain: infotech
|
||||||
repo: core-hub
|
repo: core-hub
|
||||||
status: proposed | ready | active | blocked | backlog | finished | archived
|
status: proposed | ready | active | blocked | backlog | finished | archived
|
||||||
owner: codex
|
owner: codex
|
||||||
topic_slug: custodian
|
topic_slug: ...
|
||||||
created: "YYYY-MM-DD"
|
created: "YYYY-MM-DD"
|
||||||
updated: "YYYY-MM-DD"
|
updated: "YYYY-MM-DD"
|
||||||
state_hub_workstream_id: "<uuid>" # written by fix-consistency - do not edit
|
state_hub_workstream_id: "<uuid>" # fix-consistency — do not edit (legacy field name; workplan UUID)
|
||||||
---
|
---
|
||||||
```
|
```
|
||||||
|
|
||||||
Task block format:
|
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.
|
||||||
|
|
||||||
````markdown
|
**Terminology:** workplan is the fleet term; `workstream` appears only in legacy
|
||||||
|
API/MCP/frontmatter bridges until `STATE-WP-0069` retires them — see
|
||||||
|
`the-custodian/canon/standards/workplan-terminology-fleet_v0.1.md`.
|
||||||
|
|
||||||
|
**Task block format** (one per `##` section):
|
||||||
|
|
||||||
|
```
|
||||||
## Task Title
|
## Task Title
|
||||||
|
|
||||||
```task
|
` ` `task
|
||||||
id: CORE-WP-NNNN-T01
|
id: CORE-WP-NNNN-T01
|
||||||
status: wait | todo | progress | done | cancel
|
status: wait | todo | progress | done | cancel
|
||||||
priority: high | medium | low
|
priority: high | medium | low
|
||||||
state_hub_task_id: "<uuid>" # written by fix-consistency - do not edit
|
state_hub_task_id: "<uuid>" # written by fix-consistency — do not edit
|
||||||
```
|
` ` `
|
||||||
|
|
||||||
Task description text.
|
Task description text.
|
||||||
````
|
```
|
||||||
|
|
||||||
Status progression: `todo` -> `progress` -> `done`; use `wait` for waiting/blocked work and `cancel` for stopped work.
|
Status progression: `todo` → `progress` → `done`; use `wait` for waiting/blocked work and `cancel` for stopped work.
|
||||||
|
|
||||||
|
To create a new workplan:
|
||||||
|
1. Write the file following the format above
|
||||||
|
2. Run `statehub fix-consistency` locally; ask the operator only if the CLI or
|
||||||
|
State Hub API is unavailable.
|
||||||
|
|
|
||||||
|
|
@ -1,4 +1,4 @@
|
||||||
# Core Hub - Claude Code Instructions
|
# core-hub — Claude Code Instructions
|
||||||
|
|
||||||
@SCOPE.md
|
@SCOPE.md
|
||||||
@.claude/rules/repo-identity.md
|
@.claude/rules/repo-identity.md
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue