docs: fill gaps surfaced by developer feedback#563
Open
Conversation
Adds guidance for recurring questions and pitfalls that came up while building Apps against the SDK: patterns.md: - Model vs App data visibility (content/structuredContent/_meta split) - Controlling App height, including the autoResize + 100vh feedback loop - Touch device support (touch-action, horizontal overflow) - localStorage key namespacing across shared sandbox origin - Sharing a single ui:// resource across multiple tools - Conditionally showing UI (two-tool workaround) - Opening external links via app.openLink - color-scheme CSS gotcha that breaks iframe transparency overview.md: - Resource versioning/caching note — template and data may be from different code versions New pages: - design-guidelines.md - troubleshooting.md typedoc.config.mjs wired up to include the two new pages.
Contributor
📖 Docs Preview Deployed
Includes drafts and future-dated posts. All pages served with |
@modelcontextprotocol/ext-apps
@modelcontextprotocol/server-basic-preact
@modelcontextprotocol/server-basic-react
@modelcontextprotocol/server-basic-solid
@modelcontextprotocol/server-basic-svelte
@modelcontextprotocol/server-basic-vanillajs
@modelcontextprotocol/server-basic-vue
@modelcontextprotocol/server-budget-allocator
@modelcontextprotocol/server-cohort-heatmap
@modelcontextprotocol/server-customer-segmentation
@modelcontextprotocol/server-debug
@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: |
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.
Summary
Adds documentation for recurring questions and pitfalls that surfaced while building real Apps:
patterns.md— new sections on model-vs-App data visibility, height control (and theautoResize+100vhloop), touch device support,localStoragenamespacing, sharing oneui://resource across tools, conditionally showing UI,openLink, and thecolor-schemeiframe transparency gotchaoverview.md— note on resource versioning/caching (template and tool result may come from different code versions)design-guidelines.mdandtroubleshooting.md, wired intotypedoc.config.mjsTest plan
npm exec typedoc -- --treatValidationWarningsAsErrors --emit nonepassesnpm run buildgenerates docs without broken{@link}referencespatterns.mdresolve