docs(roadmap): plan the v0.10.x Guide (MCP server) series [roadmap:v0.10.0] - #64
Merged
Merged
Conversation
…map:v0.10.0] Implements rac/roadmaps/v0.10.x-guide/v0.10.0-guide-foundation.md (planning). Defines RAC Guide: an MCP server (rac mcp) serving repository knowledge to coding agents — stdio, read-only, four tools, in-process Core consumption, verified client onboarding, and a measured grounding demo. Links the Explorer requirement reciprocally into the three-surface product model.
…10.0] Implements rac/roadmaps/v0.10.x-guide/v0.10.0-guide-foundation.md (planning). Adds ADR-029 through ADR-034: delivery surface (rac mcp subcommand, stdio, standard dependency), tools-only four-tool surface, in-process Core consumption, stateless per-call reads, per-response character budget, and the agent reasoning boundary (no conflict-detection tool).
…ap:v0.10.0] Implements rac/roadmaps/v0.10.x-guide/v0.10.0-guide-foundation.md (planning). Pins the agent-facing contract — verbatim tool descriptions, response shapes, error shapes, truncation markers — and specifies the with/without grounding demo: scenario corpus, scripted prompts, 8-of-10 citation gate, and the 90-second recording.
…10.0] Adds rac/roadmaps/v0.10.x-guide/: v0.10.0 (server and four tools), v0.10.1 (onboarding: verified client config and examples corpus), and v0.10.2 (grounding demo, measurement, registry, announcement), each with a pinned implementation contract. Removes rac/roadmaps/future/v1.2-mcp-server.md: its broad tool-per-command sketch is superseded by ADR-030 and this series.
…p:v0.10.0] The agent context surface (RAC Guide, v0.10.x) ships first; Watchkeeper will consume the same Core services and stable contracts later. The capability definition stands unchanged. Also removes a stray trailing code fence.
Current series becomes rac/roadmaps/v0.10.x-guide/ (next up: v0.10.0); the v0.8.x Explorer series is complete through v0.8.10.
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.
Summary
Implements the planning corpus for
rac/roadmaps/v0.10.x-guide/— the roadmap pivot from the Watchkeeper (GitHub Actions) direction to RAC Guide, an MCP server that serves repository knowledge to coding agents.Adds:
rac/requirements/rac-agent-context-guide.md(REQ-001..005:rac mcpstdio server, four tools, in-process Core consumption, verified client onboarding, measured grounding demo)guide-tool-surface(verbatim tool descriptions, response/error/truncation contracts) andguide-grounding-demo(with/without demo protocol, 8-of-10 citation gate, 90-second recording spec)No code under
src/changes in this PR. The artifacts are the implementation contract for the build sessions that follow.Roadmap / ADR Trace
Roadmap:
rac/roadmaps/v0.10.x-guide/v0.10.0-guide-foundation.mdrac/roadmaps/v0.10.x-guide/v0.10.1-guide-onboarding.mdrac/roadmaps/v0.10.x-guide/v0.10.2-guide-grounding-demo.mdNew ADRs:
rac/decisions/adr-029-guide-delivery-surface.md—rac mcpsubcommand, stdio-only, MCP SDK as a standard dependencyrac/decisions/adr-030-guide-tools-only-surface.md— tools only, exactly four; supersedes the broad tool-per-command sketch in the deletedfuture/v1.2-mcp-server.mdstubrac/decisions/adr-031-guide-in-process-core-consumption.md— in-process service imports, read-only by construction, isolation-testedrac/decisions/adr-032-guide-stateless-reads.md— re-read per call, no cache, byte-deterministic responsesrac/decisions/adr-033-guide-response-budget.md— 10k-character cap, whole-item truncation with pinned markersrac/decisions/adr-034-guide-agent-reasoning-boundary.md— no conflict-detection tool; Guide serves facts, the agent reasonsBuilds on: ADR-007 (JSON contract stability), ADR-008 (agent-ready architecture), ADR-015 (consumer pattern), ADR-026 (opaque identities), ADR-028 (surface-decision precedent).
Scope
Included
src/rac/mcp/), public APIs (build_server/run_server), CLI registration and exit codes,mcp>=1.0dependency placement, test files and the newmcpCI batteryto_dict()contracts inrac.servicesExcluded
examples/guide/corpus — v0.10.1Product / Architecture Decisions
archive/already holds v0.9.0–v0.9.3 planning artifacts from the old Explorer numbering; reusing them invites collisions in search and history.get_artifactreturns resolver metadata plus file content: the resolver alone returns no body; content is added at the server layer as the file's stored text. Pinned inguide-tool-surface.get_relatedfilters the repository relationship report at the server boundary: Core has no per-artifact relationship function; filtering is presentation-only, the same line Explorer's adapter holds (ADR-015/031).future/v1.2-mcp-server.mddeleted rather than stubbed: nothing links to it; supersession is recorded in v0.10.0's Context and ADR-030's alternatives.User-Facing Contract
This PR ships no executable behavior. The planned contract it pins, for the record:
CLI (planned, v0.10.0)
Exit Codes (planned)
0: clean server shutdown (client disconnect)2: usage error (--rootis not a directory)JSON Output
No existing CLI or JSON contract changes. Planned tool responses reuse existing
to_dict()shapes (ResolutionResult,SearchResult,PortfolioSummary) withschema_version: "1".Verification
Ran
Covered
tests/test_dogfood.py) passes against the modified live corpustests/test_ingest.pyfails to collect in the CI container due to a pyo3 panic in an optional ingest dependency; verified identical on the untouched tree — pre-existing environment issue, unrelated to this changeReview Path
rac/requirements/rac-agent-context-guide.md— the capability and its five requirementsrac/decisions/adr-029..034— the architecture commitments, in number orderrac/designs/guide-tool-surface.md— the agent-facing contract (descriptions are the product surface)rac/roadmaps/v0.10.x-guide/— the release slicing and implementation contractsrac/designs/guide-grounding-demo.md— the acceptance test for the whole effortfuture/v1.2-mcp-server.mddeletionNotes For Reviewer
guide-tool-surface.mdare pinned verbatim and worth a careful read — they carry the grounding behaviour and are the contract the v0.10.2 measurement protocol tests.search_artifactsbody-text matching and a metadata-onlyget_artifactmode are recorded as open questions in the design, not scope.Implementation Process
Implemented with AI assistance under the roadmap contract. Final scope, review, and acceptance decisions were made by the maintainer.