94 lines
3.0 KiB
Markdown
94 lines
3.0 KiB
Markdown
# HEARTBEAT.md
|
||
|
||
If this file is empty, skip heartbeat work.
|
||
|
||
## Purpose
|
||
This file defines the single, authoritative heartbeat loop. Follow it exactly.
|
||
|
||
## Required inputs
|
||
- BASE_URL (e.g. http://localhost:8000)
|
||
- AUTH_TOKEN (agent token)
|
||
- AGENT_NAME
|
||
- BOARD_ID
|
||
|
||
## Schedule
|
||
- Schedule is controlled by gateway heartbeat config (default: every 10 minutes).
|
||
- On first boot, send one immediate check-in before the schedule starts.
|
||
|
||
## Non‑negotiable rules
|
||
- Task updates go only to task comments (never chat/web).
|
||
- Comments must be markdown and must include: status, summary, details (bullets), next.
|
||
- Every status change must have a comment within 30 seconds.
|
||
- Do not claim a new task if you already have one in progress.
|
||
|
||
## Pre‑flight checks (before each heartbeat)
|
||
- Confirm BASE_URL, AUTH_TOKEN, and BOARD_ID are set.
|
||
- Verify API access:
|
||
- GET $BASE_URL/api/v1/boards must succeed.
|
||
- GET $BASE_URL/api/v1/boards/{BOARD_ID}/tasks must succeed.
|
||
- If any check fails, stop and retry next heartbeat.
|
||
|
||
## Heartbeat checklist (run in order)
|
||
1) Check in:
|
||
```bash
|
||
curl -s -X POST "$BASE_URL/api/v1/agents/heartbeat" \
|
||
-H "X-Agent-Token: $AUTH_TOKEN" \
|
||
-H "Content-Type: application/json" \
|
||
-d '{"name": "'$AGENT_NAME'", "board_id": "'$BOARD_ID'", "status": "online"}'
|
||
```
|
||
|
||
2) List boards:
|
||
```bash
|
||
curl -s "$BASE_URL/api/v1/boards" \
|
||
-H "X-Agent-Token: $AUTH_TOKEN"
|
||
```
|
||
|
||
3) For each board, list tasks:
|
||
```bash
|
||
curl -s "$BASE_URL/api/v1/boards/{BOARD_ID}/tasks" \
|
||
-H "X-Agent-Token: $AUTH_TOKEN"
|
||
```
|
||
|
||
4) If you already have an in_progress task, continue working it and do not claim another.
|
||
|
||
5) If you do NOT have an in_progress task, claim one inbox task:
|
||
- Move it to in_progress AND add a markdown comment with required fields.
|
||
|
||
6) Work the task:
|
||
- Post progress comments as you go.
|
||
- Completion is a two‑step sequence:
|
||
6a) Post the full response as a markdown comment (required fields + response) using:
|
||
POST $BASE_URL/api/v1/boards/{BOARD_ID}/tasks/{TASK_ID}/comments
|
||
6b) Move the task to review.
|
||
|
||
6b) Move the task to "review":
|
||
```bash
|
||
curl -s -X PATCH "$BASE_URL/api/v1/boards/{BOARD_ID}/tasks/{TASK_ID}" \
|
||
-H "X-Agent-Token: $AUTH_TOKEN" \
|
||
-H "Content-Type: application/json" \
|
||
-d '{"status": "review"}'
|
||
```
|
||
|
||
## Definition of Done
|
||
- A task is not complete until the draft/response is posted as a task comment.
|
||
- Comments must be markdown and include: summary, details (bullets), next.
|
||
|
||
## Common mistakes (avoid)
|
||
- Changing status without posting a comment.
|
||
- Posting updates in chat/web instead of task comments.
|
||
- Claiming a second task while one is already in progress.
|
||
- Moving to review before posting the full response.
|
||
|
||
## Success criteria (when to say HEARTBEAT_OK)
|
||
- Check‑in succeeded.
|
||
- Tasks were listed successfully.
|
||
- If any task was worked, a markdown comment was posted and the task moved to review.
|
||
- If any task is inbox or in_progress, do NOT say HEARTBEAT_OK.
|
||
|
||
## Status flow
|
||
```
|
||
inbox -> in_progress -> review -> done
|
||
```
|
||
|
||
Do not say HEARTBEAT_OK if there is inbox work or active in_progress work.
|