Docs: agent-surface consolidation plan (one binary, one index, one format)#1358
Merged
Merged
Conversation
Design doc for collapsing the five agent-facing surfaces (folder reads, CLI, MCP, sidecar files, loopback preview) into two contracts: one versioned file format and one helper binary reading one app-maintained index. Lays out target architecture, seven independently shippable migration steps, risks, and verification. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GuGZaFRmNrqfGPpqf7WH4n
Owner
Author
|
Merge-room hold: not merging while this PR is still draft. Live state checked 2026-07-02: head |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The agent-surface audit found five overlapping ways to query captures (folder reads, CLI, MCP, sidecar file protocol, loopback preview), three parsers of the same Markdown, two derived indexes, and a four-tier directory resolution order still carrying legacy Draft identity. Consolidating that is too invasive for one unverified change, so this PR lands the plan as a reviewable design doc first.
Product Impact
docs onlyagent workflowWhat changed
docs/agent-surface-consolidation-plan.md: problem statement grounded in current code (startup index rebuilds, hand-mirrored parsers, resolution drift), target architecture (singletranscriptedhelper binary; app-maintained index read by tools; resolution logic only in CaptureKit with the legacy Draft domain on a deprecation clock; one file format onceformat_version+ style-at-save land; live sidecar exposed through the helper instead of prose-driven file polling), seven migration steps, risks, and per-step verification.How I checked it
scripts/dev/agent-preflight.sh.agents/test-matrix.yml(docs rule → preflight)bash build.sh --no-open— n/a, docs onlybash run-tests.sh— n/abash run-integration-smoke.sh— n/aswift test— n/aTools/TranscriptedMCP(startup reconcile, FileWatcher),Tools/TranscriptedCaptureKit/CaptureLibraryResolver.swift, and the app writers.Risk Review
.agent-review/visuals/evidence — n/aNotes
Part of the agent-surface audit series (#1356, #1357, plus in-flight PRs for the MCP
statustool, CLI diagnostics, format spec, and relocation fix). This one is the long-range map; the in-flight PRs are steps 1–2 of it.Agent handoff
COORD_DONE: GREEN | (this PR) | consolidation design doc added | none | agree/adjust target architecture before step 3+ | agent-preflight.sh | review the plan🤖 Generated with Claude Code
https://claude.ai/code/session_01GuGZaFRmNrqfGPpqf7WH4n
Generated by Claude Code