Skip to main content

SubAgentDef

Struct SubAgentDef 

Source
pub struct SubAgentDef {
    pub name: String,
    pub description: String,
    pub prompt: String,
    pub allowed_tools: Vec<String>,
    pub disallowed_tools: Vec<String>,
    pub model: Option<String>,
    pub max_turns: usize,
    pub max_context_tokens: usize,
    pub background: bool,
}
Expand description

Definition of a subagent — its identity, capabilities, and constraints.

Analogous to a markdown frontmatter file in Claude Code’s subagent system.

Fields§

§name: String

Unique identifier (lowercase, hyphens). E.g. “code-reviewer”.

§description: String

When the parent agent should delegate to this subagent.

§prompt: String

The system prompt (markdown body). Replaces the default system prompt entirely.

§allowed_tools: Vec<String>

Allowed tool names. If empty, inherits all default tools. Use this as an allowlist: only these tools will be available.

§disallowed_tools: Vec<String>

Tool names to explicitly deny. Applied after allowed_tools.

§model: Option<String>

Model override. If None, inherits from the parent.

§max_turns: usize

Maximum agentic turns before the subagent stops.

§max_context_tokens: usize

Maximum context window tokens.

§background: bool

Whether to always run this subagent in the background.

Implementations§

Source§

impl SubAgentDef

Source

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

Create a new subagent definition with required fields.

Source

pub fn with_allowed_tools(self, tools: Vec<String>) -> Self

Restrict the subagent to only these tools.

Source

pub fn with_disallowed_tools(self, tools: Vec<String>) -> Self

Deny specific tools (removed from inherited or allowed set).

Source

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

Override the model for this subagent.

Source

pub fn with_max_turns(self, max_turns: usize) -> Self

Set maximum agentic turns.

Source

pub fn with_max_context_tokens(self, tokens: usize) -> Self

Set maximum context window tokens.

Source

pub fn with_background(self, background: bool) -> Self

Set whether to always run in background.

Trait Implementations§

Source§

impl Clone for SubAgentDef

Source§

fn clone(&self) -> SubAgentDef

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SubAgentDef

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for SubAgentDef

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for SubAgentDef

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,