MCP Apps
Render interactive UI components from MCP servers directly in your chat interface.
What is this?
MCP Apps are MCP servers that expose tools with associated UI resources. When the agent calls one of these tools, CopilotKit automatically fetches the resource and renders the UI component in the chat. You do not need to write more frontend code.
Key benefits:
- Zero frontend code: UI components are served by the MCP server
- Full interactivity: components can use HTML, CSS, and JavaScript
- Secure sandboxing: content runs in isolated iframes
- Thread persistence: MCP Apps are stored in conversation history and restored on reconnect
Wire the runtime to your MCP server(s)
Add your servers to mcpApps.servers on the runtime. The runtime adds the MCP Apps middleware to every registered agent. When an agent calls a tool that has a UI resource, the middleware gets the resource and sends an activity event. The Vue MCPAppsActivityRenderer shows it in the chat as a sandboxed iframe.
import { CopilotRuntime } from "@copilotkit/runtime/v2";
const runtime = new CopilotRuntime({
agents: { default: agent },
mcpApps: {
servers: [
{
type: "http",
url: "https://mcp.example.com/mcp",
serverId: "support-tools",
},
],
},
});Always pin a serverId
In production, always provide a stable serverId. Without it, CopilotKit
hashes the server URL, and a URL change (for example between environments)
silently breaks restoration of MCP Apps persisted in earlier conversation
threads.
No frontend renderer needed
Unlike custom activity types, the MCP Apps renderer is already registered by CopilotKitProvider. A plain <CopilotChat /> is enough; no manual renderer wiring is required.
<script setup lang="ts">
import { CopilotChat, CopilotKitProvider } from "@copilotkit/vue/v2";
</script>
<template>
<CopilotKitProvider runtime-url="/api/copilotkit">
<main style="height: 100dvh"><CopilotChat /></main>
</CopilotKitProvider>
</template>Ask the agent to use a tool from your MCP server. The tool's UI appears in the chat as an iframe.
Sandbox and widget storage
Each MCP App runs in a sandboxed iframe with an opaque origin. A widget can't
read your page's cookies, storage or DOM. It can't read responses from your
APIs either, unless an API allows cross-origin requests, for example with
Access-Control-Allow-Origin: *. It can still send requests, so protect
state-changing endpoints against cross-site request forgery as you would for
any other site. The trade-off is that the widget can't use localStorage,
sessionStorage, IndexedDB or cookies of its own either.
Requests a widget makes that need CORS, such as <script type="module"> and
fetch, are sent with Origin: null. Serve public widget assets with
Access-Control-Allow-Origin: *. Classic <script src> tags don't need CORS.
To avoid CORS entirely, bundle the widget into a single HTML file, as the
ext-apps examples
do with vite-plugin-singlefile.
The MCP Apps spec pairs allow-same-origin with a sandbox served from a
separate origin. CopilotKit loads the sandbox inline, so it leaves
allow-same-origin off rather than give widgets your page's origin.
If you wrote a widget yourself and it needs storage, you can restore
allow-same-origin:
<script setup lang="ts">
import { CopilotChat, CopilotKitProvider } from "@copilotkit/vue/v2";
</script>
<template>
<CopilotKitProvider
runtime-url="/api/copilotkit"
:mcp-apps="{ allowSameOriginFallback: true }"
>
<CopilotChat />
</CopilotKitProvider>
</template>Only for widgets you trust
With allowSameOriginFallback, every MCP App runs with your page's origin.
Any connected MCP server's widget can then read your cookies and storage and
act as the signed-in user. Don't enable it if you connect third-party MCP
servers.
Transport types
The middleware supports two transport types:
HTTP
Use this format to connect to an MCP server that accepts standard HTTP requests:
{
type: "http",
url: "http://localhost:3101/mcp",
serverId: "my-http-server"
}SSE
Use this format to connect to an MCP server that streams events over a persistent connection:
{
type: "sse",
url: "https://mcp.example.com/sse",
headers: {
"Authorization": "Bearer token"
},
serverId: "my-sse-server"
}Keep credentials on the runtime; do not expose private MCP tokens in Vue code.
Example MCP servers
Try these open-source MCP Apps servers to get started:
- Excalidraw: collaborative whiteboard rendered in-chat
- modelcontextprotocol/ext-apps: canonical reference implementations
Choose your AI backend
LangGraph (Python)
LangGraph (TypeScript)
LangGraph (FastAPI)
Langchain DeepAgents
Google ADK
Mastra
CrewAI Flows
PydanticAI
Google Antigravity
OpenAI Agents SDK (Python)
Claude Agent SDK (Python)
Claude Agent SDK (TypeScript)
Agno
AG2
LlamaIndex
AWS Strands (Python)
AWS Strands (TypeScript)
MS Agent Framework (Python)
MS Agent Framework (.NET)
MS Agent Harness (.NET)
How is this guide?