Files
ersatztv/docs/decisions/records/mcp/server-foundation.md
T
timothy fba5233caf
PR Gates / CI image pin matches docker/ci (pull_request) Successful in 11s
PR Gates / Docs update reminder (pull_request) Successful in 16s
PR Gates / decisions lifecycle (pull_request) Failing after 23s
Build ErsatzTV Image / Formatting (changed .cs conform to .editorconfig) (pull_request) Successful in 1m17s
Build ErsatzTV Image / API docs in sync (OpenAPI + endpoint index) (pull_request) Successful in 1m29s
Build ErsatzTV Image / Build & test (.NET) (pull_request) Successful in 8m5s
Build ErsatzTV Image / EF migration integrity (SQLite + MySql) (pull_request) Successful in 16m5s
Build ErsatzTV Image / Functional E2E (curl + UI contracts) (pull_request) Successful in 17m6s
Build ErsatzTV Image / Build & push image (amd64) (pull_request) Has been skipped
feat(610): split the decision corpus into one YAML-frontmatter file per record
168 records -> docs/decisions/records/<area>/<topic>.md (163 active, 23 dirs) and
docs/decisions/archive/<area>/<topic>.md (5 archived). The filename IS the key,
so one-active-record-per-key becomes a filesystem property rather than a
validator check, and supersession becomes a `git mv`.

WHY: the monolith was a concurrency problem before an aesthetic one. A
3,900-line append target made parallel sessions collide -- PR #605 and PR #614
both hit append-vs-append conflicts during routine rebases, and hand-resolving
those inside the corpus is exactly the operation the rationale-rewrite guard
exists to police.

HOW IT IS VERIFIED: a ~170-file diff cannot be meaningfully read, so correctness
does not rest on reading it. The parser was taught BOTH formats first, so the
body-diff guard parses the old form at the merge-base and the new form at head --
the migration validates itself, no bypass. The proof is a field-level equivalence
harness: 168 records before and after, zero lost, zero gained, zero field
mismatches, zero rationale bodies differing. Reviewers should scrutinise the
harness; it is the actual evidence.

What measuring caught that reading would not have:

- ~500 lines sit OUTSIDE any record -- decisions.md's lifecycle schema and each
  topic file's preamble, mostly the only copy. Source files are kept and
  stripped, never deleted. They also cannot be filed per-area: topic files hold
  several areas and 4 of 23 areas span several files.
- Archive discovery was a non-recursive glob; after the split it found ZERO
  archived records, surfacing as four bogus "supersedes points to unknown key"
  errors rather than an obvious failure.
- ~32 live docs point into the corpus BY DATE, which the split dangles. Each
  stripped file now ends with a generated "Records formerly in this file" index,
  which also rescues the identical breadcrumbs in old issue comments.
- decisions.md's "In this file:" list was 97 same-file anchor bullets that the
  split makes WRONG, not merely stale. Dropped; the generated index replaces
  them with links that resolve.

The equivalence harness now runs against a checked-in FIXTURE, not the live
corpus. The earlier version migrated the real tree, which made it a one-shot:
the moment the migration landed there was nothing left to move and the tests
failed for reasons unrelated to the code. A fixture keeps them testing the
SCRIPT rather than the repo's current state.

Keys preserved verbatim, warts included: `sched` (12) and `scheduling` (1) remain
two directories for one concept. Renaming a key is not a move -- it changes
identity, breaks the equivalence proof, and invalidates MemPalace's per-key
drawers. Taxonomy normalisation is separate work.

refs #610
2026-07-25 19:45:09 +02:00

3.0 KiB
Raw Blame History

key, title, status, since, supersedes, superseded-by, rule, signals, mechanics
key title status since supersedes superseded-by rule signals mechanics
mcp.server-foundation 2026-07-20 — MCP server (`ErsatzTV.Mcp`) built fresh over frozen `/api/v1`: read + cautious writes (#58) active 2026-07-20 none none `ErsatzTV.Mcp` is a fresh stdio JSON-RPC server wrapping frozen `/api/v1` with explicit narrow per-endpoint tools, read-only-by-default enforced at runtime (`ERSATZTV_ALLOW_WRITES`), machine-key auth, and opt-in `If-Match`. MCP server, tool catalog, read-only default, ERSATZTV_ALLOW_WRITES, X-Api-Key, If-Match round-trip · paths: `ErsatzTV.Mcp`, `docs/mcp.md` · issues: #58, #286, #197, #76, #289, #63, #64, #65, #66, #67, #68 `docs/mcp.md`; `ErsatzTV.Mcp` tool executor and catalog

The MCP server (issue #58, gated on #286 route-freeze + #197 security review, both closed) is built fresh as ErsatzTV.Mcp — a stdio JSON-RPC server wrapping /api/v1 — superseding the closed read-only PR #76 rather than rebasing it. Full doc: docs/mcp.md. Decisions frozen:

  • Explicit, narrow tools over a generic HTTP passthrough. Each tool maps to one OpenAPI-backed endpoint; there is no "call any URL" tool. Each declared argument routes to exactly one place — path {param}, an explicit query parameter, the reserved ifMatch header, or (write verbs only) the JSON body — and additionalProperties:false rejects anything undeclared before a request is built.
  • Read-only is the default, enforced at runtime, not just by catalog shape. The executor refuses any non-GET tool unless ERSATZTV_ALLOW_WRITES=true, so one wrong catalog entry cannot mutate. This is the PR #76/#289 posture carried forward verbatim, alongside the JSON-RPC DoS guards (-32700/-32600/-32602/-32603, bounded stdin line reader), the per-request CTS covering headers and the streamed body (the ResponseHeadersRead gotcha, #289), the response-size cap, and the reverse-proxy prefix preservation.
  • Machine-key auth, CSRF-exempt. The server sends X-Api-Key on every request and no X-CSRF header (§9: key-authed requests are CSRF-exempt). ERSATZTV_API_KEY is effectively required.
  • If-Match is opt-in per call, and ETags are surfaced, not managed. Only the replace-all PUTs honor If-Match (here update_collection_custom_order); a response ETag header is appended to the tool result as [etag: "N"] so an agent can round-trip it. All other writes force-write (§7a), so no ETag handshake is needed — notably add_collection_items, whose re-add is an idempotent no-op.
  • Channel create/update is exposed (28-field DTO): only name/number/ffmpegProfileId are required, enums take the enum name and are API-validated, and get_channel makes the shape/current values discoverable. Deferred as too-large for a cautious v0.1 (not a contract gap): the ~40-field schedule-item / playout replace-list writes. Redesign workflow tools (#63#68) stay deferred until their backend endpoints exist. No /api endpoint was added, so no OpenAPI regen.