docs: add toolInfo.id alternative for localStorage persistence #427
+46
−0
Conversation
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
Add a simpler alternative to the viewUUID pattern for persisting view state. Uses hostContext.toolInfo.id (the JSON-RPC tool call ID) as the localStorage key, avoiding server-side UUID generation.
![github-code-quality[bot]](https://avatars.githubusercontent.com/u/9919?s=60&v=4){kind=small}
| /** | ||
| * Example: Persisting view state using tool call ID (no server-side UUID needed) | ||
| */ | ||
| function persistViewStateWithToolCallId(app: App) { |
| // Use the tool call ID as a stable localStorage key — no server-side UUID needed | ||
| const toolCallId = String(app.getHostContext()?.toolInfo?.id ?? "default"); | ||
|
|
||
| function saveState<T>(state: T): void { |
| try { localStorage.setItem(toolCallId, JSON.stringify(state)); } catch {} | ||
| } | ||
|
|
||
| function loadState<T>(): T | null { |
@modelcontextprotocol/ext-apps
@modelcontextprotocol/server-basic-react
@modelcontextprotocol/server-basic-vanillajs
@modelcontextprotocol/server-budget-allocator
@modelcontextprotocol/server-cohort-heatmap
@modelcontextprotocol/server-customer-segmentation
@modelcontextprotocol/server-map
@modelcontextprotocol/server-pdf
@modelcontextprotocol/server-scenario-modeler
@modelcontextprotocol/server-shadertoy
@modelcontextprotocol/server-sheet-music
@modelcontextprotocol/server-system-monitor
@modelcontextprotocol/server-threejs
@modelcontextprotocol/server-transcript
@modelcontextprotocol/server-video-resource
@modelcontextprotocol/server-wiki-explorer
commit: |
Member
When would
Is there a risk that apps will break on some platforms if they rely on the presence of |
|
Imo using localstorage for state persistence is not a good recommendation. Ido opened #417 which I think will be the way to go. |
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.
Adds a simpler alternative to the
viewUUIDpattern in the "Persisting view state" section.Instead of generating a UUID server-side and passing it via
_meta.viewUUID, developers can useapp.getHostContext()?.toolInfo.id— the JSON-RPC tool call ID — as the localStorage key directly.When to use this over viewUUID:
toolInfo.idis stable across page reloads (same tool call = same ID)Adds both the
patterns.mddocumentation and the type-checkedpatterns.tsxcode sample.