CreateToolFromAgentOptions
CreateToolFromAgentOptions<
ToolProviderContext,TToolInput> =object
Defined in: packages/core/src/tools/from-agent.ts:11
Type Parameters
Section titled “Type Parameters”ToolProviderContext
Section titled “ToolProviderContext”ToolProviderContext
TToolInput
Section titled “TToolInput”TToolInput = DefaultToolInput
Properties
Section titled “Properties”description
Section titled “description”description:
string
Defined in: packages/core/src/tools/from-agent.ts:13
inputSchema?
Section titled “inputSchema?”
optionalinputSchema?:z.ZodType<TToolInput>
Defined in: packages/core/src/tools/from-agent.ts:18
Zod schema for the LLM-facing tool arguments. Inferred as TToolInput.
When omitted, arguments are a catch-all object (Record<string, unknown>).
mapRun
Section titled “mapRun”mapRun: (
toolArgs,meta) =>Pick<AgentRunInput<ToolProviderContext>,"memoryScope"|"user"|"toolProviderContext"|"messages"|"stopWhen"|"workflow"|"systemPromptConflict"|"suppressSystemPromptConflictWarning">
Defined in: packages/core/src/tools/from-agent.ts:19
Parameters
Section titled “Parameters”toolArgs
Section titled “toolArgs”TToolInput
Returns
Section titled “Returns”Pick<AgentRunInput<ToolProviderContext>, "memoryScope" | "user" | "toolProviderContext" | "messages" | "stopWhen" | "workflow" | "systemPromptConflict" | "suppressSystemPromptConflictWarning">
optionalname?:string
Defined in: packages/core/src/tools/from-agent.ts:12