Display components
Register React components that your agent can render in the chat.
What is this?
A display component is a React component that your agent can call as a tool. When the agent calls the tool, CopilotKit renders your component directly in the chat with the tool's arguments as props. You do not write a handler, and the user does not need to do anything.
import { useComponent } from "@copilotkit/react-core/v2";
import { Chart, ChartProps } from "./chart";
useComponent({
name: "showChart",
description: "Populate data and show the user a chart",
parameters: ChartProps,
render: Chart
});
When should I use this?
Use a display component when you want to:
- Display rich UI (cards, charts, tables) inline in the chat
- Show structured data from agent responses
- Render previews, status indicators, or visual feedback
- Let the agent present information beyond plain text
How it works in code
Nothing to wire on the agent
The AG-UI Mastra adapter turns the request's tool definitions into Mastra
client tools and passes them to agent.stream() on every run, so the agent
declares none of its own. Register the component with useComponent and
leave tools to your real backend tools.
import { Agent } from "@mastra/core/agent";
import { openai } from "@ai-sdk/openai";
// `render_bar_chart` is intentionally NOT declared here. It is a
// frontend-only tool registered via `useComponent`, and the adapter
// forwards it as a client tool on every run.
export const chartAgent = new Agent({
id: "chart-agent",
name: "Chart Agent",
model: openai("gpt-6-luna"),
instructions: SYSTEM_PROMPT,
});Tell the model when to call it
This is the part that is easy to miss. The tool arrives on every run, but a
model with no instruction about it will answer in prose and never call it.
Name the tool in instructions and say what it is for.
const SYSTEM_PROMPT = `You are a data visualization assistant.
When the user asks for a chart, call the frontend \`render_bar_chart\` tool
with a concise title and a \`data\` array of \`{label, value}\` items.
Keep chat responses brief and let the chart do the talking.`;The display component receives the tool's arguments as typed props and mounts inline in the chat. Below is the bar chart from the demo. The agent sends the data, and the component draws it.
useComponent({
name: "render_bar_chart",
description: "Display a bar chart with labeled numeric values.",
parameters: barChartPropsSchema,
render: BarChart,
});Ask the agent for a chart, for example Show me a bar chart of quarterly sales for Q1, Q2, Q3, Q4. The chart renders in the chat with the data
that the agent filled in.
Without parameters
For simple components that don't need typed parameters, leave out
parameters. The component then accepts any props:
useComponent({
name: "showGreeting",
render: ({ message }: { message: string }) => (
<div className="rounded border p-3 bg-blue-50">
<p>{message}</p>
</div>
),
});Scoping to an agent
In multi-agent setups, pass agentId to scope a component to one agent:
useComponent({
name: "renderProfile",
parameters: z.object({ userId: z.string() }),
render: ProfileCard,
agentId: "support-agent",
});How is this guide?