Files
feature-control/AGENTS.md
2026-06-15 00:42:14 +02:00

6.0 KiB

feature-control — Agent Instructions

Repo Identity

Purpose: Open feature based multi-vendor, multi-tenant, multi-scope feature availability and provisioning engine.

Domain: helix_forge Repo slug: feature-control Topic ID: f39fa2a3-c491-414c-a91b-b4c5fcc6139c Workplan prefix: FEATURE-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=f39fa2a3-c491-414c-a91b-b4c5fcc6139c&status=active" \
  | python3 -m json.tool

# Check inbox
curl -s "http://127.0.0.1:8000/messages/?to_agent=feature-control&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": "progress"}'
# values: wait | todo | progress | done | cancel

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:

  1. cat .custodian-brief.md — domain goal and open workstreams (offline-safe)
  2. Check inbox: GET /messages/?to_agent=feature-control&unread_only=true; mark read
  3. Scan workplans: ls workplans/ — note status: ready, active, or blocked files and open tasks
  4. Check human-needed tasks: GET /tasks/?needs_human=true

During work:

  • Update task statuses in workplan files as tasks progress
  • Record significant decisions via POST /decisions/

Close:

  1. Update workplan file task statuses to reflect progress
  2. Log: POST /progress/ with a summary of what changed
  3. Note for the custodian operator: after workplan file changes, run from ~/state-hub:
    make fix-consistency REPO=feature-control
    
    This syncs task status from files into the hub DB.

Local Developer Workflow

This repository started as documentation- and planning-focused but now includes initial implementation code for the feature-sdk (see WP-0003).

Verification and development commands:

  • Orient and review: cat .custodian-brief.md ; cat INTENT.md SCOPE.md AGENTS.md README.md ; ls workplans/
  • Check hub state (requires local state-hub API): use the curl commands documented in "State Hub Integration" and "Session Protocol" sections above.
  • After any workplan or doc changes: From ~/state-hub checkout, run make fix-consistency REPO=feature-control (syncs markdown task statuses into hub DB, updates brief, populates state_hub_* IDs).
  • Update task status in workplan files (use search_replace or equivalent) then re-run fix-consistency.
  • Log required progress: curl -s -X POST http://127.0.0.1:8000/progress/ ... (see protocol).
  • To verify changes post-fix: Re-cat .custodian-brief.md, re-ls workplans/, re-check task statuses in files vs hub queries, confirm no drift.

Code / SDK (starting with WP-0003):

  • Install dev: pip install -e ".[dev]"
  • Test: pytest
  • Lint/format: ruff check ; ruff format
  • Run example: python docs/sdk-examples/basic_usage.py
  • (The openfeature-sdk is an optional runtime dep for real providers; local provider works without it for tests/dev.)

No full build/run yet (MVP phase). Extend this section as implementation grows.

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/FEATURE-WP-NNNN-<slug>.md

Archived location: finished workplans may move to workplans/archived/YYMMDD-FEATURE-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: FEATURE-WP-NNNN
type: workplan
title: "..."
domain: helix_forge
repo: feature-control
status: proposed | ready | active | blocked | backlog | finished | archived
owner: codex
topic_slug: ...
created: "YYYY-MM-DD"
updated: "YYYY-MM-DD"
state_hub_workstream_id: "<uuid>"   # written by fix-consistency — do not edit
---

Use proposed for a new draft, ready after review against current repo state, and finished after implementation. stalled and needs_review are derived health labels, not frontmatter statuses.

Task block format (one per ## section):

## Task Title

` ` `task
id: FEATURE-WP-NNNN-T01
status: wait | todo | progress | done | cancel
priority: high | medium | low
state_hub_task_id: "<uuid>"         # written by fix-consistency — do not edit
` ` `

Task description text.

Status progression: todoprogressdone; use wait for waiting/blocked work and cancel for stopped work.

To create a new workplan:

  1. Write the file following the format above
  2. Notify the custodian operator to run make fix-consistency REPO=feature-control (or send a message to the hub agent via POST /messages/)