Skip to main content

Interface: ToolDiscoveryOptions<TTools>

Defined in: packages/core/src/tools/tool-discovery.ts:36

Type Parameters​

TTools​

TTools extends Record<string, unknown> = Record<string, unknown>

Properties​

alwaysActive?​

optional alwaysActive?: readonly string[]

Defined in: packages/core/src/tools/tool-discovery.ts:40

Small, frequently used tools that must stay available on every step.


capabilities?​

optional capabilities?: readonly string[]

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.


maxActiveTools?​

optional maxActiveTools?: 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.


metadata?​

optional metadata?: 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.


recentTools?​

optional recentTools?: readonly string[]

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.


retainDiscovered?​

optional retainDiscovered?: 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).


searchToolName?​

optional searchToolName?: 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.


tools​

tools: TTools

Defined in: packages/core/src/tools/tool-discovery.ts:38

Already authorized tools for this request. Executors are never changed.