Interface IFetchInfoParams<T>

Configuration parameters for creating a fetch info handler (READ pattern). Defines the data fetching logic without modifying system state.

Param: error

The error object thrown during fetch

Param: clientId

The client identifier

Param: agentName

The name of the current agent

  • Called when fetchContent throws an exception
  • Error message is automatically passed to emptyContent handler

Param: params

Tool call parameters (validated if validateParams was provided in addFetchInfo)

Param: clientId

The client identifier

Param: agentName

The name of the current agent

Returns

Content string to return to AI as tool output

Param: content

The empty content from fetchContent

Param: clientId

The client identifier

Param: agentName

The name of the current agent

Param: toolName

The tool name

Returns

Message to commit as tool output

Default

"The tool named {toolName} is not available. Do not ever call it again"

Example

// Fetch user data from database with error handling
const fetchUserData = createFetchInfo({
  fallback: (error, clientId, agentName) => {
    console.error(`Failed to fetch user data for ${clientId} (${agentName}):`, error);
  },
  fetchContent: async (params, clientId) => {
    const user = await getUserData(params.userId);
    return JSON.stringify(user);
  },
  emptyContent: (content) => content || "User not found",
});
await fetchUserData("tool-123", "client-456", "UserAgent", "FetchUserData", { userId: "123" }, true);
interface IFetchInfoParams<T = Record<string, any>> {
    emptyContent?: (
        content: string,
        clientId: string,
        agentName: string,
        toolName: string,
    ) => string | Promise<string>;
    fallback?: (error: Error, clientId: string, agentName: string) => void;
    fetchContent: (
        params: T,
        clientId: string,
        agentName: string,
    ) => string | Promise<string>;
}

Type Parameters

  • T = Record<string, any>

    The type of parameters expected by the fetch operation IFetchInfoParams

Properties

emptyContent? fallback? fetchContent

Properties

OptionalemptyContent

emptyContent?: (
    content: string,
    clientId: string,
    agentName: string,
    toolName: string,
) => string | Promise<string>

Optional function to handle when fetchContent returns empty result

Optionalfallback

fallback?: (error: Error, clientId: string, agentName: string) => void

Optional error handler for fetchContent failures

fetchContent

fetchContent: (
    params: T,
    clientId: string,
    agentName: string,
) => string | Promise<string>

Function to fetch the content/data to be provided to the AI agent

Settings

Member Visibility

On This Page

The error object thrown during fetchThe client identifierTool call parameters (validated if validateParams was provided in addFetchInfo)The client identifierThe name of the current agentThe empty content from fetchContentThe client identifierThe name of the current agentThe tool nameMessage to commit as tool output
Properties