Repository navigation
docs(mcp): fix page-bridge examples to match the real API - #351
Merged
Merged
Conversation
The MCP guide documented a createAskableMcpPageBridge(ctx, { resourceUri, name })
signature with bridge.destroy()/promptContext()/contextPacket() — none of which
exist. The real API is createAskableMcpPageBridge({ provider }) returning
{ dispose() }. Corrects both the page-bridge and React examples to pass a
provider (via createAskableMcpContextProvider) and replaces the bogus
prompt-vs-structured methods with the actual request-type response table.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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
The MCP guide's page-bridge examples document an API that does not exist:
The real API (verified against
packages/mcp/src/index.ts) takes a single options object with aproviderand returns{ dispose() }— there is noresourceUri/nameoption and nodestroy()/promptContext()/contextPacket()method.Fix
bridge.promptContext()/contextPacket()snippet with an accurate table of how the companion selects output via the requesttype(get_current_context/format_context_for_prompt/read_current_resource).requireRedactedoption.Docs-only; no code changes.
Test plan
vitepress buildclean (no dead links)site/docs/— no remaining references to the non-existent API in source🤖 Generated with Claude Code
Generated by Claude Code