Skip to content

Commit 6058caa

Browse files
Reframe docs: MCP Apps primary, MCP-UI compatibility (#84)
* Reframe docs: MCP Apps primary, MCP-UI compatibility - Update ENABLE_MCP_UI section to clearly state MCP Apps is the primary interactive preview investment; MCP-UI maintained for Goose compatibility - Fix incorrect claim that Claude Desktop doesn't support interactive previews — it supports MCP Apps (and has since the ext-apps integration) - Add client compatibility table showing MCP Apps vs MCP-UI vs text URL - Clarify that ENABLE_MCP_UI only controls the MCP-UI UIResource; MCP Apps support is always active Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * Update compatible clients: Goose supports MCP Apps too Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 411f0bc commit 6058caa

1 file changed

Lines changed: 17 additions & 11 deletions

File tree

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1271,25 +1271,31 @@ By default, the server returns generic error messages. With verbose errors enabl
12711271

12721272
#### ENABLE_MCP_UI
12731273

1274-
**MCP-UI Support (Enabled by Default)**
1274+
**Interactive Previews: MCP Apps (primary) & MCP-UI (compatibility)**
12751275

1276-
MCP-UI allows tools that return URLs to also return interactive iframe resources that can be embedded directly in supporting MCP clients. **This is enabled by default** and is fully backwards compatible with all MCP clients.
1276+
This server actively invests in **MCP Apps** as its primary interactive preview protocol, delivering self-contained HTML app panels directly inside the chat. MCP Apps is supported by Claude Desktop, VS Code with GitHub Copilot, and Claude Code — no configuration needed.
1277+
1278+
**MCP-UI** (`@mcp-ui/server`) is also maintained for backwards compatibility with clients like Goose. It is not being removed, but new interactive preview development is focused on MCP Apps.
12771279

12781280
**Supported Tools:**
12791281

1280-
- `preview_style_tool` - Embeds Mapbox style previews
1281-
- `geojson_preview_tool` - Embeds geojson.io visualizations
1282-
- `style_comparison_tool` - Embeds side-by-side style comparisons
1282+
- `preview_style_tool` - Interactive Mapbox style preview panel
1283+
- `geojson_preview_tool` - Interactive GeoJSON visualization panel
1284+
- `style_comparison_tool` - Side-by-side style comparison panel
12831285

1284-
**How it Works:**
1286+
**Client support:**
12851287

1286-
- Tools return **both** a text URL (always works) and a UIResource for iframe embedding
1287-
- Clients that don't support MCP-UI (like Claude Desktop) simply ignore the UIResource and use the text URL
1288-
- Clients that support MCP-UI (like Goose) can render the iframe for a richer experience
1288+
| Client | MCP Apps | MCP-UI |
1289+
| --------------------------- | -------- | ------ |
1290+
| Claude Desktop || |
1291+
| VS Code with GitHub Copilot || |
1292+
| Claude Code || |
1293+
| Goose |||
1294+
| Other clients | | |
12891295

12901296
**Disabling MCP-UI (Optional):**
12911297

1292-
If you want to disable MCP-UI support:
1298+
MCP Apps support is always active. If you want to disable the MCP-UI UIResource (used by Goose):
12931299

12941300
Via environment variable:
12951301

@@ -1303,7 +1309,7 @@ Or via command-line flag:
13031309
node dist/esm/index.js --disable-mcp-ui
13041310
```
13051311

1306-
**Note:** You typically don't need to disable this. The implementation is fully backwards compatible and doesn't affect clients that don't support MCP-UI. See [mcpui.dev](https://mcpui.dev) for compatible clients.
1312+
**Note:** You typically don't need to disable this. All clients receive a usable text URL regardless; interactive previews are a progressive enhancement on top.
13071313

13081314
#### CLIENT_NEEDS_RESOURCE_FALLBACK
13091315

0 commit comments

Comments
 (0)