chore(state-hub): decouple embedded service tree
This commit is contained in:
16
README.md
16
README.md
@@ -19,13 +19,7 @@ the-custodian/
|
||||
├── memory/ # Operational logs — append-only, never rewritten
|
||||
│ ├── working/ # Session notes (scoped, time-bounded)
|
||||
│ └── episodic/ # Immutable event archive
|
||||
├── state-hub/ # Live state service (the operational brain)
|
||||
│ ├── api/ # FastAPI (PostgreSQL-backed REST + /state/summary)
|
||||
│ ├── mcp_server/ # FastMCP stdio — Claude Code's native interface
|
||||
│ ├── migrations/ # Alembic schema migrations
|
||||
│ ├── dashboard/ # Observable Framework telemetry dashboard
|
||||
│ ├── infra/ # docker-compose.yml (postgres + optional pgadmin)
|
||||
│ └── scripts/ # seed.py, register_project.sh, custodian CLI
|
||||
├── state-hub/ # Pointer only; service source lives at /home/worsch/state-hub
|
||||
├── runtime/ # Agent runtime scaffolding (policies, prompts, adapters)
|
||||
├── infra/ # Deployment, backups, encryption scaffolding
|
||||
└── eval/ # Policy and regression test placeholders
|
||||
@@ -60,7 +54,7 @@ Each domain has three canon artifacts under `canon/projects/<domain>/`:
|
||||
|
||||
## State Hub — Quick Start
|
||||
|
||||
The State Hub is the live operational layer: a PostgreSQL database, a FastAPI REST service, an MCP server for Claude Code, and an Observable dashboard.
|
||||
The State Hub is the live operational layer: a PostgreSQL database, a FastAPI REST service, an MCP server, and an Observable dashboard. Its authoritative implementation now lives in the standalone checkout at `/home/worsch/state-hub`.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
@@ -71,7 +65,7 @@ The State Hub is the live operational layer: a PostgreSQL database, a FastAPI RE
|
||||
### First-time setup
|
||||
|
||||
```bash
|
||||
cd state-hub
|
||||
cd /home/worsch/state-hub
|
||||
|
||||
cp .env.example .env # set POSTGRES_PASSWORD
|
||||
make install # uv sync → Python deps + custodian CLI in .venv
|
||||
@@ -94,7 +88,7 @@ make api # db + migrate + api (restarts if already running)
|
||||
### Dashboard
|
||||
|
||||
```bash
|
||||
cd state-hub
|
||||
cd /home/worsch/state-hub
|
||||
make dashboard # Observable Framework dev server on :3000
|
||||
```
|
||||
|
||||
@@ -134,7 +128,7 @@ It exposes 11 tools and 5 resources directly in every Claude Code session.
|
||||
- Start: `get_state_summary()` — orientation snapshot
|
||||
- End: `add_progress_event()` — append to the immutable log
|
||||
|
||||
Tool reference: `state-hub/mcp_server/TOOLS.md`
|
||||
Tool reference: `/home/worsch/state-hub/mcp_server/TOOLS.md`
|
||||
|
||||
If the MCP server is missing from a session: check `~/.claude/CLAUDE.md` → MCP Server Registration.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user