Docs: sync agent-surface docs with actual behavior#1356
Open
r3dbars wants to merge 1 commit into
Open
Conversation
- agent-connect.md: list all 12 MCP tools (list_action_items, list_decisions, digest were missing) and note they need saved summaries - README.md: make the meeting and dictation file examples match the real restyled output (separators, duration format, channel-qualified speaker labels, entry heading shape) - Tools/TranscriptedMCP/CLAUDE.md: fix stale file counts and add the missing AgentCaptureQueryTelemetry source/test files and ToolHandlersTests to the file index - storage-paths.md: changing transcriptSaveLocation does not migrate existing captures; say so instead of implying files move Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01GuGZaFRmNrqfGPpqf7WH4n
This was referenced Jul 2, 2026
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
An audit of the agent-facing surface found four places where the docs describe behavior the code doesn't have (or omit behavior it does have). Agents and users reading these docs get wrong expectations: a tool list missing 3 of 12 tools, a README file example that doesn't match real output, a stale package file map that omits the telemetry module, and relocation wording that implies captures are migrated when they aren't.
Product Impact
docs onlyagent workflowWhat changed
docs/agent-connect.md: capability list now shows all 12 MCP tools —list_action_items,list_decisions,digestwere missing — with a note that the rollup tools only return rows for meetings with saved summaries (linksdocs/cross-meeting-tools.md).README.md: the meeting example now matchesMeetingTranscriptStyler.renderBodyoutput (•separators,32 min, 14 secduration, no thousands separator,turnscount, channel-qualified[System/Sarah]/[Mic/You]labels); the dictation example now matchesDictationTranscriptWriter.dailySection(title in the##heading, metadata lines), marked as trimmed.Tools/TranscriptedMCP/CLAUDE.md: file counts corrected (10 source + 10 test files, not 9/8), and the file index gains the previously missingAgentCaptureQueryTelemetry.swift,AgentCaptureQueryTelemetryTests.swift, andToolHandlersTests.swiftrows.docs/storage-paths.md: changingtranscriptSaveLocationonly affects where new captures are written; existing files are not migrated. The old wording said meetings and dictations "move under the selected folder", whichTranscriptedStoragePreferences.setCaptureLibraryURLdoes not do.How I checked it
scripts/dev/agent-preflight.sh.agents/test-matrix.ymlfor the files changed (docs rule → preflight)bash build.sh --no-open— n/a, docs onlybash run-tests.sh— n/a, docs onlybash run-integration-smoke.sh— n/aswift test— n/a (preflight suggests the MCP package test because its CLAUDE.md changed; no code changed, and this environment has no Swift toolchain — worth a run on a Mac if desired)MeetingTranscriptStyler.swift,DictationTranscriptWriter.swift,AgentCaptureQueryTelemetry.swift,TranscriptedStoragePaths.swift) before editing.Risk Review
.agent-review/visuals/evidence — n/aNotes
First of a series of one-fix-per-PR changes from an agent-surface UX audit. Follow-ups will cover telemetry disclosure in user docs, an MCP
statustool + self-describing empty results, read-path pagination, CLI diagnostics, a capture-format spec withformat_version, and relocation migration.Agent handoff
COORD_DONE: GREEN | (this PR) | synced 4 docs with verified behavior | none | none | agent-preflight.sh | review + merge🤖 Generated with Claude Code
https://claude.ai/code/session_01GuGZaFRmNrqfGPpqf7WH4n
Generated by Claude Code