@sqlrooms/mosaic / BaseAgentToolOptions

Type Alias: BaseAgentToolOptions<TState>

BaseAgentToolOptions<TState> = object

Common options for agent creation

Type Parameters

Type Parameter
TState

Properties

store

store: AiStore<TState>

---

getModel

getModel: (args) => LanguageModel

Parameters

Parameter	Type
args	{ state: TState; }
args.state	TState

Returns

LanguageModel

---

createDataTools?

optional createDataTools?: (args) => object

Parameters

Parameter	Type
args	{ store: AiStore<TState>; }
args.store	AiStore<TState>

Returns

object

Name	Type
query	Tool
list_tables	Tool
read_table_schema	Tool

---

runSubAgent

runSubAgent: (args) => Promise<AgentRunResult>

Parameters

Parameter	Type
args	{ agent: ToolLoopAgent<any, any, any>; prompt: string; store: AiStore<TState>; parentToolCallId: string; abortSignal?: AbortSignal; }
args.agent	ToolLoopAgent<any, any, any>
args.prompt	string
args.store	AiStore<TState>
args.parentToolCallId	string
args.abortSignal?	AbortSignal

Returns

Promise<AgentRunResult>

---

instructions?

optional instructions?: string

---

additionalInstructions?

optional additionalInstructions?: string

Optional host/plugin instructions appended after the built-in agent prompt. Use this when extending an agent with extra tools that need specialized usage guidance while preserving the base workflow.

---

chartToolsOptions?

optional chartToolsOptions?: ChartToolsOptions