# Components as Tools

> Let your agent render rich React components directly in the chat by calling them as tools.

<!-- interactive demo: gen-ui-tool-based -->

## What is this? [#what-is-this]

Tool-based Generative UI is the simplest form of Generative UI: you register
a React component with `useComponent`, and CopilotKit exposes it to the
agent as a tool. When the agent calls the tool, CopilotKit renders your
component inline in the chat, passing the tool's arguments straight through
as typed props.

Unlike [tool rendering](/generative-ui/tool-rendering), which wraps a
real backend tool in a custom UI, tool-based GenUI is the component. There
is no handler, no user interaction, no server-side execution. The agent
decides when to show it, populates the data, and CopilotKit renders it.

## When should I use this? [#when-should-i-use-this]

Use `useComponent` when you want to:

- Display rich UI (cards, charts, tables, dashboards) inline in the chat
- Show structured data the agent has derived from its reasoning
- Render previews, status indicators, or visual summaries
- Let the agent present information beyond plain text

For components that need user interaction, see
[Human-in-the-loop](/human-in-the-loop). For operational transparency
around a real backend tool, see [Tool rendering](/generative-ui/tool-rendering).

## How it works in code [#how-it-works-in-code]

<Steps>
  <Step>
    ### Nothing to wire in config mode

    A `BuiltInAgent` built from configuration merges the request's tool
    definitions into the tool list it hands the model, so the agent declares
    none of its own. A tool registered with `useFrontendTool`, or a component
    registered with `useComponent`, reaches the model by name with no extra
    wiring.

    ```ts title="app/api/copilotkit/[[...slug]]/route.ts"
    import { BuiltInAgent } from "@copilotkit/runtime/v2";

    const builtInAgent = new BuiltInAgent({
      model: "openai:gpt-6-luna",
      prompt: SYSTEM_PROMPT,
    });
    ```

    Keep the `useComponent` name distinct from every tool in `config.tools`.
    The runtime layers the configured tools over the forwarded ones, so a
    shared name resolves to the backend tool and the component never renders.

  </Step>
  <Step>
    ### In factory mode you pass the tools yourself

    A factory owns the model call, so `BuiltInAgent` ignores `config.tools` and
    forwards nothing on your behalf. Read the tools off `input` and pass them
    to the model, or the component never renders.

    ```ts title="app/api/copilotkit/factory.ts"
    import {
      BuiltInAgent,
      convertMessagesToVercelAISDKMessages,
      convertToolsToVercelAITools,
    } from "@copilotkit/runtime/v2";
    import { openai } from "@ai-sdk/openai";
    import { streamText } from "ai";

    const agent = new BuiltInAgent({
      type: "aisdk",
      factory: ({ input, abortSignal }) =>
        streamText({
          model: openai("gpt-6-luna"),
          messages: convertMessagesToVercelAISDKMessages(input.messages),
          tools: convertToolsToVercelAITools(input.tools),
          abortSignal,
        }),
    });
    ```

    The factory owns precedence here. Nothing merges the two lists for you, so
    a backend tool and a `useComponent` registration that share a name is your
    conflict to resolve. Keep the names distinct.

  </Step>
  <Step>
    ### 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 the prompt and say what it is for.

    ```ts title="app/api/copilotkit/prompts.ts"
    export const SYSTEM_PROMPT = `You are a data visualization assistant.

    When the user asks for a chart, call \`render_bar_chart\` with a concise
    title and a \`data\` array of \`{label, value}\` items.

    If the user names a subject but supplies no numbers, invent plausible
    sample values and render the chart on the first turn. Never reply with a
    clarifying question asking for the data.`;
    ```

  </Step>
</Steps>

The built-in agent needs no backend step. Import the hook and Zod in the
component that registers the tool:

```tsx
import { useComponent } from "@copilotkit/react-core/v2";
import { z } from "zod";
```

`useComponent` takes a name, a Zod schema for its props, and the component
to render. The hook registers it as a frontend tool, so the agent can call
it. The schema becomes the tool's parameters, which tell the model which
arguments to send.

<Callout type="warn">
  `parameters` is optional, but leaving it out advertises the tool with an
  empty parameter schema (`{ "type": "object", "properties": {} }`). The model
  then has nothing to fill in, so it calls the tool with no arguments and your
  component renders with no props. Pass a schema for any component that needs
  data.
</Callout>

Define the props of your component as a Zod schema:

```tsx title="bar-chart.tsx"
import { z } from "zod";

export const barChartPropsSchema = z.object({
  title: z.string().describe("Chart title"),
  description: z.string().describe("Brief description or subtitle"),
  data: z.array(
    z.object({
      label: z.string(),
      value: z.number(),
    }),
  ),
});
```

Pass the schema and your component to `useComponent`:

```typescript title="src/app/demos/gen-ui-tool-based/page.tsx"
  useComponent({
    name: "render_bar_chart",
    description: "Display a bar chart with labeled numeric values.",
    parameters: barChartPropsSchema,
    render: BarChart,
  });
```

`BarChart` is your own React component. It reads only its props and can
stream in as the agent fills the payload. The demo builds it with
[Recharts](https://recharts.org). It does not know anything about CopilotKit.

<Callout type="info">
  The `name` you pass to `useComponent` is what the agent sees as the tool
  name. Make it a verb like `render_bar_chart` or `show_weather` so the LLM
  reliably picks it when the user asks for that visualization.
</Callout>

To check it, ask the agent for a bar chart of quarterly sales. The bar chart
renders inline in the chat with the data from the agent.

## Rendering in a headless chat [#rendering-in-a-headless-chat]

CopilotKit's built-in chat components render registered components for you. A
headless or custom chat renders the message list itself, so no tool call
renders unless you render it. The component is registered and the agent
calls it, but the chat stays empty.

Render the tool calls on each assistant message with
`CopilotChatToolCallsView`:

```tsx
import { CopilotChatToolCallsView } from "@copilotkit/react-core/v2";

<CopilotChatToolCallsView message={assistantMessage} messages={allMessages} />;
```

It looks up the sibling `tool`-role message for each tool call and hands both
to the registered renderer. For finer placement, call `useRenderToolCall()` and
render each tool call yourself. See
[Headless UI](/custom-look-and-feel/headless-ui).

<IntegrationGrid path="generative-ui/tool-based" />
