Aligns the v1 architecture with the longer-horizon platform thesis so we can start implementation without the schema-level inconsistencies the prior review surfaced. ADRs (docs/adr/0001..0006): content-addressed dual-digest storage, append-only event log as source of truth, canonical CBOR manifests, control/data-plane contract, v1 tech stack (Python 3.12 / uv / FastAPI / SQLAlchemy Core + asyncpg / Alembic / cbor2 / blake3 / ruff / mypy / pytest / typer), OCI compatibility kept reachable. Architecture blueprint rewritten to v2: library-first (ffmpeg-shaped) module layout, materialised-view data model over the event log, upload-session and event-stream endpoints pinned, retrieval tiering promoted into the schema. Roadmap added (docs/ROADMAP.md) with three phases. WP-0001 rewritten as the Foundation plan (scaffold + kernels + local FS + minimal app). WP-0002..0005 created carrying the existing state_hub_task_ids forward semantically: ingestion API (T004), retention lifecycle (T005), S3-compatible backend (T006), guide-board pilot (T007). T001/T002/T003/T008 remain in WP-0001 with refined acceptance. README and AGENTS.md refreshed to reflect the new repo shape. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
5.8 KiB
artifact-store — Agent Instructions
Repo Identity
Purpose: Generic artifact registry and storage gateway for generated outputs, evidence packages, reports, logs, snapshots, exports, and release artifacts.
Domain: stack
Repo slug: artifact-store
Topic ID: 595afc64-bd28-47bf-aafb-ba230b28371b
Workplan prefix: ARTIFACT-STORE-WP-
State Hub Integration
The Custodian State Hub tracks work across all domains. Interact via HTTP REST — there is no MCP server for Codex agents.
| Context | URL |
|---|---|
| Local workstation | http://127.0.0.1:8000 |
| Remote via tunnel | http://127.0.0.1:18000 |
Orient at session start
# Offline brief — works without hub connection
cat .custodian-brief.md
# Active workstreams for this domain
curl -s "http://127.0.0.1:8000/workstreams/?topic_id=595afc64-bd28-47bf-aafb-ba230b28371b&status=active" \
| python3 -m json.tool
# Check inbox
curl -s "http://127.0.0.1:8000/messages/?to_agent=artifact-store&unread_only=true" \
| python3 -m json.tool
Mark a message read:
curl -s -X PATCH "http://127.0.0.1:8000/messages/<id>/read" \
-H "Content-Type: application/json" -d '{}'
Log progress (required at session close)
curl -s -X POST http://127.0.0.1:8000/progress/ \
-H "Content-Type: application/json" \
-d '{
"summary": "what was done",
"event_type": "note",
"author": "codex",
"workstream_id": "<uuid>",
"task_id": "<uuid>"
}'
Omit workstream_id / task_id when not applicable.
Update task status
curl -s -X PATCH "http://127.0.0.1:8000/tasks/<task_id>" \
-H "Content-Type: application/json" \
-d '{"status": "in_progress"}'
# values: todo | in_progress | done | blocked
Flag a task for human review
curl -s -X PATCH "http://127.0.0.1:8000/tasks/<task_id>" \
-H "Content-Type: application/json" \
-d '{"needs_human": true, "intervention_note": "reason"}'
Session Protocol
Start:
cat .custodian-brief.md— domain goal and open workstreams (offline-safe)- Check inbox:
GET /messages/?to_agent=artifact-store&unread_only=true; mark read - Scan workplans:
ls workplans/— notestatus: activefiles and open tasks - Check blocked tasks:
GET /tasks/?needs_human=true
During work:
- Update task statuses in workplan files as tasks progress
- Record significant decisions via
POST /decisions/
Close:
- Update workplan file task statuses to reflect progress
- Log:
POST /progress/with a summary of what changed - Note for the custodian operator: after workplan file changes, run from
~/the-custodian/state-hub:This syncs task status from files into the hub DB.make fix-consistency REPO=artifact-store
Workplan Convention (ADR-001)
Work items originate as files in this repo — not in the hub. The hub is a read/cache/index layer that rebuilds from files.
File location: workplans/ARTIFACT-STORE-WP-NNNN-<slug>.md
Archived location: completed workplans may move to
workplans/archived/YYMMDD-ARTIFACT-STORE-WP-NNNN-<slug>.md. The YYMMDD prefix is
the completion/archive date; the frontmatter id does not change.
Ad Hoc Tasks: small opportunistic fixes discovered during a session use
workplans/ADHOC-YYYY-MM-DD.md with task ids ADHOC-YYYY-MM-DD-T01, etc. Use
this only for low-risk work completed directly; create a normal workplan for
anything needing analysis, design, approval, dependencies, or multiple phases.
Frontmatter:
---
id: ARTIFACT-STORE-WP-NNNN
type: workplan
title: "..."
domain: stack
repo: artifact-store
status: active | done
owner: codex
topic_slug: ...
created: "YYYY-MM-DD"
updated: "YYYY-MM-DD"
state_hub_workstream_id: "<uuid>" # written by fix-consistency — do not edit
---
Task block format (one per ## section):
## Task Title
` ` `task
id: ARTIFACT-STORE-WP-NNNN-T01
status: todo | in_progress | done | blocked
priority: high | medium | low
state_hub_task_id: "<uuid>" # written by fix-consistency — do not edit
` ` `
Task description text.
Status progression: todo → in_progress → done (or blocked)
To create a new workplan:
- Write the file following the format above
- Notify the custodian operator to run
make fix-consistency REPO=artifact-store(or send a message to the hub agent viaPOST /messages/)
Current Repo Shape
This repository is in service-baseline planning. The current sources of truth are:
INTENT.md— purpose, product thesis, scope, service boundary.SCOPE.md— lightweight orientation.docs/ARCHITECTURE-BLUEPRINT.md— architecture v2: modules, data model, API shape.docs/PLATFORM-AMBITION.md— longer-horizon thesis and the v1 schema commitments (A1–A9).docs/adr/— architecture decision records ADR-0001 … ADR-0006 (content-addressed storage, event log as source of truth, canonical CBOR manifests, control/data plane contract, v1 tech stack, OCI reachability).docs/ROADMAP.md— workplan sequencing across phases.docs/ASSEMBLY-EXPERIMENT.md— opt-in research line on hand-tuned asm for hot kernels.workplans/ARTIFACT-STORE-WP-0001-service-baseline.md— Foundation workplan; first to start.workplans/ARTIFACT-STORE-WP-{0002..0005}-*.md— planned next workplans.
No runnable service scaffold exists yet. The pinned tech stack is in ADR-0005
(Python 3.12, uv, FastAPI, SQLAlchemy Core + asyncpg/aiosqlite, Alembic,
cbor2, blake3, ruff, mypy, pytest, typer). Add install, dev-server, and test
commands here when ARTIFACT-STORE-WP-0001-T001 lands.
Repo Boundary
This repo owns artifact identity, package/file metadata, storage backend abstraction, retention policy, retrieval metadata, and audit trails.
It does not own StateHub work records, guide-board assessment semantics, formal records-management certification, or producer-specific business logic.