Skip to main content

Interface: ToolSearchPlan

Defined in: packages/core/src/tools/tool-search.ts:87

Properties​

activate​

activate: (names) => void

Defined in: packages/core/src/tools/tool-search.ts:114

Make tools callable from the next step (a skill loaded mid-call, host seeding). Portable: they join the selection. Native: each one still deferred is queued, and the next tool result carries a tool_reference that loads it (see references); tool definitions never change.

Parameters​

names​

readonly string[]

Returns​

void


activeTools​

activeTools: (choice?) => string[] | undefined

Defined in: packages/core/src/tools/tool-search.ts:107

The names a step would send now (portable), or undefined (native: every tool is sent, most deferred).

Parameters​

choice?​

ToolChoiceLike

Returns​

string[] | undefined


deactivate​

deactivate: (names) => void

Defined in: packages/core/src/tools/tool-search.ts:124

Return tools to on-demand loading from the next step (a skill the model unloaded). Portable: they leave the selection unless pinned, and a step that called one does not re-select it. Native: no change within the call — a tool a reference already loaded stays in the transcript, and removing it would mean editing that earlier tool result or the tool list, which re-reads the whole cached prompt and fails the preserved-thinking check. The next call's plan (built from the skills active then) defers it again.

Parameters​

names​

readonly string[]

Returns​

void


kind​

kind: "native" | "portable"

Defined in: packages/core/src/tools/tool-search.ts:88


loaded​

loaded: string[]

Defined in: packages/core/src/tools/tool-search.ts:96

Names loaded from the first step (pinned).


note​

note: string

Defined in: packages/core/src/tools/tool-search.ts:135

One line for the system prompt telling the model how to find more tools.


prepareStep?​

optional prepareStep?: (args) => object

Defined in: packages/core/src/tools/tool-search.ts:102

Portable only: the AI SDK prepareStep that sends the current selection (activeTools and toolOrder, so the pinned prefix stays stable). Compose it before your own hook. Undefined for native.

Parameters​

args​
steps?​

readonly object[]

Returns​

object

activeTools​

activeTools: string[]

toolOrder​

toolOrder: string[]


rank​

rank: (query, limit?) => string[]

Defined in: packages/core/src/tools/tool-search.ts:133

Rank the catalog for a query (host seeding). At most 15 names.

Parameters​

query​

string

limit?​

number

Returns​

string[]


reason​

reason: string

Defined in: packages/core/src/tools/tool-search.ts:90

Why this presentation was chosen (for logs, never for a person).


references?​

optional references?: (toolCallId) => string[]

Defined in: packages/core/src/tools/tool-search.ts:131

Native only: the deferred tools a tool result loads by reference. Core asks while turning each tool result into model input; the first result converted after an activate takes the queued names, and the same call id always gets the same answer (so a re-sent step is byte-identical).

Parameters​

toolCallId​

string

Returns​

string[]


searchToolName​

searchToolName: string

Defined in: packages/core/src/tools/tool-search.ts:94

The search tool's key in tools.


tools​

tools: Record<string, unknown>

Defined in: packages/core/src/tools/tool-search.ts:92

The tool map to give the bot for this request. Executors are unchanged.