# Components as Tools

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

> **Not available for Langchain DeepAgents yet.** The code on this page comes from the showcase's `gen-ui-tool-based` demo, and Langchain DeepAgents doesn't have it yet. See this page for [CopilotKit's Built-in Agent](/generative-ui/tool-based), [LangGraph (Python)](/langgraph-python/generative-ui/tool-based), [LangGraph (TypeScript)](/langgraph-typescript/generative-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](/deepagents/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](/deepagents/human-in-the-loop). For operational transparency
around a real backend tool, see [Tool rendering](/deepagents/generative-ui/tool-rendering).

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

<Steps>
  <Step>
    ### Wire CopilotKit middleware into your agent

    Deep Agents compile to LangGraph graphs, and `CopilotKitMiddleware` is the
    bridge. It reads the frontend tools from the request. It adds them to the
    tool list that the model sees. Without the middleware, a tool that you
    register with `useFrontendTool` or `useComponent` never reaches the model.

    <Tabs groupId="agent_language" items={['Python', 'TypeScript']} persist>
      <Tab value="Python">
        ```python title="agent.py"
        from deepagents import create_deep_agent
        from copilotkit import CopilotKitMiddleware

        agent = create_deep_agent(
            model="openai:gpt-6-luna",
            tools=[],  # Backend tools go here
            middleware=[CopilotKitMiddleware()],
            system_prompt=SYSTEM_PROMPT,
        )
        ```
      </Tab>
      <Tab value="TypeScript">
        In TypeScript, define your custom state as a middleware with
        `createMiddleware`, and pass it to `createDeepAgent` together with
        `copilotkitMiddleware`:

        ```ts title="agent.ts"
        import { createMiddleware } from "langchain";
        import { copilotkitMiddleware } from "@copilotkit/sdk-js/langgraph";
        import { z } from "zod";

        export const yourStateMiddleware = createMiddleware({
          name: "YourAgentState",
          stateSchema: z.object({
            yourAdditionalProperty: z.string().optional(),
          }),
        });

        // Pass both middlewares when constructing the agent:
        // createDeepAgent({ middleware: [yourStateMiddleware, copilotkitMiddleware], ... })
        ```
      </Tab>
    </Tabs>

    Without the middleware the run still completes, and the tool is never
    called, because the model was never told the tool exists. You do not
    write code to call a frontend tool: the middleware adds it to every model
    call, and the agent calls it like any other tool.

  </Step>
  <Step>
    ### Tell the model when to call it

    The forwarded 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
    `system_prompt` and say what it is for.

    ```python title="agent.py"
    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.

    Keep chat responses brief and let the chart do the talking.
    """
    ```

  </Step>
  <Step>
    ### Register a tool in the browser

    Deep Agents has no live demo on these pages yet, so the demo code below
    does not show for it. Here is a minimal frontend tool to start from. It
    says hello to the user:

    ```tsx title="page.tsx"
    import { z } from "zod";
    import { useFrontendTool } from "@copilotkit/react-core/v2";

    export function Page() {
      // ...

      useFrontendTool({
        name: "sayHello",
        description: "Say hello to the user",
        parameters: z.object({
          name: z.string().describe("The name of the user to say hello to"),
        }),
        handler: async ({ name }) => {
          alert(`Hello, ${name}!`);
          return `Said hello to ${name}!`;
        },
      });

      // ...
    }
    ```

    Ask the agent: `Say hello to Ada.` The browser shows an alert with
    `Hello, Ada!`, and the agent replies after it gets the result.

  </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`:

`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](/deepagents/custom-look-and-feel/headless-ui).

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