yunxiafei/openclaw-mission-control
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: update documentation to use template variables for BASE_URL and AUTH_TOKEN

Browse Source
This commit is contained in:
Abhimanyu Saharan
2026-02-16 01:25:39 +05:30
parent 47dfc1b52f
commit 1d8039e760
3 changed files with 26 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
backend/templates/BOARD_HEARTBEAT.md.j2
View File

@@ -7,8 +7,8 @@
This file defines the main agent heartbeat. You are not tied to any board.
## Required inputs
- BASE_URL (e.g. http://localhost:8000) - see USER.md or TOOLS.md
- AUTH_TOKEN (agent token) - see USER.md or TOOLS.md
- BASE_URL: `{{ base_url }}`
- AUTH_TOKEN: `{{ auth_token }}`
- AGENT_NAME
- AGENT_ID
@@ -18,7 +18,7 @@ If any required input is missing, stop and request a provisioning update.
Use OpenAPI role tags for main-agent endpoints.
```bash
curl -s "$BASE_URL/openapi.json" -o /tmp/openapi.json
curl -s "{{ base_url }}/openapi.json" -o /tmp/openapi.json
jq -r '
.paths | to_entries[] | .key as $path
| .value | to_entries[]
@@ -31,7 +31,7 @@ jq -r '
## Mission Control Response Protocol
- All outputs must be sent to Mission Control via HTTP.
- Always include: `X-Agent-Token: $AUTH_TOKEN`
- Always include: `X-Agent-Token: {{ auth_token }}`
## Schedule
- If a heartbeat schedule is configured, send a lightweight check-in only.
@@ -71,8 +71,8 @@ Do real work with low noise while sharing useful knowledge across the board.
{% endif %}
## Required Inputs
- `BASE_URL`
- `AUTH_TOKEN`
- `BASE_URL`: `{{ base_url }}`
- `AUTH_TOKEN`: `{{ auth_token }}`
- `AGENT_NAME`
- `AGENT_ID`
- `BOARD_ID`
@@ -83,7 +83,7 @@ If any required input is missing, stop and request a provisioning update.
Use OpenAPI for endpoint/payload details instead of static endpoint assumptions.
```bash
curl -fsS "$BASE_URL/openapi.json" -o /tmp/openapi.json
curl -fsS "{{ base_url }}/openapi.json" -o /tmp/openapi.json
```
When selecting endpoints, prioritize `x-llm-intent`, `x-when-to-use`, and `x-routing-policy`
@@ -127,11 +127,11 @@ jq -r '
- If pre-flight fails due to 5xx/network, do not write memory or task updates.
## Pre-Flight Checks (Every Heartbeat)
1) Confirm `BASE_URL`, `AUTH_TOKEN`, and `BOARD_ID` are set.
1) Confirm `BASE_URL`, `AUTH_TOKEN`, and `BOARD_ID` from `TOOLS.md` match this workspace.
2) Verify API access:
- `GET $BASE_URL/healthz`
- `GET $BASE_URL/api/v1/agent/boards`
- `GET $BASE_URL/api/v1/agent/boards/$BOARD_ID/tasks`
- `GET {{ base_url }}/healthz`
- `GET {{ base_url }}/api/v1/agent/boards`
- `GET {{ base_url }}/api/v1/agent/boards/{{ board_id }}/tasks`
3) If any check fails, stop and retry next heartbeat.
## Shared Context Pull