Struct SingleSessionBuilder 

pub struct SingleSessionBuilder { /* private fields */ }

High-level builder for seeding one harness, one agent, and one session.

This is the compact path used by embedders that want a runnable runtime without constructing each core model separately.

Implementations

impl SingleSessionBuilder

pub fn harness( self, name: impl Into<String>, system_prompt: impl Into<String>, ) -> Self

Configure the seeded harness. Mutates the existing HarnessBuilder in place so previously configured fields (e.g. network_access) are preserved regardless of call order.

pub fn agent( self, name: impl Into<String>, system_prompt: impl Into<String>, ) -> Self

Configure the seeded agent. Mutates the existing AgentBuilder in place so previously configured fields (e.g. network_access) are preserved regardless of call order.

pub fn with_capability( self, capability: impl Into<AgentCapabilityConfig>, ) -> Self

Add a harness-level capability.

pub fn harness_capability( self, capability: impl Into<AgentCapabilityConfig>, ) -> Self

Add a harness-level capability.

pub fn agent_capability( self, capability: impl Into<AgentCapabilityConfig>, ) -> Self

Add an agent-level capability.

pub fn agent_plugin(self, name: &str) -> Self

Enable a previously loaded plugin on the seeded agent.

Adds a plugin:{name} capability ref to the agent with an empty config. The hydrated definition must be supplied separately via [InProcessRuntimeBuilder::with_plugin_dir] — this method only records the capability ref on the agent so the capability is active for this session. The builder looks up the hydrated config at build time from the plugin_capability_configs accumulated by with_plugin_dir calls.

If you need to pass the fully hydrated AgentCapabilityConfig (e.g. from [InProcessRuntimeBuilder::plugin_capability]), use Self::agent_capability directly.

pub fn session_capability( self, capability: impl Into<AgentCapabilityConfig>, ) -> Self

Add a session-level capability.

pub fn session_mcp_servers(self, mcp_servers: ScopedMcpServers) -> Self

Configure session-scoped MCP servers (specs/runtime-mcp.md). Discovered and executed by the runtime alongside built-in tools.

pub fn harness_display_name(self, display_name: impl Into<String>) -> Self

pub fn agent_display_name(self, display_name: impl Into<String>) -> Self

pub fn harness_description(self, description: impl Into<String>) -> Self

pub fn openrouter_attribution( self, http_referer: impl Into<String>, title: impl Into<String>, ) -> Self

pub fn agent_description(self, description: impl Into<String>) -> Self

pub fn session_title(self, title: impl Into<String>) -> Self

pub fn locale(self, locale: impl Into<String>) -> Self

pub fn tag(self, tag: impl Into<String>) -> Self

pub fn session_model_id(self, model_id: ModelId) -> Self

pub fn harness_default_model_id(self, model_id: ModelId) -> Self

pub fn agent_default_model_id(self, model_id: ModelId) -> Self

pub fn agent_max_iterations(self, max_iterations: usize) -> Self

pub fn session_max_iterations(self, max_iterations: usize) -> Self

pub fn agent_tool(self, tool: ToolDefinition) -> Self

pub fn session_tool(self, tool: ToolDefinition) -> Self

pub fn harness_initial_file(self, file: InitialFile) -> Self

pub fn agent_initial_file(self, file: InitialFile) -> Self

pub fn session_initial_file(self, file: InitialFile) -> Self

pub fn harness_network_access(self, network_access: NetworkAccessList) -> Self

pub fn agent_network_access(self, network_access: NetworkAccessList) -> Self

pub fn session_network_access(self, network_access: NetworkAccessList) -> Self

pub fn harness_id(&self) -> HarnessId

pub fn agent_id(&self) -> AgentId

pub fn session_id(self, id: SessionId) -> Self

Pin the seeded session’s id. When unset, the underlying SessionBuilder generates a fresh SessionId at build time.

Useful for embedders that need the id ahead of build — e.g. the examples/coding-cli JSONL session log uses <id>.jsonl as the filename and must open the file before the runtime exists.

Trait Implementations

impl Clone for SingleSessionBuilder

fn clone(&self) -> SingleSessionBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SingleSessionBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SingleSessionBuilder

fn default() -> Self

Returns the “default value” for a type.