Initial Central AI Hub docs: brief, rules, README, outline context, architecture
This commit is contained in:
55
docs/outline/04-agent-runbook.md
Normal file
55
docs/outline/04-agent-runbook.md
Normal file
@@ -0,0 +1,55 @@
|
||||
# Central AI Hub — AI Agent Runbook
|
||||
|
||||
> **Writing Style**: ASD-STE100 Simplified Technical English (`ste-writing`).
|
||||
|
||||
## Phase 1 — Prove the Paperclip Round Trip
|
||||
|
||||
This phase has no Hub code. It proves the missing link: a job that leaves and a
|
||||
result that returns.
|
||||
|
||||
### Steps
|
||||
|
||||
1. Create a Paperclip agent API key for this project.
|
||||
- Paperclip board: `http://192.168.20.13:3100`.
|
||||
- Store the key in `~/.config/environment.d/10-secrets.conf` as
|
||||
`PAPERCLIP_API_KEY`. Never commit it.
|
||||
2. File one job with `curl`. Use the issue-create endpoint.
|
||||
3. Confirm the job appears in the Paperclip board.
|
||||
4. Wait for the agent to close the job.
|
||||
5. Send the result to Jervis `POST /announce` so the house speaks it.
|
||||
6. Record the result in this file.
|
||||
|
||||
### Commands
|
||||
|
||||
```bash
|
||||
export PAPERCLIP_API_KEY=<from secrets>
|
||||
curl -s -X POST http://192.168.20.13:3100/api/issues \
|
||||
-H "Authorization: Bearer $PAPERCLIP_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"title":"round-trip test","description":"prove the return path"}'
|
||||
|
||||
# Speak the result.
|
||||
curl -s -X POST http://192.168.20.13:8501/announce \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{"text":"Round trip works."}'
|
||||
```
|
||||
|
||||
### Definition of Done
|
||||
|
||||
- The job appears in Paperclip.
|
||||
- The job closes.
|
||||
- The house speaks the result.
|
||||
- This file records the result.
|
||||
|
||||
## After Phase 1
|
||||
|
||||
Follow the build order in `AGENTS.md`. Do not start a destination before the
|
||||
round trip works.
|
||||
|
||||
## Health Checks
|
||||
|
||||
```bash
|
||||
curl -s http://192.168.20.13:3100/health # Paperclip
|
||||
curl -s http://192.168.20.13:8501/health # Jervis
|
||||
curl -s -o /dev/null -w '%{http_code}\n' http://192.168.20.30:8123/ # HA
|
||||
```
|
||||
Reference in New Issue
Block a user