IFetchInfoToolParams

Parameters for configuring fetch info tool (READ pattern). Creates a tool that fetches and returns data to the AI without modifying system state.

Properties

toolName

toolName: string
Copy

The name of the tool to be created.

function

function: { name: string; description: string; parameters: { type: string; required: string[]; properties: { [key: string]: { type: string; description: string; enum?: string[]; }; }; }; } | ((clientId: string, agentName: string) => { ...; } | Promise<...>)
Copy

Tool function schema (name, description, parameters).

docNote

docNote: string
Copy

Optional documentation note for the tool.

isAvailable

isAvailable: (clientId: string, agentName: string, toolName: string) => boolean | Promise<boolean>
Copy

Optional function to determine if the tool is available.

validateParams

validateParams: (dto: { clientId: string; agentName: string; toolCalls: IToolCall[]; params: T; }) => boolean | Promise<boolean>
Copy

Optional validation function that runs before fetchContent. Returns boolean (true if valid, false if invalid).