struct

Crig::AgentBuilder(M)

Inherits Struct < Value < Object

Builder for the core agent runtime. AgentBuilder is the main ergonomic surface for composing preambles, context, tools, dynamic retrieval, output schemas, and generation parameters before producing a concrete Agent.

Constructors

new(model : M, name_value : String | Nil = nil, description_value : String | Nil = nil, preamble_value : String | Nil = nil, static_context_value : Array(Crig::Completion::Request::Document) = [] of Crig::Completion::Request::Document, dynamic_context_value : Array(DynamicContextSource) = [] of DynamicContextSource, static_tools_value : Array(Crig::Completion::ToolDefinition) = [] of Crig::Completion::ToolDefinition, dynamic_tools_value : Array(DynamicToolSource) = [] of DynamicToolSource, tool_server_handle_value : ToolServerHandle | Nil = nil, additional_params_value : JSON::Any | Nil = nil, max_tokens_value : Int64 | Nil = nil, default_max_turns_value : Int32 | Nil = nil, temperature_value : Float64 | Nil = nil, tool_choice_value : Crig::Completion::ToolChoice | Nil = nil, output_schema_value : JSON::Any | Nil = nil, memory_value : Crig::Memory::ConversationMemory | Nil = nil, default_conversation_id_value : String | Nil = nil, hook_value : AgentHook | Nil = nil)

Instance methods

additional_params(params : JSON::Any) : self

additional_params_value

append_preamble(doc : String) : self

build

context(doc : String) : self

Add static context that will be normalized into request documents.

conversation_id(id : String) : self

Set a default conversation id used when none is provided per-request. Can be overridden per-request via PromptRequest#conversation.

default_conversation_id_value

default_max_turns(default_max_turns : Int32) : self

default_max_turns_value

description(description : String) : self

description_value

dynamic_context(sample : Int32, dynamic_context) : self

Register a dynamic context source queried at prompt time.

dynamic_context_value

dynamic_tools(sample : Int32, dynamic_tools, tools : Array(Crig::Completion::ToolDefinition)) : self

Register a dynamic tool source queried from vector search at prompt time.

dynamic_tools(sample : Int32, dynamic_tools, toolset : Crig::ToolSet) : self

Register a dynamic tool source queried from vector search at prompt time using the same ToolSet-oriented surface as the upstream Rust builder.

dynamic_tools_value

hook(hook : AgentHook) : self

hook_value

max_tokens(max_tokens : Int64) : self

max_tokens_value

memory(memory : Crig::Memory::ConversationMemory) : self

Attach a ConversationMemory backend. When set, the agent will automatically load prior conversation history before sending a prompt and append new messages after a successful turn. A conversation_id must be supplied either via #conversation_id on the builder or per-request via PromptRequest#conversation. If neither is set, memory is silently bypassed.

memory_value

model

name(name : String) : self

name_value

output_schema(output_schema : JSON::Any) : self

output_schema(type : T.class) : self forall T

Build a JSON schema from a Crystal type for structured output requests.

output_schema_value

preamble(preamble : String) : self

preamble_value

retrieved_tools(sample : Int32, index, tools : Array(Crig::Completion::ToolDefinition)) : self

Upstream alias: dynamic_tools → retrieved_tools (v0.41.0)

retrieved_tools(sample : Int32, index, toolset : Crig::ToolSet) : self

Upstream alias: dynamic_tools → retrieved_tools for ToolSet variant (v0.41.0)

rmcp_tool(tool : MCP::Protocol::Tool, client : MCP::Client::Client) : self

rmcp_tools(tools : Array(MCP::Protocol::Tool), client : MCP::Client::Client) : self

static_context_value

static_tools_value

temperature(temperature : Float64) : self

temperature_value

tool(tool : Crig::Agent(T)) : self forall T

Add a nested agent as a callable tool (upstream into_tool).

tool(tool : Crig::Completion::ToolDefinition) : self

Add a tool definition directly without an executable runtime implementation.

tool(tool : Crig::ToolDyn) : self

Add an executable tool and route it through the shared tool server runtime.

tool_choice(tool_choice : Crig::Completion::ToolChoice) : self

tool_choice_value

tool_server_handle(handle : ToolServerHandle) : self

tool_server_handle_value

tools(tools : Array(Crig::Agent(T))) : self forall T

Deprecated: use repeated .tool(...) calls instead.

tools(tools : Array(Crig::Completion::ToolDefinition)) : self

Deprecated: use repeated .tool(...) calls instead. tools(Vec) was removed in upstream v0.41.0 — prefer .tool(...) for clarity.

tools(tools : Array(Crig::ToolDyn)) : self

Deprecated: use repeated .tool(...) calls instead.

without_preamble