generated from coulomb/repo-seed
Refresh agent instruction files
This commit is contained in:
209
AGENTS.md
209
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/<id>/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": "<uuid>",
|
||||
"task_id": "<uuid>"
|
||||
}'
|
||||
```
|
||||
|
||||
Omit `workstream_id` / `task_id` when not applicable.
|
||||
|
||||
### Update task status
|
||||
|
||||
```bash
|
||||
curl -s -X PATCH "http://127.0.0.1:8000/tasks/<task_id>" \
|
||||
-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/<task_id>" \
|
||||
-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-<slug>.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-<slug>.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="<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: "<uuid>" # 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: "<uuid>" # 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/`)
|
||||
|
||||
Reference in New Issue
Block a user