> ## Documentation Index
> Fetch the complete documentation index at: https://docs-staging.skybridge.tech/llms.txt
> Use this file to discover all available pages before exploring further.
# useToolInfo
> Read the tool call that produced the current view
export const Compat = ({alpic = false, chatgpt = false, claude = false, cursor = false, goose = false, compact = false}) =>
;
`useToolInfo` reads the [tool](/build/tools) call that rendered the current [view](/build/view), so a view can display the data its own tool produced.
Import it from your generated [`helpers.ts`](/api-reference/generate-helpers): the typed hook infers `input`, `output`, and `responseMetadata` from your server, so you pass only the tool name.
## Example
The view reads the result of the tool that rendered it, branching on `status`.
```tsx highlight={4-5,7,8,10,13,15} theme={null}
import { useToolInfo } from "../helpers.js"; // generated, type-safe from server schema
function Carousel() {
const { input, isPending, isSuccess, output, responseMetadata } =
useToolInfo<"search-products">();
if (isPending) {
return
Searching {input?.query}...
;
}
if (isSuccess) {
return (
{output.products.length} results in {responseMetadata.ms}ms
);
}
return null;
}
```
## Type Parameters
### `ToolSignature`
```tsx theme={null}
ToolSignature extends Partial<{
input: Record;
output: Record;
responseMetadata: Record;
}> = Record;
```
Refines the shape of `input`, `output`, and `responseMetadata`. This is the direct-import form; the generated helper takes a tool name instead and infers all three. With neither, each typed field resolves to `never`.
## Returns
### `status`
```tsx theme={null}
status: "pending" | "success";
```
* `"pending"`: the tool's output and metadata have not arrived yet.
* `"success"`: the tool delivered its `output` or its `responseMetadata`.
### `isPending`, `isSuccess`
```tsx theme={null}
isPending: boolean;
isSuccess: boolean;
```
Each is `true` when `status` equals the matching value and `false` otherwise. `isIdle` is also returned but deprecated, always `false`.
### `input`
```tsx theme={null}
input: ToolInput | undefined;
```
The [arguments](/api-reference/register-tool#inputschema-outputschema) the view's tool was called with. The model sees these: they are part of the tool call in the conversation. It can be `undefined` in either state, because the host may render the view before it delivers the arguments.
### `output`
```tsx theme={null}
output: ToolOutput | undefined;
```
The tool's structured output, set when `status` is `"success"`. The model sees this: it is the tool [result](/api-reference/register-tool#return) in the conversation. It is `undefined` while pending, and `undefined` in success if the tool returned no structured output.
### `responseMetadata`
```tsx theme={null}
responseMetadata: ToolResponseMetadata | undefined;
```
The `_meta` the tool's [handler](/api-reference/register-tool#handler) returned alongside its result, typed from your server. It is `undefined` while pending, and `undefined` in success if the tool returned no metadata.
Render a view from a tool result in context
The typed `useToolInfo` that infers from your server
Call another tool from the view