Skip to main content
Version: Next

CreateToolOptions

CreateToolOptions​

@commandkit/aiindex.ts

Configuration options for creating an AI tool.

Signature
interface CreateToolOptions<T extends ToolParameterType, R = unknown> {
    name: string;
    description: string;
    parameters: T;
    execute: ToolExecuteFunction<T, R>;
}

name​

property
string

The unique name identifier for the tool

description​

property
string

A human-readable description of what the tool does

parameters​

property
T

The parameter schema that defines the tool's input structure

execute​

property
ToolExecuteFunction<T, R>

The function that executes when the tool is called