RegistrableServerTool
Defined in: packages/engine/src/lib/agent-session/tool-registry.ts:16
A Server Tool with its input and output types erased so tools of different types share one list.
Properties
Section titled “Properties”approval
Section titled “approval”
readonlyapproval:"never"
Defined in: packages/engine/src/lib/agent-session/tool-registry.ts:30
Whether a call needs user approval before it runs.
description
Section titled “description”
readonlydescription:string
Defined in: packages/engine/src/lib/agent-session/tool-registry.ts:20
Description shown to the model.
readonlyinput:ZodType<unknown>
Defined in: packages/engine/src/lib/agent-session/tool-registry.ts:22
Schema the model’s arguments are validated against.
readonlylocus:"server"
Defined in: packages/engine/src/lib/agent-session/tool-registry.ts:26
Where the tool runs.
readonlyname:string
Defined in: packages/engine/src/lib/agent-session/tool-registry.ts:18
Name the model calls the tool by. Must match ^[A-Za-z0-9_-]{1,64}$.
output
Section titled “output”
readonlyoutput:ZodType<unknown>
Defined in: packages/engine/src/lib/agent-session/tool-registry.ts:24
Schema the tool’s result is validated against.
sideEffect
Section titled “sideEffect”
readonlysideEffect:"idempotent"|"read_only"|"non_idempotent"
Defined in: packages/engine/src/lib/agent-session/tool-registry.ts:28
How the tool affects the world.
Methods
Section titled “Methods”execute()
Section titled “execute()”execute(
input,ctx):Promise<unknown>
Defined in: packages/engine/src/lib/agent-session/tool-registry.ts:32
Runs the tool with validated input.
Parameters
Section titled “Parameters”never
Returns
Section titled “Returns”Promise<unknown>
summarize()
Section titled “summarize()”summarize(
output):string
Defined in: packages/engine/src/lib/agent-session/tool-registry.ts:34
Pure, synchronous, user-safe one-line description of a result.
Parameters
Section titled “Parameters”output
Section titled “output”never
Returns
Section titled “Returns”string