Struct AgentDefinition 

pub struct AgentDefinition {
    pub name: String,
    pub description: String,
    pub native: bool,
    pub hidden: bool,
    pub permissions: PermissionPolicy,
    pub model: Option<ModelConfig>,
    pub prompt: Option<String>,
    pub max_steps: Option<usize>,
    pub tool_free: bool,
    pub confirmation_inheritance: Option<ConfirmationInheritance>,
}

Agent definition

Defines the configuration and capabilities of an agent type.

Fields

name: String

Agent identifier (e.g., “explore”, “plan”, “general”)

description: String

Description of what the agent does

native: bool

Whether this is a built-in agent

hidden: bool

Whether to hide from UI

permissions: PermissionPolicy

Permission rules for this agent

model: Option<ModelConfig>

Optional model override

prompt: Option<String>

System prompt for this agent

max_steps: Option<usize>

Maximum execution steps (tool rounds)

tool_free: bool

Whether this role is a pure model decision with no visible or executable tools.

confirmation_inheritance: Option<ConfirmationInheritance>

How child runs resolve Ask decisions. Default: AutoApprove when the agent has explicit allow rules, DenyOnAsk otherwise.

Implementations

impl AgentDefinition

pub fn new(name: &str, description: &str) -> Self

Create a new agent definition

pub fn worker(spec: WorkerAgentSpec) -> Self

Create an agent definition from a disposable worker recipe.

pub fn native(self) -> Self

Mark as native (built-in)

pub fn hidden(self) -> Self

Mark as hidden from UI

pub fn with_permissions(self, permissions: PermissionPolicy) -> Self

Set permission policy

pub fn with_model(self, model: ModelConfig) -> Self

Set model override

pub fn with_prompt(self, prompt: &str) -> Self

Set system prompt

pub fn with_max_steps(self, max_steps: usize) -> Self

Set maximum execution steps

pub fn tool_free(self) -> Self

Make this role a pure LLM step. Tool definitions are removed before the child turn, and parent tool permissions are not inherited into it.

pub fn has_defined_permissions(&self) -> bool

Whether this definition has non-empty permission rules.

pub fn with_confirmation(self, inheritance: ConfirmationInheritance) -> Self

Set confirmation inheritance policy for child runs.

Trait Implementations

impl Clone for AgentDefinition

fn clone(&self) -> AgentDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<WorkerAgentSpec> for AgentDefinition

fn from(spec: WorkerAgentSpec) -> Self

Converts to this type from the input type.

impl Serialize for AgentDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.