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
Declare the component as an external tool
Agno's AG-UI interface does not forward the request's tool definitions to
the model. The model only sees tools declared on the Agent, so a
component registered with useComponent needs a matching declaration
whose body stays empty. Mark it external_execution=True: Agno pauses the
run, the browser renders the component, and the run resumes with the
result.
The name and the arguments have to match the useComponent registration
exactly. The docstring is what the model reads, so describe when to call
it there.
from agno.agent import Agent
from agno.models.openai import OpenAIChat
from agno.tools import tool
@tool(external_execution=True)
def render_bar_chart(title: str, data: list[dict]):
"""
Render a bar chart in the chat.
Call this whenever the user asks for a chart or a comparison.
Args:
title (str): A concise chart title.
data (list[dict]): Items shaped `{label, value}`.
"""
agent = Agent(
model=OpenAIChat(id="gpt-6-luna"),
db=db,
tools=[render_bar_chart],
instructions=SYSTEM_PROMPT,
)Give the agent somewhere to store the paused run
Agno stores the paused run before the browser can return its result, so
the Agent that owns the external tool needs a database. An agent with an
external tool and no db cannot resume after the browser answers.
from agno.db.sqlite import SqliteDb
db = SqliteDb(db_file="tmp/agno.db")SqliteDb needs sqlalchemy installed. For production use durable shared
storage such as PgDb, because an ephemeral container file cannot resume a
run on another instance.
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?