Tool Call Rendering
Render your agent's tool calls with custom UI components.
What is this?
Tools are how an LLM invokes predefined, typically-deterministic functions. Tool rendering lets you decide how each of those tool calls appears in the chat. Instead of showing raw JSON, you register a Vue component that draws a branded card for the call (arguments, live status, and the eventual result). This is the Generative UI variant CopilotKit calls tool rendering.
When should I use this?
Render tool calls when you want to:
- Show users exactly what tools the agent is invoking and with what arguments
- Display live progress indicators while a tool executes
- Render rich, polished results once a tool completes
- Give tool-heavy agents a transparent, on-brand chat experience
Default tool rendering (zero-config)
The simplest entry point is useDefaultRenderTool() with no arguments. CopilotKit registers its built-in default renderer as the * wildcard: every tool call renders as a status card (tool name, live Running → Done state, collapsible arguments/result) without you writing any UI.
Without this composable, CopilotKit has no * renderer and tool calls are not shown. The user only sees the assistant's final text summary.
<script setup lang="ts">
import { CopilotChat, useDefaultRenderTool } from "@copilotkit/vue/v2";
useDefaultRenderTool();
</script>
<template><CopilotChat /></template>Custom catch-all
Once you want on-brand chrome, pass a render component or function to useDefaultRenderTool. It's a convenience wrapper around useRenderTool({ name: "*", ... }): one wildcard renderer handles every tool call, named or not.
useDefaultRenderTool({ render: BrandedToolCard });Per-tool renderers
The most expressive path is one renderer per tool name. Each renderer receives the tool's parsed arguments, a live status, and, once the agent returns, the result.
-
Write the card component:
src/components/WeatherToolCard.vue <script setup lang="ts"> defineProps<{ parameters: { city?: string }; status: "inProgress" | "executing" | "complete"; result?: string; }>(); </script> <template> <p v-if="status !== 'complete'">Checking {{ parameters.city ?? "…" }}</p> <article v-else> <strong>{{ parameters.city }}</strong> <pre>{{ result }}</pre> </article> </template> -
Register it with
useRenderToolin a component:src/components/AgentExperience.vue <script setup lang="ts"> import { z } from "zod"; import { CopilotChat, useDefaultRenderTool, useRenderTool } from "@copilotkit/vue/v2"; import WeatherToolCard from "./WeatherToolCard.vue"; useRenderTool({ name: "get_weather", parameters: z.object({ city: z.string() }), render: WeatherToolCard, }); useDefaultRenderTool(); // wildcard fallback for every other tool </script> <template><CopilotChat /></template> -
Mount that component under
CopilotKitProvider:src/App.vue <script setup lang="ts"> import { CopilotKitProvider } from "@copilotkit/vue/v2"; import AgentExperience from "./components/AgentExperience.vue"; </script> <template> <CopilotKitProvider runtime-url="/api/copilotkit"><AgentExperience /></CopilotKitProvider> </template>
parameters is partial while arguments stream. Read required fields only after the status advances from inProgress. The result is a string when status is complete; parse it only if your backend deliberately returns a documented serialized shape.
The name you pass to useRenderTool must match the tool name the agent exposes. That is how CopilotKit routes the call to your component.
Per-tool renderers compose with a catch-all: named renderers claim the "interesting" tools and a wildcard handles everything else. The example registers the built-in wildcard after the named get_weather renderer.
If the renderer closes over reactive values, pass Vue watch sources as the second argument:
useRenderTool({ name: "get_weather", parameters, render: WeatherToolCard }, [locale]);The backend tool definition
The frontend renderer only sees what the agent sends down. The matching backend must expose a tool named get_weather, return structured data, and let the frontend renderer with the same name paint the card. The Vue renderer does not create or execute that backend tool.
from __future__ import annotations
import json
from textwrap import dedent
from typing import Annotated
from agent_framework import Agent, BaseChatClient, tool
from agent_framework_ag_ui import AgentFrameworkAgent
from pydantic import Field
# =====================================================================
# Shared tool implementations
# =====================================================================
from tools import (
get_weather_impl,
query_data_impl,
manage_sales_todos_impl,
get_sales_todos_impl,
schedule_meeting_impl,
search_flights_impl,
)
STATE_SCHEMA: dict[str, object] = {
"salesTodos": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {"type": "string"},
"title": {"type": "string"},
"stage": {"type": "string"},
"value": {"type": "number"},
"dueDate": {"type": "string"},
"assignee": {"type": "string"},
"completed": {"type": "boolean"},
},
},
"description": "Ordered list of the user's sales pipeline todos.",
}
}
PREDICT_STATE_CONFIG: dict[str, dict[str, str]] = {
"salesTodos": {
"tool": "manage_sales_todos",
"tool_argument": "todos",
}
}
@tool(
name="manage_sales_todos",
description=(
"Replace the entire list of sales todos with the provided values. "
"Always include every todo you want to keep."
),
)
def manage_sales_todos(
todos: Annotated[
list[dict],
Field(
description=(
"The complete source of truth for the user's sales todos. "
"Maintain ordering and include the full list on each call."
)
),
],
) -> str:
"""Persist the provided set of sales todos."""
result = manage_sales_todos_impl(todos)
return f"Sales todos updated. Tracking {len(result)} item(s)."
@tool(
name="get_sales_todos",
description="Get the current list of sales todos.",
)
def get_sales_todos() -> str:
"""Return the current sales todos or defaults."""
result = get_sales_todos_impl()
return json.dumps(result)
@tool(
name="get_weather",
description="Get the current weather for a location. Use this to render the frontend weather card.",
)
def get_weather(
location: Annotated[
str,
Field(
description="The city or region to describe. Use fully spelled out names."
),
],
) -> str:
"""Return weather data as JSON for UI rendering."""
result = get_weather_impl(location)
return json.dumps(result)
How is this guide?