Repository navigation
Docs drift: mark the MCP client config fence instead of baselining its keys - #58
Merged
Merged
Conversation
…the page, not baselined
The MCP client config example's keys (headers, saturday, transport) were
baseline limit entries. A limit entry goes stale, and fails a backend PR,
as soon as any Go struct gains a tag with that name: fuel-backend #1333's
Gmail response struct tags headers, so its Docs Drift went red and held
it out of the merge queue.
The fence now carries {/* docs-drift: not-api */} and its keys are not
field-checked; endpoints and event names in it still are. The three
entries leave the baseline. A stale field entry names the file its name
now resolves to.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01K7oRCFcRzCtTKYiz8VL19k
Ci-From: linux
Ci-Session: e91a22ea-59f0-4998-92ce-67dd29b5f2cb
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.
What:
check-docs-drift.pyskips the field check for a json fence preceded by an MDX comment{/* docs-drift: not-api */}. The MCP client config example onguides/mcp-integration.mdxcarries it, and its three keys (headers,saturday,transport) leaveapi-drift-baseline.txt.Why: those keys were baseline
limitentries. The field check accepts any Gojson:"..."tag in fuel-backend, so a limit entry goes stale, and fails an unrelated backend PR, the day any struct gains a tag with that name. SaturdayInc/fuel-backend#1333 (the Wahoo 48-hour deletion tool) decodes Gmail's message JSON with ajson:"headers"tag; its Docs Drift went red and the merge queue held it. Marking the fence removes that coupling for these keys: the result no longer depends on fuel-backend's tag set.now known from cmd/wahoo-deletion/intake.go), so the backend author sees the cause.User-visible impact: none. The MDX comment does not render (
mint validatepasses).Verified: checker clean against fuel-backend
mainand againstwahoodel(#1333's head); with the marker removed, all three keys report as drift againstmain; a prose line between marker and fence turns the skip off.crampstays a limit entry: it is a key inside a real API payload, so the fence cannot be skipped.🤖 Generated with Claude Code
https://claude.ai/code/session_01K7oRCFcRzCtTKYiz8VL19k