docs(mcp): correct mcpConfigure(arguments) init-restore claim#4417
Merged
Conversation
The @param arguments roxygen still claimed init args could be read 'via input/bookmark restoration (init)'. That auto-restore path was proven unworkable for MCP (the UI renders at resources/read before args exist) and removed in #4414. Describe the real mechanism instead: a single mcpUpdates() observer applying updateXxxInput(), with the unavoidable open flash noted. Handles the leftover doc correction deferred as a non-goal from #4415's design spec. Regenerated man/mcpConfigure.Rd.
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
1 participant
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.
Handles a documentation correction deferred as a non-goal from the #4415 design spec (the "widget auto-restore doc corrections from #4414" item).
Problem
The
@param argumentsroxygen formcpConfigure()still claimed init args could be read "via input/bookmark restoration (init)." That auto-restore path was proven unworkable for MCP Apps — the UI renders atresources/readbefore the tool-call arguments exist — and was removed in #4414. The stale claim was the only leftover; the other locations (mcp/design-mcpConfigure.md,mcp/limitations.md,mcp/demo-app/app.R, and theR/mcp-session.Rroxygen) were already corrected during #4414.The companion out-of-scope item (the
resourceUri-args init-path spike) is already fully documented inmcp/limitations.md§1 and its summary table, so no change was needed there.Change
R/mcp-config.R: describe the real mechanism — a singlemcpUpdates()observer applyingupdateXxxInput(), fresh instance per tool call, no input/bookmark auto-restore, brief open flash unavoidable — matching the wording already inR/mcp-session.R.man/mcpConfigure.Rd: regenerated.Docs-only. No NEWS entry (
mcpConfigure()is still on the unreleasedmcpfeature branch).