generated from coulomb/repo-seed
tegwick
1a8afaa371
- register_project.sh: parse --additional/--codex as named flags (not positional), skip MCP check in codex mode, generate AGENTS.md from agents-codex.template instead of CLAUDE.md + .claude/rules/ - agents-codex.template: new template for Codex repos — HTTP REST session protocol, inbox/progress curl examples, ADR-001 workplan convention - Makefile: add register-codex-project target Driven by onboarding repo-registry (first non-Claude-Code repo, first repo under the capabilities domain). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
150 lines
3.6 KiB
Plaintext
150 lines
3.6 KiB
Plaintext
# {PROJECT_NAME} — Agent Instructions
|
|
|
|
## Repo Identity
|
|
|
|
**Purpose:** {PROJECT_DESCRIPTION}
|
|
|
|
**Domain:** {DOMAIN}
|
|
**Repo slug:** {REPO_SLUG}
|
|
**Topic ID:** `{TOPIC_ID}`
|
|
**Workplan prefix:** `{WP_PREFIX}-`
|
|
|
|
---
|
|
|
|
## State Hub Integration
|
|
|
|
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={TOPIC_ID}&status=active" \
|
|
| python3 -m json.tool
|
|
|
|
# Check inbox
|
|
curl -s "http://127.0.0.1:8000/messages/?to_agent={REPO_SLUG}&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={REPO_SLUG}&unread_only=true`; mark read
|
|
3. Scan workplans: `ls workplans/` — note `status: active` 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
|
|
`~/the-custodian/state-hub`:
|
|
```bash
|
|
make fix-consistency REPO={REPO_SLUG}
|
|
```
|
|
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/{WP_PREFIX}-NNNN-<slug>.md`
|
|
|
|
**Frontmatter:**
|
|
|
|
```yaml
|
|
---
|
|
id: {WP_PREFIX}-NNNN
|
|
type: workplan
|
|
title: "..."
|
|
domain: {DOMAIN}
|
|
repo: {REPO_SLUG}
|
|
status: active | done
|
|
owner: codex
|
|
topic_slug: ...
|
|
created: "YYYY-MM-DD"
|
|
updated: "YYYY-MM-DD"
|
|
state_hub_workstream_id: "<uuid>" # written by fix-consistency — do not edit
|
|
---
|
|
```
|
|
|
|
**Task block format** (one per `##` section):
|
|
|
|
```
|
|
## Task Title
|
|
|
|
` ` `task
|
|
id: {WP_PREFIX}-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={REPO_SLUG}`
|
|
(or send a message to the hub agent via `POST /messages/`)
|