<Tool>

What the model can call. A tool that is not rendered is not in the request (State and conditional tools).

import { Tool } from "curb";

function Tool(props: ToolProps): ReactNode;

Props

Every tool takes these:

Then one of three ways to take input:

onSubmit and onCall return a ToolResult, { ok, message?, data? }, or a promise of one. With schema or fields, more props apply, and confirm holds the tool until the caller agrees:

A handler can refuse its input with ToolInputError.

Example

import { Tool, z } from "curb";

<Tool
  name="open_claim"
  description="Open a claim once the caller has described what happened."
  schema={z.object({ policy: z.string(), what: z.string() })}
  onSubmit={async ({ policy, what }) => {
    const id = await claims.open(policy, what);
    return { ok: true, message: `Claim ${id} is open.` };
  }}
/>

Version history