33 lines
1.2 KiB
Text
33 lines
1.2 KiB
Text
|
# {PROJECT_NAME} — Claude Code Instructions
|
||
|
|
|
||
|
|
## Custodian State Hub Integration
|
||
|
|
|
||
|
|
This project is tracked as the **{DOMAIN}** domain in the Custodian State Hub.
|
||
|
|
Hub topic ID: `{TOPIC_ID}`
|
||
|
|
|
||
|
|
The State Hub runs locally at http://127.0.0.1:8000. The MCP server (`state-hub`)
|
||
|
|
exposes tools for reading and writing state without touching the API directly.
|
||
|
|
|
||
|
|
### Session Protocol
|
||
|
|
|
||
|
|
**At the start of every session:**
|
||
|
|
1. Call `get_state_summary()` — orients you to active workstreams, blocking decisions,
|
||
|
|
and recent progress. If it fails, the API is likely offline:
|
||
|
|
```
|
||
|
|
cd ~/the-custodian/state-hub && make api
|
||
|
|
```
|
||
|
|
2. Review any `blocking_decisions` entries for this project before starting work.
|
||
|
|
|
||
|
|
**During work:**
|
||
|
|
- Use `create_task()` / `update_task_status()` to track concrete deliverables.
|
||
|
|
- Use `record_decision()` for any decision that affects direction or dependencies.
|
||
|
|
- Use `add_progress_event()` for notable events (milestones, blockers, insights).
|
||
|
|
|
||
|
|
**At the end of every session:**
|
||
|
|
- Call `add_progress_event()` with a summary of what was accomplished or decided.
|
||
|
|
Include `topic_id: {TOPIC_ID}` and the relevant `workstream_id`.
|
||
|
|
|
||
|
|
### Quick Reference
|
||
|
|
|
||
|
|
See `~/the-custodian/state-hub/mcp_server/TOOLS.md` for a compact tool reference.
|