Documentation / @agentick/core / ToolClass

Interface: ToolClass()<TInput>

Defined in: core/src/tool/tool.ts:373

Type Parameters

TInput

TInput = any

ToolClass(props?): ReactElement<unknown, string | JSXElementConstructor<any>> | null

Defined in: core/src/tool/tool.ts:381

Functional component that registers the tool on mount

Parameters

props?

ComponentBaseProps & Partial<Pick<ToolMetadata<any, any>, "type" | "name" | "description" | "providerOptions" | "libraryOptions" | "requiresConfirmation" | "confirmationMessage" | "intent">>

Returns

ReactElement<unknown, string | JSXElementConstructor<any>> | null

Properties

metadata

metadata: ToolMetadata<TInput>

Defined in: core/src/tool/tool.ts:375

Tool metadata (static property)

---

run?

optional run: Procedure<ToolHandler<TInput, ContentBlock[]>, false>

Defined in: core/src/tool/tool.ts:378

Run procedure (static property). Undefined for client-only tools.