Refresh agent instruction files
This commit is contained in:
201
AGENTS.md
201
AGENTS.md
@@ -1,65 +1,162 @@
|
||||
# railiance-apps — Codex Instructions
|
||||
# railiance-apps — Agent Instructions
|
||||
|
||||
**OAS Stack Level:** S5 Workloads & Experience Endpoints
|
||||
**Scope:** Application Helm releases and Kubernetes manifests for
|
||||
user-facing services — Gitea, coulomb services, APIs, web frontends.
|
||||
## Repo Identity
|
||||
|
||||
**Pre-condition:** The full stack below must be operational:
|
||||
`railiance-infra` → `railiance-cluster` → `railiance-platform` → `railiance-enablement`
|
||||
**Purpose:** OAS S5 Workloads & Experience Endpoints — application Helm releases, Gitea, coulomb services
|
||||
|
||||
## Custodian State Hub Integration
|
||||
**Domain:** railiance
|
||||
**Repo slug:** railiance-apps
|
||||
**Topic ID:** `ca369340-a64e-442e-98f1-a4fa7dc74a38`
|
||||
**Workplan prefix:** `RAILIANCE-WP-`
|
||||
|
||||
Domain: **railiance** — topic ID: `ca369340-a64e-442e-98f1-a4fa7dc74a38`
|
||||
State Hub: http://127.0.0.1:8000
|
||||
---
|
||||
|
||||
### Session Protocol
|
||||
## State Hub Integration
|
||||
|
||||
**Step 1 — Orient**
|
||||
```
|
||||
get_domain_summary("railiance")
|
||||
```
|
||||
The Custodian State Hub tracks work across all domains. Interact via HTTP REST —
|
||||
there is no MCP server for Codex agents.
|
||||
|
||||
**Step 2 — Scan workplans**
|
||||
```
|
||||
ls workplans/ # read all active workplans; note todo/in_progress tasks
|
||||
```
|
||||
| Context | URL |
|
||||
|---------|-----|
|
||||
| Local workstation | `http://127.0.0.1:8000` |
|
||||
| Remote via tunnel | `http://127.0.0.1:18000` |
|
||||
|
||||
**Step 3 — Present brief**
|
||||
1. Active workstreams for railiance with `[repo:railiance-apps]` tasks
|
||||
2. Pending tasks from local workplans
|
||||
3. Goal guidance from summary (needs_workplan / alignment_warnings)
|
||||
4. Suggested next action
|
||||
### Orient at session start
|
||||
|
||||
**During work:** use `record_decision()`, `add_progress_event()`, `resolve_decision()`.
|
||||
|
||||
**Session close:** `add_progress_event()` with topic_id and workstream_id.
|
||||
|
||||
> Design boundary: hub is read model. Bootstrap tools are First Session
|
||||
> Protocol only. Work originates as files per ADR-001.
|
||||
|
||||
### Repo Boundary Rule (ADR-003)
|
||||
|
||||
This repo owns **S5 Workloads & Experience Endpoints only**. Do not manage:
|
||||
- OS-level concerns → `railiance-infra` (S1)
|
||||
- Kubernetes runtime → `railiance-cluster` (S2)
|
||||
- Platform services → `railiance-platform` (S3)
|
||||
- Developer tooling → `railiance-enablement` (S4)
|
||||
|
||||
Reference: `railiance-infra/docs/adr/ADR-003-railiance-5repo-stack-architecture.md`
|
||||
|
||||
### Workplan Convention (ADR-001)
|
||||
|
||||
File location: `workplans/RAIL-AP-WP-NNNN-<slug>.md`
|
||||
Prefix: `RAIL-AP`
|
||||
|
||||
### SBOM
|
||||
|
||||
After updating dependencies:
|
||||
```bash
|
||||
cd ~/the-custodian/state-hub
|
||||
make ingest-sbom REPO=railiance-apps SCAN=1 REPO_PATH=/home/worsch/railiance-apps
|
||||
# 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=ca369340-a64e-442e-98f1-a4fa7dc74a38&status=active" \
|
||||
| python3 -m json.tool
|
||||
|
||||
# Check inbox
|
||||
curl -s "http://127.0.0.1:8000/messages/?to_agent=railiance-apps&unread_only=true" \
|
||||
| python3 -m json.tool
|
||||
```
|
||||
|
||||
### Quick Reference
|
||||
Mark a message read:
|
||||
```bash
|
||||
curl -s -X PATCH "http://127.0.0.1:8000/messages/<id>/read" \
|
||||
-H "Content-Type: application/json" -d '{}'
|
||||
```
|
||||
|
||||
`~/the-custodian/state-hub/mcp_server/TOOLS.md`
|
||||
### 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=railiance-apps&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=railiance-apps
|
||||
```
|
||||
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/RAILIANCE-WP-NNNN-<slug>.md`
|
||||
|
||||
**Archived location:** finished workplans may move to
|
||||
`workplans/archived/YYMMDD-RAILIANCE-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; create a normal workplan for
|
||||
anything needing analysis, design, approval, dependencies, or multiple phases.
|
||||
|
||||
**Frontmatter:**
|
||||
|
||||
```yaml
|
||||
---
|
||||
id: RAILIANCE-WP-NNNN
|
||||
type: workplan
|
||||
title: "..."
|
||||
domain: railiance
|
||||
repo: railiance-apps
|
||||
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
|
||||
---
|
||||
```
|
||||
|
||||
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: RAILIANCE-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=railiance-apps`
|
||||
(or send a message to the hub agent via `POST /messages/`)
|
||||
|
||||
Reference in New Issue
Block a user