diff --git a/docs/src/guide/client/html-resource.md b/docs/src/guide/client/html-resource.md index 1fbe34c8..10090977 100644 --- a/docs/src/guide/client/html-resource.md +++ b/docs/src/guide/client/html-resource.md @@ -11,6 +11,7 @@ export interface HTMLResourceRendererProps { resource: Partial; onUIAction?: (result: UIActionResult) => Promise; style?: React.CSSProperties; + proxy?: string; iframeProps?: Omit, 'src' | 'srcDoc' | 'ref' | 'style'>; } ``` @@ -28,6 +29,7 @@ The component accepts the following props: ``` If you don't provide a callback for a specific type, the default handler will be used. - **`style`**: (Optional) Custom styles for the iframe. +- **`proxy`**: (Optional) A URL to a proxy script. This is useful for hosts with a strict Content Security Policy (CSP). When provided, external URLs will be rendered in a nested iframe hosted at this URL. For example, if `proxy` is `https://my-proxy.com/`, the final URL will be `https://my-proxy.com/?url=`. For your convenience, mcp-ui hosts a proxy script at `https://proxy.mcpui.dev`, which you can use as a the prop value without any setup (see `examples/external-url-demo`). - **`iframeProps`**: (Optional) Custom props for the iframe. ## How It Works @@ -41,6 +43,7 @@ The component accepts the following props: - Ignores comment lines starting with `#` and empty lines - If using `blob`, it decodes it from Base64. - Renders an `