Struct CustomAgentConfig 

#[non_exhaustive]
pub struct CustomAgentConfig {
    pub name: String,
    pub display_name: Option<String>,
    pub description: Option<String>,
    pub tools: Option<Vec<String>>,
    pub prompt: String,
    pub mcp_servers: Option<IndexMap<String, McpServerConfig>>,
    pub infer: Option<bool>,
    pub skills: Option<Vec<String>>,
    pub model: Option<String>,
    pub reasoning_effort: Option<String>,
}

Configures a custom agent (sub-agent) for the session.

Custom agents have their own prompt, tool allowlist, and optionally their own MCP servers and skill set. The agent named in SessionConfig::agent (or the runtime default) is the active one when the session starts.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Unique name of the custom agent.

display_name: Option<String>

Display name for UI purposes.

description: Option<String>

Description of what the agent does.

tools: Option<Vec<String>>

List of tool names the agent can use. None means all tools.

prompt: String

Prompt content for the agent.

mcp_servers: Option<IndexMap<String, McpServerConfig>>

MCP servers specific to this agent.

infer: Option<bool>

Whether the agent is available for model inference.

skills: Option<Vec<String>>

Skill names to preload into this agent’s context at startup.

model: Option<String>

Model identifier for this agent (e.g. "claude-haiku-4.5").

When set, the runtime will attempt to use this model for the agent, falling back to the parent session model if unavailable.

reasoning_effort: Option<String>

Reasoning effort level for this agent’s model.

When unset, the runtime resolves model configuration, then inherits the parent effort only for the same model.

Implementations

impl CustomAgentConfig

pub fn new(name: impl Into<String>, prompt: impl Into<String>) -> Self

Construct a custom agent configuration with the required name and prompt fields populated.

All other fields default to unset; use the with_* chain to customize them. Fields are also pub if direct assignment is preferred for Option<T> pass-through.

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

Set the display name shown in the CLI’s agent-selection UI.

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

Set the description of what the agent does.

pub fn with_tools<I, S>(self, tools: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Restrict the agent to a specific tool allowlist. When unset, the agent inherits the parent session’s tool set.

pub fn with_mcp_servers( self, mcp_servers: IndexMap<String, McpServerConfig>, ) -> Self

Configure agent-specific MCP servers.

pub fn with_infer(self, infer: bool) -> Self

Whether the agent participates in model inference.

pub fn with_skills<I, S>(self, skills: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Set the skills preloaded into the agent’s context at startup.

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

Set the model identifier for this agent.

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

Set the reasoning effort level for this agent’s model.

Trait Implementations

impl Clone for CustomAgentConfig

fn clone(&self) -> CustomAgentConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CustomAgentConfig

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

Formats the value using the given formatter.

impl Default for CustomAgentConfig

fn default() -> CustomAgentConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CustomAgentConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CustomAgentConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.