AgentOptions

Defined in: agent/agent.ts:71

Configuration options for the Agent.

Properties

baseDepth?

optional baseDepth: number

Defined in: agent/agent.ts:178

Base depth for nodes created by this agent. Root agents use 0; subagents use (parentDepth + 1).

---

client

client: LLMist

Defined in: agent/agent.ts:73

The LLM client

---

compactionConfig?

optional compactionConfig: CompactionConfig

Defined in: agent/agent.ts:143

Context compaction configuration (enabled by default)

---

defaultGadgetTimeoutMs?

optional defaultGadgetTimeoutMs: number

Defined in: agent/agent.ts:131

Default gadget timeout

---

gadgetArgPrefix?

optional gadgetArgPrefix: string

Defined in: agent/agent.ts:109

Custom gadget argument prefix for block format parameters

---

gadgetEndPrefix?

optional gadgetEndPrefix: string

Defined in: agent/agent.ts:106

Custom gadget end prefix

---

gadgetOutputLimit?

optional gadgetOutputLimit: boolean

Defined in: agent/agent.ts:137

Enable gadget output limiting (default: true)

---

gadgetOutputLimitPercent?

optional gadgetOutputLimitPercent: number

Defined in: agent/agent.ts:140

Max gadget output as % of model context window (default: 15)

---

gadgetStartPrefix?

optional gadgetStartPrefix: string

Defined in: agent/agent.ts:103

Custom gadget start prefix

---

hooks?

optional hooks: AgentHooks

Defined in: agent/agent.ts:97

Clean hooks system

---

initialMessages?

optional initialMessages: object[]

Defined in: agent/agent.ts:112

Initial messages. User messages support multimodal content.

content

content: MessageContent

role

role: "system" | "user" | "assistant"

---

logger?

optional logger: Logger<ILogObj>

Defined in: agent/agent.ts:94

Logger

---

maxIterations?

optional maxIterations: number

Defined in: agent/agent.ts:85

Maximum iterations

---

model

model: string

Defined in: agent/agent.ts:76

The model ID

---

onSubagentEvent()?

optional onSubagentEvent: (event) => void

Defined in: agent/agent.ts:155

Callback for subagent gadgets to report subagent events to parent

Parameters

event

SubagentEvent

Returns

void

---

parentNodeId?

optional parentNodeId: string

Defined in: agent/agent.ts:172

Parent node ID in the tree (when this agent is a subagent). Used to set parentId on all nodes created by this agent.

---

parentTree?

optional parentTree: ExecutionTree

Defined in: agent/agent.ts:166

Shared execution tree for tracking all LLM calls and gadget executions. If provided (by a parent subagent), nodes are added to this tree. If not provided, the Agent creates its own tree.

---

promptConfig?

optional promptConfig: PromptTemplateConfig

Defined in: agent/agent.ts:134

Custom prompt configuration for gadget system prompts

---

registry

registry: GadgetRegistry

Defined in: agent/agent.ts:91

Gadget registry

---

requestHumanInput()?

optional requestHumanInput: (question) => Promise<string>

Defined in: agent/agent.ts:100

Callback for requesting human input during execution

Parameters

question

string

Returns

Promise<string>

---

retryConfig?

optional retryConfig: RetryConfig

Defined in: agent/agent.ts:146

Retry configuration for LLM API calls (enabled by default)

---

signal?

optional signal: AbortSignal

Defined in: agent/agent.ts:149

Optional abort signal for cancelling requests mid-flight

---

subagentConfig?

optional subagentConfig: SubagentConfigMap

Defined in: agent/agent.ts:152

Subagent-specific configuration overrides (from CLI config)

---

systemPrompt?

optional systemPrompt: string

Defined in: agent/agent.ts:79

System prompt

---

temperature?

optional temperature: number

Defined in: agent/agent.ts:88

Temperature

---

textOnlyHandler?

optional textOnlyHandler: TextOnlyHandler

Defined in: agent/agent.ts:115

Text-only handler

---

textWithGadgetsHandler?

optional textWithGadgetsHandler: object

Defined in: agent/agent.ts:121

Handler for text content that appears alongside gadget calls. When set, text accompanying gadgets will be wrapped as a synthetic gadget call.

gadgetName

gadgetName: string

Name of the gadget to use for wrapping text

parameterMapping()

parameterMapping: (text) => Record<string, unknown>

Maps text content to gadget parameters

Parameters

text

string

Returns

Record<string, unknown>

resultMapping()?

optional resultMapping: (text) => string

Maps text content to the result string (optional, defaults to text)

Parameters

text

string

Returns

string

---

userPrompt?

optional userPrompt: string | ContentPart[]

Defined in: agent/agent.ts:82

Initial user prompt (optional if using build()). Can be text or multimodal content.