Kikoyu Core API Reference


Kikoyu Core API Reference / Tool

Interface: Tool<TSchema, TResult, TContext>

Type Parameters

TSchema extends z.ZodTypeAny = any

TResult = any

TContext = any

Properties

description

description: string

Defined in

types.ts:76


execute()

execute: (args, context) => TResult | Promise<TResult>

Parameters

args

any

context

RunContext<TContext>

Returns

TResult | Promise<TResult>

Defined in

types.ts:80


handoffTarget?

optional handoffTarget: Agent

Defined in

types.ts:78


name

name: string

Defined in

types.ts:75


parameters

parameters: ZodTypeAny

Defined in

types.ts:77


requiresApproval?

optional requiresApproval: boolean | (args) => boolean

Defined in

types.ts:79