Files

tegwick c3efb099f1 feat(custodian): add ADR-001 compliance validator

Scripts, Makefile target, and MCP tool for checking a repository
against ADR-001 (workplans as repo artefacts, state-hub as cache).

Checks performed:
  File-side: workplans/ dir exists, valid YAML frontmatter (required
  fields, type, status, id format), filename matches id, embedded
  task blocks have id/status/priority.

  State-hub cross-reference: state_hub_workstream_id references
  resolve to real DB records; orphan detection flags active DB
  workstreams with no backing workplan file.

Usage:
  make validate-adr REPO=<path> [DOMAIN=<slug>]
  validate_repo_adr(repo_path, domain_slug?)  # MCP tool

Running against the-custodian itself correctly surfaces the 4
pre-ADR-001 workstreams that still need workplan files written.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

2026-02-28 12:00:09 +01:00

4.5 KiB

Raw Blame History

State Hub MCP — Tool Reference Card

Quick reference for all tools and resources.

Design Boundary

The State Hub is a read model. It observes and visualises cross-domain state that originates in the projects themselves.

Two write operations are permanently sanctioned:

Use Case	Tools
Resolving Decisions	`resolve_decision()` — decisions are cross-cutting; resolution must propagate across all domains
Suggesting Next Steps	`get_next_steps()` (v0.2) — surface what is unblocked; the domain does the work

All other mutate tools are bootstrap-only: use them during First Session Protocol to give a freshly-registered project its initial workstream structure. Do not use them as a substitute for formal work definition inside the domain repo.

Query Tools (read-only, use freely)

Tool	Key Args	When to use
`get_state_summary()`	—	Session start. Full snapshot: totals, blocking decisions, blocked tasks, open workstreams, last 20 events.
`get_topic(slug)`	`slug`: e.g. `"markitect"`	Deep-dive on one topic + its workstreams + recent events.
`list_blocked_tasks(workstream_id?)`	optional filter	Surface all impediments, optionally scoped to one workstream.
`list_pending_decisions(topic_id?)`	optional filter	Decisions holding up work, sorted by deadline.
`get_recent_progress(limit, since?)`	`limit` default 20; `since` ISO datetime	Reconstruct recent session history.

Sanctioned Write Tools

Tool	Key Args	Notes
`record_decision(title, ...)`	`decision_type`: made/pending; `topic_id?`; `workstream_id?`; `deadline?`	Financial/legal + pending → auto-escalated per constitution §4. At least one of topic_id/workstream_id required.
`resolve_decision(decision_id, rationale, decided_by)`	all required	Marks decision resolved, emits progress event, writes DECISIONS.md to project directory.
`add_progress_event(summary, ...)`	`event_type`: note/milestone/blocker/insight; `topic_id?`; `workstream_id?`; `task_id?`; `detail?`	Append-only log entry. Use at session end.

Bootstrap-Only Tools

Use during First Session Protocol to give a freshly-registered project its initial workstream structure. Do not use for ongoing project management — formal work structure belongs in the domain repo (workplans, requirements, milestones).

Tool	Key Args	Notes
`create_workstream(topic_id, title, ...)`	`slug?`; `owner?`; `description?`; `due_date?`	Creates workstream under a topic. Use `get_state_summary()` to find topic IDs.
`create_task(workstream_id, title, ...)`	`priority`: low/medium/high/critical; `assignee?`; `due_date?`	Creates task under a workstream.
`update_task_status(task_id, status, ...)`	`status`: todo/in_progress/blocked/done/cancelled; `blocking_reason` required when blocked
`update_workstream_status(workstream_id, status)`	`status`: active/blocked/completed/archived

Governance Tools

Tool	Key Args	When to use
`validate_repo_adr(repo_path, domain_slug?)`	`repo_path`: absolute path; `domain_slug?`: for orphan detection	Check a repo against ADR-001. Detects missing workplans/ dir, invalid frontmatter, stale workstream ID references, and DB-only orphan workstreams. Run before and after any workplan changes.

Resources (URI-addressable, read-only)

URI	Returns
`state://summary`	Full StateSummary JSON
`state://topics`	Active topics list
`state://workstreams/{topic_slug}`	Workstreams for a topic (by slug)
`state://decisions/blocking`	All pending decisions
`state://tasks/blocked`	All blocked tasks

Domain Slugs

custodian · railiance · markitect · coulomb-social · personhood · foerster-capabilities

Common Patterns

# Session start:
get_state_summary()

# Decision resolved in the hub UI or via tool:
resolve_decision(decision_id="<uuid>", rationale="...", decided_by="Bernd")

# Session end:
add_progress_event(
    summary="...",
    event_type="note",          # or milestone / insight / blocker
    topic_id="<uuid>",
    workstream_id="<uuid>",     # optional
    detail={"key": "value"},    # optional
)

# First Session Protocol only — bootstrap a new project:
create_workstream(topic_id="<uuid>", title="My Workstream", owner="me")
create_task(workstream_id="<uuid>", title="Do the thing", priority="high")

4.5 KiB Raw Blame History