Skip to content

apollo-code


apollo-code / tool-kit/src / Tool

Interface: Tool<Input>

Type Parameters

Input

Input = unknown

Properties

description

readonly description: string


inputSchema

readonly inputSchema: Record<string, JsonValue>


name

readonly name: string


outputHint?

readonly optional outputHint?: string


parallelSafe?

readonly optional parallelSafe?: boolean


readonly?

readonly optional readonly?: boolean


timeoutMs?

readonly optional timeoutMs?: number

Methods

invoke()

invoke(input, context): Promise<ToolResult>

Parameters

input

Input

context

ToolContext

Returns

Promise<ToolResult>


permissionSpec()

permissionSpec(input): PermissionSpec

Parameters

input

Input

Returns

PermissionSpec