Skip to content

Graphorin API reference v0.12.1


Graphorin API reference / @graphorin/tools / / ToolSearchToolOptions

Interface: ToolSearchToolOptions

Defined in: packages/tools/src/built-in/tool-search.ts:24

Configuration for createToolSearchTool.

Properties

PropertyModifierTypeDescriptionDefined in
availability?readonly"next-step" | "next-run"When matched tools become callable, reflected in the model-facing description so the model is never promised availability the harness does not deliver. 'next-step' (default) matches the agent's immediate promotion mode; 'next-run' matches toolPromotion: 'run-boundary' (C1), where the catalogue is frozen for the current run.packages/tools/src/built-in/tool-search.ts:38
defaultK?readonlynumberDefault k when the model does not pass one. Default 5.packages/tools/src/built-in/tool-search.ts:27
excludeTool?readonly(toolName) => booleanE1 deny-by-name: matches returning true are dropped from the results BEFORE the model sees them, so a name-denied deferred tool is neither discoverable nor promoted into the advertised set (its name and schema would otherwise leak while execution stays blocked). The agent wires the permission policy's name-level deny here; absent ⇒ no exclusion.packages/tools/src/built-in/tool-search.ts:47
maxK?readonlynumberHard cap on k (model-supplied). Default 15.packages/tools/src/built-in/tool-search.ts:29
registryreadonlyToolRegistry-packages/tools/src/built-in/tool-search.ts:25