docs: add client support status page #738
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| --- | ||
| title: Client Support | ||
| sidebarTitle: Client Support | ||
| description: "Support status and feature availability for Skybridge apps across ChatGPT, Claude, Goose, VSCode, and other MCP clients." | ||
| --- | ||
|
|
||
| Skybridge apps run on two runtimes — **Apps SDK** (ChatGPT) and **MCP Apps** (open spec). This page maps each AI client to its runtime, shows which Skybridge features are available per client, and documents known client-specific behavior. | ||
|
|
||
| ## Client Overview | ||
|
|
||
| | Client | Type | Runtime | Connection | | ||
| |--------|------|---------|------------| | ||
| | **ChatGPT** | General-purpose AI | Apps SDK (`window.openai`) | Public URL required | | ||
| | **Claude** | General-purpose AI | MCP Apps (ext-apps) | Public URL required | | ||
| | **Goose** | Desktop agent | MCP Apps (ext-apps) | Localhost OK | | ||
| | **VSCode** | IDE | MCP Apps (ext-apps) | Localhost OK | | ||
| | **Postman** | API tool | MCP Apps (ext-apps) | Localhost OK | | ||
| | **MCPJam** | MCP inspector | MCP Apps (ext-apps) | Localhost OK | | ||
|
|
||
| <Note> | ||
| Coding agents (Claude Code, Codex CLI, Gemini CLI, Cursor, Amp) implement MCP for tool calling but are headless — they do not render iframes and cannot display views. | ||
| </Note> | ||
|
|
||
| All MCP Apps clients (Claude, Goose, VSCode, and others) share the same feature set because they all implement the same [ext-apps specification](https://github.com/modelcontextprotocol/ext-apps). | ||
|
|
||
| ## Feature Availability by Client | ||
|
|
||
| | Hook / Feature | ChatGPT | Claude | Goose | VSCode | | ||
| |----------------|:-------:|:------:|:-----:|:------:| | ||
| | [useToolInfo](/api-reference/use-tool-info) | ✅ | ✅ | ✅ | ✅ | | ||
| | [useCallTool](/api-reference/use-call-tool) | ✅ | ✅ | ✅ | ✅ | | ||
| | [useSendFollowUpMessage](/api-reference/use-send-follow-up-message) | ✅ | ✅ | ✅ | ✅ | | ||
| | [useOpenExternal](/api-reference/use-open-external) | ✅ | ✅ | ✅ | ✅ | | ||
| | [useLayout](/api-reference/use-layout) | ✅ | ✅ | ✅ | ✅ | | ||
| | [useUser](/api-reference/use-user) | ✅ | ✅ | ✅ | ✅ | | ||
| | [useDisplayMode](/api-reference/use-display-mode) | ✅ | ✅ | ✅ | ✅ | | ||
| | [useViewState](/api-reference/use-view-state) | ✅ | ⚠️ | ⚠️ | ⚠️ | | ||
| | [data-llm](/api-reference/data-llm) | ✅ | ⚠️ | ⚠️ | ⚠️ | | ||
| | [useRequestModal](/api-reference/use-request-modal) | ✅ | ⚠️ | ⚠️ | ⚠️ | | ||
| | [useFiles](/api-reference/use-files) | ✅ | ❌ | ❌ | ❌ | | ||
| | [useSetOpenInAppUrl](/api-reference/use-set-open-in-app-url) | ✅ | ❌ | ❌ | ❌ | | ||
| | [useAppsSdkContext](/api-reference/use-apps-sdk-context) | ✅ | ❌ | ❌ | ❌ | | ||
| | [useMcpAppContext](/api-reference/use-mcp-app-context) | ❌ | ✅ | ✅ | ✅ | | ||
|
Comment on lines
+28
to
+43
Contributor
There was a problem hiding this comment.
The Client Overview table (lines 11–18) lists six clients including Postman and MCPJam, but the Feature Availability matrix only covers four (ChatGPT, Claude, Goose, VSCode). Since both Postman and MCPJam are listed as full MCP Apps clients their feature columns would be identical to Goose/VSCode, but their omission leaves readers uncertain. Either add their columns to the matrix or add a brief note explaining they share the same feature set as other MCP Apps clients. Prompt To Fix With AIThis is a comment left during a code review.
Path: docs/fundamentals/client-support.mdx
Line: 28-43
Comment:
**Postman and MCPJam absent from feature matrix**
The Client Overview table (lines 11–18) lists six clients including Postman and MCPJam, but the Feature Availability matrix only covers four (ChatGPT, Claude, Goose, VSCode). Since both Postman and MCPJam are listed as full MCP Apps clients their feature columns would be identical to Goose/VSCode, but their omission leaves readers uncertain. Either add their columns to the matrix or add a brief note explaining they share the same feature set as other MCP Apps clients.
How can I resolve this? If you propose a fix, please make it concise. |
||
|
|
||
| ## Client-Specific Notes | ||
|
|
||
| ### ChatGPT | ||
|
|
||
| - **Runtime**: Apps SDK (`window.openai`) with MCP Apps compatibility layer | ||
| - **Exclusive features**: `useFiles`, `useSetOpenInAppUrl`, and raw `window.openai` APIs not yet wrapped by Skybridge (`requestCheckout`, `requestClose`, `notifyIntrinsicHeight`) | ||
| - **Tool accessibility**: Tools invoked from a view must set `_meta["openai/widgetAccessible"]: true` | ||
| - **Caching**: ChatGPT aggressively caches views — use [DevTools](/devtools) for iteration and test in ChatGPT only for final validation | ||
| - **Connection**: Requires a public URL. Run `npm run dev --tunnel` during development | ||
|
|
||
| <Note> | ||
| ChatGPT: tools must declare `_meta["openai/widgetAccessible"]: true`; MCP Apps: all tools accessible by default | ||
| </Note> | ||
|
|
||
| ### Claude | ||
|
|
||
| - **Runtime**: MCP Apps (ext-apps spec) | ||
| - **Connection**: Requires a public URL. Run `npm run dev --tunnel` during development | ||
| - **Setup**: **Settings → Connectors → Add Custom Connector**, then enter your `/mcp` URL | ||
|
|
||
| <Note> | ||
| `useViewState` and `data-llm` are polyfilled — state does not persist across view renders. `useRequestModal` is polyfilled — renders in-iframe instead of a host modal. All tools are accessible via `useCallTool` by default. | ||
| </Note> | ||
|
|
||
| ### Goose | ||
|
|
||
| - **Runtime**: MCP Apps (ext-apps spec) | ||
| - **Connection**: Connects directly to `localhost` — no tunnel or public URL needed | ||
| - **Setup**: Point Goose to `http://localhost:3000/mcp` | ||
| - **Note**: Preferred for validating MCP Apps views during development because DevTools only mocks the Apps SDK (ChatGPT) runtime | ||
|
|
||
| <Note> | ||
| `useViewState` and `data-llm` are polyfilled — state does not persist across view renders. `useRequestModal` is polyfilled — renders in-iframe instead of a host modal. All tools are accessible via `useCallTool` by default. | ||
| </Note> | ||
|
|
||
| ### VSCode | ||
|
|
||
| - **Runtime**: MCP Apps (ext-apps spec) | ||
| - **Connection**: Connects directly to `localhost` — no tunnel or public URL needed | ||
| - **Setup**: Point your VSCode MCP config to `http://localhost:3000/mcp` | ||
|
|
||
| <Note> | ||
| `useViewState` and `data-llm` are polyfilled — state does not persist across view renders. `useRequestModal` is polyfilled — renders in-iframe instead of a host modal. All tools are accessible via `useCallTool` by default. | ||
| </Note> | ||
|
|
||
| ## DevTools Runtime Coverage | ||
|
|
||
| DevTools mocks the **Apps SDK runtime only** (mocked `window.openai`). MCP Apps view rendering is not supported in DevTools. | ||
|
|
||
| | Environment | Runtime | | ||
| |-------------|---------| | ||
| | DevTools (localhost) | Apps SDK (ChatGPT) — mocked | | ||
| | ChatGPT | Apps SDK | | ||
| | Claude | MCP Apps | | ||
| | Goose | MCP Apps | | ||
| | VSCode | MCP Apps | | ||
|
|
||
| <Warning> | ||
| Always validate MCP Apps-specific behavior in a real client such as Goose or Claude before shipping. See [Fast Iteration](/concepts/fast-iteration) for the recommended development workflow. | ||
| </Warning> | ||
|
|
||
| ## Related | ||
|
|
||
| - [Apps SDK (ChatGPT)](/fundamentals/apps-sdk) — ChatGPT runtime deep dive | ||
| - [MCP Apps](/fundamentals/mcp-apps) — MCP Apps specification, protocol, and limitations | ||
| - [Test Your App](/quickstart/test-your-app) — Step-by-step setup for each client | ||
| - [API Reference](/api-reference#runtime-compatibility) — Complete hook compatibility matrix | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mcp-apps.mdxfirst. Adding a one-line legend beneath the table header keeps the page self-contained.Prompt To Fix With AI