This commit is contained in:
Olivier Chafik 2025-11-24 17:27:06 +00:00
commit c800b34635
No known key found for this signature in database
4 changed files with 22 additions and 17 deletions

View file

@ -30,7 +30,7 @@ This repo provides:
What this repo does NOT provide: What this repo does NOT provide:
- There's no *supported* host implementation in this repo (beyond the [examples/simple-host](./examples/simple-host) example) - There's no _supported_ host implementation in this repo (beyond the [examples/simple-host](./examples/simple-host) example)
- We have [contributed a tentative implementation](https://github.com/MCP-UI-Org/mcp-ui/pull/147) of hosting / iframing / sandboxing logic to the [MCP-UI](https://github.com/idosal/mcp-ui) repository, and expect OSS clients may use it, while other clients might roll their own hosting logic. - We have [contributed a tentative implementation](https://github.com/MCP-UI-Org/mcp-ui/pull/147) of hosting / iframing / sandboxing logic to the [MCP-UI](https://github.com/idosal/mcp-ui) repository, and expect OSS clients may use it, while other clients might roll their own hosting logic.
## Using the SDK ## Using the SDK
@ -70,8 +70,7 @@ Your `package.json` will then look like:
} }
``` ```
### Build tools in dependencies > [!NOTE]
> The build tools (`esbuild`, `tsx`, `typescript`) are in `dependencies` rather than `devDependencies`. This is intentional: it allows the `prepare` script to run when the package is installed from git, since npm doesn't install devDependencies for git dependencies.
The build tools (`esbuild`, `tsx`, `typescript`) are in `dependencies` rather than `devDependencies`. This is intentional: it allows the `prepare` script to run when the package is installed from git, since npm doesn't install devDependencies for git dependencies. >
> Once the package is published to npm with pre-built `dist/`, these can be moved back to `devDependencies`.
Once the package is published to npm with pre-built `dist/`, these can be moved back to `devDependencies`.

View file

@ -95,9 +95,7 @@ export interface AppRendererProps {
* @param props - Component props * @param props - Component props
* @returns React element containing the sandboxed tool UI iframe * @returns React element containing the sandboxed tool UI iframe
*/ */
export const AppRenderer = ( export const AppRenderer = (props: AppRendererProps) => {
props: AppRendererProps,
) => {
const { const {
client, client,
sandboxProxyUrl, sandboxProxyUrl,

View file

@ -5,7 +5,7 @@ import { Client } from "@modelcontextprotocol/sdk/client/index.js";
import { SSEClientTransport } from "@modelcontextprotocol/sdk/client/sse.js"; import { SSEClientTransport } from "@modelcontextprotocol/sdk/client/sse.js";
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"; import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
import { Tool } from "@modelcontextprotocol/sdk/types.js"; import { Tool } from "@modelcontextprotocol/sdk/types.js";
import { AppRenderer,AppRendererProps } from "../src/AppRenderer"; import { AppRenderer, AppRendererProps } from "../src/AppRenderer";
import { AppBridge } from "../../../dist/src/app-bridge"; import { AppBridge } from "../../../dist/src/app-bridge";
const SANDBOX_PROXY_URL = URL.parse("/sandbox.html", location.href)!; const SANDBOX_PROXY_URL = URL.parse("/sandbox.html", location.href)!;
@ -94,16 +94,24 @@ function ExampleApp() {
setActiveTools((prev) => prev.filter((t) => t.id !== id)); setActiveTools((prev) => prev.filter((t) => t.id !== id));
}; };
const handleMessage: AppRendererProps["onmessage"] = async (params, _extra) => { const handleMessage: AppRendererProps["onmessage"] = async (
params,
_extra,
) => {
console.log("[React Host] Message:", params); console.log("[React Host] Message:", params);
return {}; return {};
}; };
const handleLoggingMessage: AppRendererProps["onloggingmessage"] = (params) => { const handleLoggingMessage: AppRendererProps["onloggingmessage"] = (
params,
) => {
console.log("[React Host] Logging message:", params); console.log("[React Host] Logging message:", params);
}; };
const handleOpenLink: AppRendererProps["onopenlink"] = async (params, _extra) => { const handleOpenLink: AppRendererProps["onopenlink"] = async (
params,
_extra,
) => {
console.log("[React Host] Open link request:", params); console.log("[React Host] Open link request:", params);
window.open(params.url, "_blank", "noopener,noreferrer"); window.open(params.url, "_blank", "noopener,noreferrer");
return { isError: false }; return { isError: false };

View file

@ -87,15 +87,15 @@ window.addEventListener("load", async () => {
appBridge.sendToolInput({ arguments: toolInput }); appBridge.sendToolInput({ arguments: toolInput });
}; };
appBridge.onopenlink = async ({url}) => { appBridge.onopenlink = async ({ url }) => {
console.log("[Example] Open link requested:", url); console.log("[Example] Open link requested:", url);
window.open(url, "_blank", "noopener,noreferrer"); window.open(url, "_blank", "noopener,noreferrer");
return {isError: false}; return { isError: false };
}; };
appBridge.onmessage = async (params) => { appBridge.onmessage = async (params) => {
console.log("[Example] Message requested:", params); console.log("[Example] Message requested:", params);
return {isError: false}; return { isError: false };
}; };
// Handle size changes by resizing the iframe // Handle size changes by resizing the iframe
@ -108,7 +108,7 @@ window.addEventListener("load", async () => {
} }
}; };
appBridge.onloggingmessage = async params => { appBridge.onloggingmessage = async (params) => {
console.log("[Tool UI Log]", params); console.log("[Tool UI Log]", params);
}; };