Interface ToolboxToolsetOptions

Configuration options for ToolboxToolset.

interface ToolboxToolsetOptions {
    authTokenGetters?: Record<string, () => string | Promise<string>>;
    boundParams?: Record<string, unknown>;
    client?: ToolboxToolsetClientLike;
    prefix?: string;
    serverUrl: string;
    toolFilter?:
        | string[]
        | ((tool: BaseTool, readonlyContext?: ReadonlyContext) => boolean);
    toolNames?: readonly string[];
    toolsetName?: string;
}

Properties

authTokenGetters?: Record<string, () => string | Promise<string>>

Mapping of authentication service names to callables that return the corresponding authentication token.

boundParams?: Record<string, unknown>

Mapping of parameter names to bind to fixed values or callables that produce values as needed.

Optional pre-configured Toolbox client instance.

prefix?: string

Optional prefix prepended (${prefix}_) to loaded tool names.

serverUrl: string

The URL of the Toolbox server.

toolFilter?:
| string[]
| ((tool: BaseTool, readonlyContext?: ReadonlyContext) => boolean)

Optional filter to select which tools are exposed to the LLM.

toolNames?: readonly string[]

The names of the individual tools to load.

toolsetName?: string

The name of the Toolbox toolset to load.