@threadplane/chatFunctionv0.3.4

tools

Collect named client tools into a frozen, name-keyed registry.

The overload is generic over the entire map (const M) so that each tool's precise type (FunctionToolDef<S,R>, ViewToolDef<S,C>, or AskToolDef<S,C>) and every literal key are preserved in the ClientToolRegistry passed to the clientTools input. This lets downstream consumers look up individual tools without losing generic information.

View source View Markdown

import { tools } from '@threadplane/chat';

Declaration · overload 1

export declare function tools<const M extends Record<string, ClientToolDef>>(map: M): Readonly<M>;

Type parameters

M: Record<string, ClientToolDef>

Parameters

map · required: M
An object literal mapping tool names to tool definitions created by action, view, or ask.

Returns

Readonly<M>

A frozen Readonly<M> where M is the exact inferred map shape.

Examples

const move = action('Move a stop', z.object({ fromDay: z.number() }), (a) => a.fromDay);
const dayCard = view('Show a day card', z.object({ label: z.string() }), DayCardComponent);

const registry = tools({ move_stop: move, day_card: dayCard });
// registry.move_stop is FunctionToolDef<...>
// registry.day_card  is ViewToolDef<...>