Skip to content
Agent UI
Tools & reasoningToolResult

Tool Result

Formatted output block for a tool response, with monospace JSON handling.

ToolResult ships with a full API table, a copyable example, and accessibility notes.

tsx
Result
{
  "ok": true,
  "results": 3
}

Installation

Install the package once, then import ToolResult from its direct entry point or from the root.

bash
pnpm add @agent-ui/react
tsx
import { ToolResult } from "@agent-ui/react/tool-result";

Tailwind CSS v4 users: add @source "../node_modules/@agent-ui/react/src" to the global stylesheet so the library utilities are generated.

Usage

The example below is the same code that renders the preview. Copy it, swap in your own handlers, and ship.

tsx
import { ToolResult } from "@agent-ui/react";
 
<ToolResult result={JSON.stringify(data, null, 2)} />

API reference

Every prop ToolResult accepts, its type, default, and behaviour.

API reference for this component
NameTypeDefaultDescription
resultstring—Output to render.
classNamestring—Inherits every native div attribute, including id, aria-*, data-*, onClick, and style.
Use it with the rest of the library

ToolResult composes with MessageList, ChatShell, useChat, and the provider compose blocks. Browse the full reference or see all components in the gallery.

3 lines · copy-ready