Tools
Tool definitions, toolsets, and execution helpers.
Classes
StaticToolset
Defined in: src/tools/base.ts:284
Extends
Constructors
Constructor
new StaticToolset(
options):StaticToolset
Defined in: src/tools/base.ts:285
Parameters
options
name
string
description
string
tools
Tool[]
Returns
Overrides
Properties
name
readonlyname:string
Defined in: src/tools/base.ts:135
Inherited from
description
readonlydescription:string
Defined in: src/tools/base.ts:136
Inherited from
Methods
searchTools()
searchTools(
query,k?):Promise<Tool[]>
Defined in: src/tools/base.ts:149
Parameters
query
string
k?
number = 10
Returns
Promise<Tool[]>
Inherited from
invoke()
invoke(
toolName,args):Promise<{ok:boolean;value?:unknown;error?:string|null;metadata:Record<string,unknown>;cause?: {kind:"validation"|"runtime";name?:string;message?:string;stack?:string|null;code?:string|null;metadata?:JsonDict; } |null; }>
Defined in: src/tools/base.ts:162
Parameters
toolName
string
args
Returns
Promise<{ ok: boolean; value?: unknown; error?: string | null; metadata: Record<string, unknown>; cause?: { kind: "validation" | "runtime"; name?: string; message?: string; stack?: string | null; code?: string | null; metadata?: JsonDict; } | null; }>
Inherited from
asDelegated()
asDelegated(
options?):Tool
Defined in: src/tools/base.ts:171
Parameters
options?
DelegatedToolOptions = {}
Returns
Inherited from
listTools()
listTools():
Promise<Tool[]>
Defined in: src/tools/base.ts:292
Returns
Promise<Tool[]>
Overrides
Functions
tool()
tool<
TInput>(options):Tool
Defined in: src/tools/base.ts:32
Type Parameters
TInput
TInput extends JsonDict = JsonDict
Parameters
options
ToolOptions<TInput>
Returns
References
MCPToolset
Re-exports MCPToolset
MCPCallToolOptions
Re-exports MCPCallToolOptions
MCPClientSession
Re-exports MCPClientSession
MCPSessionHandle
Re-exports MCPSessionHandle
MCPToolsetOptions
Re-exports MCPToolsetOptions
MCPTransport
Re-exports MCPTransport
SessionFactory
Re-exports SessionFactory
ToolHandler
Re-exports ToolHandler
DelegatedToolOptions
Re-exports DelegatedToolOptions
ToolOptions
Re-exports ToolOptions
ToolSearchIndex
Re-exports ToolSearchIndex
LexicalIndex
Re-exports LexicalIndex
BaseToolset
Re-exports BaseToolset
bgCancel
Re-exports bgCancel
bgCheck
Re-exports bgCheck
bgList
Re-exports bgList
bgWait
Re-exports bgWait
backgroundControlTools
Re-exports backgroundControlTools
remember
Re-exports remember
workingMemoryTools
Re-exports workingMemoryTools
appendBullet
Re-exports appendBullet
setPlanTool
Re-exports setPlanTool
planTools
Re-exports planTools
askAboutUser
Re-exports askAboutUser
honchoTools
Re-exports honchoTools
acpReadTextFile
Re-exports acpReadTextFile
acpWriteTextFile
Re-exports acpWriteTextFile
acpFsTools
Re-exports acpFsTools
acpRunCommand
Re-exports acpRunCommand
acpTerminalTools
Re-exports acpTerminalTools