* docs(dialog-pattern): add generic entity-dialog spec Introduceert docs/patterns/dialog.md als bron-of-truth voor elke create/edit/detail-dialog in Scrum4Me, ongeacht het achterliggende dataobject. Bevat 14 secties: uitgangspunten, stack, component- architectuur, layout, validatie, drielaagse demo-policy, submission, dialog-gedrag, theming, footer, triggers/URL-state, per-entiteit profile-template, out-of-scope, en een verificatie-checklist. Registreert het patroon in CLAUDE.md "Implementatiepatronen"-tabel zodat Claude (en mensen) de spec verplicht raadplegen voor elke nieuwe dialog. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * docs(dialog-pattern): convert task spec + add pbi/story entity-profiles Reduceert docs/scrum4me-task-dialog.md van 507 naar ~140 regels: alle gedeelde regels verhuisd naar docs/patterns/dialog.md, dit document bevat nu alleen Task-specifieke velden, URL-pattern, status-veld, server actions, triggers en bewuste out-of-scope-keuzes. Voegt twee nieuwe entity-profielen toe voor bestaande dialogen: - docs/scrum4me-pbi-dialog.md (PbiDialog: state-based, code+title-rij, PbiStatusSelect, geen delete in v1) - docs/scrum4me-story-dialog.md (StoryDialog: state-based, header met status/priority badges, inline activity-log, demo-readonly-fallback, inline-delete-confirm i.p.v. AlertDialog) Beide profielen documenteren expliciet de "Bekende gaps t.o.v. generieke spec" zodat opvolgende PR's de afwijkingen kunnen rechtzetten of bewust kunnen accorderen. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * Added pdevelopment docs * docs(plans): add docs-restructure plan for AI-optimized lookup Audit of existing 39 doc files (~10.700 lines) and a phased restructure proposal aimed at minimising the tokens an AI agent has to read to find the right reference. Captures resolved decisions on language (English), ADR template (Nygard default with MADR escape-hatch), index generator (node script), and folder taxonomy. Proposal status — fase 1 to follow. * docs(adr): add ADR scaffolding (templates, README, meta-ADR) Set up docs/adr/ as the canonical home for architecture decisions: - templates/nygard.md — default four-section format (Status, Context, Decision, Consequences) for one-way-door decisions. - templates/madr.md — MADR v4 with YAML front-matter and explicit Considered Options for decisions where rejected alternatives matter. - README.md — naming convention (NNNN-kebab-case), template-selection guidance (Nygard default; MADR for auth, queue mechanics, agent integration), status lifecycle, and ADR roster. - 0000-record-architecture-decisions.md — meta-ADR establishing the practice itself, in Nygard format. Backfilling existing implicit decisions (base-ui-over-radix, float sort_order, demo-user three-layer policy, etc.) is fase 6 of the docs-restructure plan. * feat(docs): add docs index generator + initial INDEX.md scripts/generate-docs-index.mjs walks docs/**/*.md, parses YAML front-matter (or first H1 fallback) and a Nygard-style ## Status section, then writes docs/INDEX.md with grouped tables for ADRs, Specs, Plans (with archive subsection), Patterns, and Other. Pure Node 20 (no external deps); idempotent — running it twice produces byte-identical output. Excludes adr/templates/, the ADR README, INDEX.md itself, and any *_*.md sidecar file. Wire-up: - package.json: docs:index → node scripts/generate-docs-index.mjs Initial run indexed 35 docs across the existing structure; the generated INDEX.md is committed so the table is reviewable in the PR before hooking generation into a pre-commit step. * chore: ignore Obsidian vault and personal sidecar files Add .obsidian/ (Obsidian vault config) and _*.md (personal sidecar notes) to .gitignore so the docs/ tree can serve as canonical source of truth while still being usable as an Obsidian vault for personal authoring. The docs index generator already excludes the same _*.md pattern from INDEX.md. * docs(plans): add PBI bulk-create spec for docs-restructure Machine-parseable spec for an executor that calls the scrum4me MCP (create_pbi → create_story → create_task) to seed the docs-restructure work into the DB. - Section 1 (Context) is the PBI description; serves as task-context via mcp__scrum4me__get_claude_context. - Section 2 lists the 6 resolved decisions (English, MD3+styling merged, solo-paneel merged, .Plans archived, Nygard ADR default, node index script). - Section 3 records what already shipped on this branch so the executor doesn't duplicate the ADR scaffolding or index generator. - Section 4 carries the structured YAML graph: 1 PBI, 8 stories (one per phase), 39 tasks. product_id is REPLACE_ME — fill before running. - YAML validated with PyYAML; field schema sanity-checked. * docs(junk-cleanup): remove stub patterns/test.md * docs(junk-cleanup): archive .Plans/ to docs/plans/archive/ * docs(front-matter): add YAML front-matter to docs/ root * docs(front-matter): add YAML front-matter to patterns/ * docs(front-matter): add YAML front-matter to plans + agent files * docs(index): regenerate INDEX.md after front-matter pass * docs(naming): drop scrum4me- prefix from doc filenames * docs(naming): lowercase API.md and MD3 filenames * docs(naming): rename plan file to kebab-case ASCII * docs(naming): rename middleware.md to proxy.md (next 16) * docs(naming): polish CLAUDE.md doc-index after renames * docs(taxonomy): scaffold topical folders under docs/ * docs(taxonomy): move spec files into docs/specs/ * docs(taxonomy): move design/api/qa/backlog/assets into folders * docs(taxonomy): move agent-instruction-audit into decisions/ * docs(split): break architecture.md into 6 topical files * docs(split): merge solo-paneel-spec into specs/functional.md * docs(split): merge md3-color-scheme into design/styling * docs(trim): extract branch/commit rules into runbook * docs(trim): extract MCP integration into runbook * docs(adr): add 0001-base-ui-over-radix * docs(adr): add 0002-float-sort-order * docs(adr): add 0003-one-branch-per-milestone * docs(adr): add 0004-status-enum-mapping * docs(adr): add 0005-iron-session-over-nextauth * docs(adr): add 0006-demo-user-three-layer-policy * docs(adr): add 0007-claude-question-channel-design * docs(adr): add 0008-agent-instructions-in-claude-md + update README index * docs(index): regenerate after ADR 0001-0008 * docs(glossary): add docs/glossary.md * chore(docs): regenerate INDEX.md in pre-commit hook * docs(readme): link INDEX + glossary + agent instructions * feat(docs): add doc-link checker script * chore(docs): wire docs:check-links and docs npm scripts * ci(docs): block merge on broken doc links * docs(links): fix broken cross-references after restructure --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
154 lines
6.6 KiB
Markdown
154 lines
6.6 KiB
Markdown
---
|
|
title: "Bidirectionele async-comms MCP-agent ↔ user"
|
|
status: active
|
|
audience: [ai-agent, contributor]
|
|
language: nl
|
|
last_updated: 2026-05-03
|
|
when_to_read: "When implementing or extending the claude-question channel for agent-user async communication."
|
|
---
|
|
|
|
# Patroon: Bidirectionele async-comms tussen MCP-agent en interactieve user
|
|
|
|
Het M11 vraag-antwoord-kanaal is herbruikbaar voor elke feature waarbij een
|
|
**autonome agent** (Claude Code via MCP, een Vercel-job, etc.) iets wil
|
|
ophelderen bij de **actieve gebruiker** zonder zelf te blokkeren of te raden.
|
|
|
|
> "Agent stelt vraag → vraag wacht persistent → user beantwoordt op een
|
|
> moment dat het hem uitkomt → agent leest het antwoord en gaat door."
|
|
|
|
Voorbeelden waar dit zou kunnen passen:
|
|
- AI-codereview: Claude vraagt om bevestiging op een controversiële refactor
|
|
- Background-import: queue-worker vraagt om een keuze (overschrijven/skippen)
|
|
per ambigue rij
|
|
- Multi-step migratie: scripted task pauseert op een handmatige bevestiging
|
|
- Approval-flow voor LLM-actions: user keurt een tool-call goed vóór 't echt
|
|
gebeurt
|
|
|
|
---
|
|
|
|
## Vier eindpunten
|
|
|
|
| Endpoint | Auth | Doel |
|
|
|---|---|---|
|
|
| MCP `ask_*` (write) | API-token + demo-blok | maakt rij in `*_questions`-tabel; optioneel `wait_seconds` voor sync polling |
|
|
| MCP `get_*_answer` (read) | API-token | leest huidige status + antwoord (voor latere session-pickup) |
|
|
| `POST /actions/answer` (Server Action) | iron-session + product-membership | atomic `updateMany WHERE status='open'` |
|
|
| `GET /api/realtime/<channel>` (SSE) | iron-session | user-scoped stream, filter op `entity` + product-access |
|
|
|
|
Plus:
|
|
- **Postgres-trigger** op de tabel die `pg_notify` doet op een gedeeld
|
|
channel met een `{op, entity, id, ...}`-payload
|
|
- **Cron-endpoint** dat verlopen rijen markeert (status='expired') zodat
|
|
achterstallige queries niet blijven groeien
|
|
|
|
---
|
|
|
|
## Vier security-uitgangspunten
|
|
|
|
1. **Atomic state-transities.** Antwoord-actie doet één UPDATE met alle
|
|
invarianten in de WHERE (status, expiry, owner-check). Concurrent dubbele
|
|
submit: PostgreSQL row-locking laat één caller count=1 zien, de rest 0.
|
|
2. **Demo-blok op writes.** Agent-side via `requireWriteAccess` (PERMISSION_
|
|
DENIED voor demo-tokens), user-side via early-return op `session.isDemo`
|
|
en disabled-submit-knop met tooltip in de UI.
|
|
3. **Access-isolation in SSE-filter.** Bij connect: query alle accessible
|
|
product-IDs voor deze user → Set. In notification-handler: drop alle
|
|
payloads waarvan `product_id ∉ accessibleSet`. Dit is naast de DB-query-
|
|
filter; redundant maar voorkomt lekkage als de DB-laag iets doorlaat dat
|
|
niet zou moeten.
|
|
4. **Geen gevoelige data in logs.** Payload bevat alleen IDs en status — de
|
|
tekst van vraag en antwoord komt via een aparte authenticated query.
|
|
`console.log` alleen `question_id`, nooit content.
|
|
|
|
---
|
|
|
|
## Channel-strategie: hergebruik vs. eigen kanaal
|
|
|
|
Twee opties bij meerdere realtime-features:
|
|
|
|
| Optie | Voordeel | Nadeel |
|
|
|---|---|---|
|
|
| **Eigen channel per feature** (M10 `scrum4me_pairing`) | Geen filter-leakage tussen features | 1 LISTEN-connectie per feature; meer DB-resources; meer routes |
|
|
| **Gedeeld channel met `entity`-key** (M11 `scrum4me_changes`) | 1 LISTEN per route; nieuwe entity = filter-aanpassing | Vergeten te filteren = leak |
|
|
|
|
Voor M11 is gekozen voor **hergebruik**: één channel scaalt beter naar v2
|
|
(comments, mentions, status-updates allemaal op zelfde stream) en de filter-
|
|
discipline is enforceable in code-review. Mitigatie voor leak-risico: expliciet
|
|
`if (payload.entity === 'X') return false` in elke route die feature X niet
|
|
hoort te zien — zoals `app/api/realtime/solo/route.ts` die `entity:'question'`
|
|
weert.
|
|
|
|
---
|
|
|
|
## TTL-richtlijn
|
|
|
|
- **Question lifetime**: 24 u — kort genoeg dat verlaten queries niet
|
|
ophopen, lang genoeg dat een gebruiker die afwezig is een nacht heeft om
|
|
te antwoorden
|
|
- **MCP-tool wait_seconds**: max 600 s — Claude wacht maximaal 10 min op een
|
|
antwoord; daarna `status: 'pending'` zodat hij later kan terugkomen via
|
|
`get_question_answer`
|
|
- **Cron schedule**: `0 4 * * *` — daily op een rustig tijdstip (Vercel Hobby
|
|
staat alleen daily crons toe; Pro ondersteunt fijnmaziger). 24 u TTL +
|
|
daily cleanup houdt de tabel klein zonder cron-budget te belasten
|
|
|
|
---
|
|
|
|
## Sjabloon-bestanden
|
|
|
|
Specifiek voor M11. Kopieer en pas aan:
|
|
|
|
### Database
|
|
- `prisma/schema.prisma`: model met `id`, `status`, `expires_at`, denormalized
|
|
`product_id` voor SSE-filter, asker/answerer-FKs, json `options?`-veld
|
|
voor multiple-choice
|
|
- `prisma/migrations/<ts>/migration.sql`: tabel-DDL + `notify_*_change()`-
|
|
functie + `AFTER INSERT/UPDATE`-trigger op gedeeld channel
|
|
|
|
### Server (Scrum4Me)
|
|
- `actions/questions.ts`: Server Action met getSession + Zod + demo-blok +
|
|
productAccessFilter + atomic updateMany
|
|
- `app/api/realtime/notifications/route.ts`: user-scoped SSE met
|
|
initial-state-event ná LISTEN actief (race-fix conform M10 ST-1004)
|
|
- `app/api/cron/expire-questions/route.ts`: Bearer-auth via CRON_SECRET +
|
|
updateMany WHERE expires_at<now
|
|
|
|
### Client (Scrum4Me)
|
|
- `stores/notifications-store.ts`: Zustand store met init/upsert/remove +
|
|
selectors voor count en for-you-count
|
|
- `lib/realtime/use-notifications-realtime.ts`: EventSource hook met
|
|
state/message-handlers + reconnect-backoff + Page Visibility pause
|
|
- `components/notifications/notifications-bell.tsx` + `notifications-sheet.tsx`
|
|
+ `answer-modal.tsx`: Bell met badge, slide-over met item-list, Dialog
|
|
met free-text/options-radio
|
|
|
|
### MCP-tools (mcp)
|
|
- `src/tools/ask-user-question.ts`: write-tool met optionele `wait_seconds`-
|
|
polling (intern setInterval tot status verandert of timeout)
|
|
- `src/tools/get-question-answer.ts`: read-tool voor latere session-pickup
|
|
- `src/tools/list-open-questions.ts`: read-tool voor session-start-check
|
|
- `src/tools/cancel-question.ts`: write-tool, asker-only via atomic
|
|
`updateMany WHERE asked_by + status='open'`
|
|
|
|
---
|
|
|
|
## Wanneer dit patroon NIET gebruiken
|
|
|
|
- Wanneer beide kanten al synchroon kunnen werken — dan is een gewone
|
|
fetch/Server-Action eenvoudiger
|
|
- Wanneer realtime niet kritiek is — een korte poll-loop is simpeler dan een
|
|
SSE-stream
|
|
- Wanneer er één centrale beslisser is — gebruik dan een gewone form-flow;
|
|
het patroon hier is voor situaties waar de agent **niet hoeft te wachten**
|
|
op één specifieke gebruiker
|
|
|
|
---
|
|
|
|
## Referenties
|
|
|
|
- Volledige flow + threat-model: `docs/architecture.md` § Vraag-
|
|
antwoord-kanaal Claude ↔ user
|
|
- Endpoint-contract: `docs/api/rest-contract.md` § Notifications + Cron
|
|
- LISTEN/NOTIFY-pattern: `app/api/realtime/solo/route.ts` (M8 ST-802) — zelfde
|
|
ReadableStream + heartbeat + hard-close + abort-cleanup
|
|
- M10 vs M11 keuze tussen eigen/gedeeld kanaal: zie threat-model-tabel
|