Interface: ToolSearchOptions
Defined in: packages/core/src/tools/tool-search.ts:44
Extends
Omit<ToolDiscoveryOptions,"tools">
Properties
alwaysActive?
optionalalwaysActive?: readonlystring[]
Defined in: packages/core/src/tools/tool-discovery.ts:40
Small, frequently used tools that must stay available on every step.
Inherited from
Omit.alwaysActive
cache?
optionalcache?:object
Defined in: packages/core/src/tools/tool-search.ts:64
Stamp the stable part of the tool list for Anthropic prompt caching: the last loaded tool (native) or the search tool, which ends the pinned prefix (portable). Omit when the caller stamps tools itself.
ttl?
optionalttl?:AnthropicCacheTtl
capabilities?
optionalcapabilities?: readonlystring[]
Defined in: packages/core/src/tools/tool-discovery.ts:44
Short host-provided service names shown in the search tool's description; never schemas or credentials.
Inherited from
Omit.capabilities
defer?
optionaldefer?:"all"|"skills"
Defined in: packages/core/src/tools/tool-search.ts:58
Which tools load on demand. 'all' (default): every tool not in
alwaysActive. 'skills': only tools a skill contributed (toolGroup
skill:<name>); every other tool stays loaded.
maxActiveTools?
optionalmaxActiveTools?:number
Defined in: packages/core/src/tools/tool-discovery.ts:46
Maximum discovered tools visible together, excluding alwaysActive. Default 12; 5–100. Ignored when retainDiscovered.
Inherited from
Omit.maxActiveTools
metadata?
optionalmetadata?:Readonly<Record<string,ToolDiscoveryMetadata>>
Defined in: packages/core/src/tools/tool-discovery.ts:57
Curated search text per tool name. Tools without an entry are searched by name and description.
Inherited from
Omit.metadata
mode?
optionalmode?:ToolSearchMode
Defined in: packages/core/src/tools/tool-search.ts:52
'auto' (default) picks native on direct Anthropic Claude 4+ models and
portable everywhere else. 'native' throws on a transport that cannot
carry it. 'portable' works on every transport, including Anthropic —
but there it changes the sent tool list between steps, which costs the
tools cache and, on thinking-bound models, the preserved-thinking check.
nativeSearchToolName?
optionalnativeSearchToolName?:string
Defined in: packages/core/src/tools/tool-search.ts:66
Key for the native search tool. Default tool_search.
preloadSkills?
optionalpreloadSkills?:"reference"|"load"
Defined in: packages/core/src/tools/tool-search.ts:84
Baleybot only, native presentation: how a skill the host requests for a
call (ProcessOptions.activeSkills) loads its tools. 'reference'
(default): as conversation — a synthetic load_skill exchange whose
result references the skill's deferred tools, the way a mid-call
load_skill does — so the tool list (the front of the cached prompt)
stays byte-identical whichever skills a route picks. 'load': its tools
are sent loaded from the first step, changing the tool list.
recentTools?
optionalrecentTools?: readonlystring[]
Defined in: packages/core/src/tools/tool-discovery.ts:42
Tool names to start selected, oldest first (recent use, a host's seed). Unknown names are ignored.
Inherited from
Omit.recentTools
referenced?
optionalreferenced?: readonlystring[]
Defined in: packages/core/src/tools/tool-search.ts:74
Native only: tools the conversation already loads with a tool_reference
(an earlier step of this turn, carried into a fallback model or a resumed
run). They stay deferred — the reference loads them, and a reference to a
definition that is not deferred is not a valid request — and are never
referenced again. toolReferencesIn() (adapters) reads them from model messages.
retainDiscovered?
optionalretainDiscovered?:boolean
Defined in: packages/core/src/tools/tool-discovery.ts:53
Keep every discovery for the whole request, in activation order (no
eviction). The prefix of the tool list then only ever grows, which suits
prompt caching. Default false (least-recently-found tools are evicted
past maxActiveTools).
Inherited from
Omit.retainDiscovered
searchToolName?
optionalsearchToolName?:string
Defined in: packages/core/src/tools/tool-discovery.ts:55
Name of the search tool. Default baleybots_search_tools; a numeric suffix is added on collision.
Inherited from
Omit.searchToolName