Skip to main content

UpdateAgentRequest

Struct UpdateAgentRequest 

Source
#[non_exhaustive]
pub struct UpdateAgentRequest { pub version: u32, pub name: Option<String>, pub model: Option<AgentModel>, pub description: Option<String>, pub system: Option<String>, pub mcp_servers: Option<Vec<AgentMcpServer>>, pub skills: Option<Vec<Skill>>, pub tools: Option<Vec<AgentTool>>, pub metadata: Option<MetadataPatch>, pub callable_agents: Option<Vec<CallableAgent>>, }
Available on crate feature managed-agents-preview only.
Expand description

Request body for POST /v1/agents/{id} (update).

Optimistic concurrency: pass the agent’s current version. The request is rejected if the server’s stored version no longer matches.

Field semantics:

  • Option::None → omit the field → preserve the existing value.
  • Option::Some with empty string / empty array / null → clear, except for name and model which cannot be cleared.
  • For metadata, see MetadataPatch for per-key delete semantics.

Fields (Non-exhaustive)§

This struct is marked as 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.
§version: u32

Current version, used for optimistic concurrency. Required.

§name: Option<String>

New name (cannot be cleared).

§model: Option<AgentModel>

New model (cannot be cleared).

§description: Option<String>

New description. Some("") clears.

§system: Option<String>

New system prompt. Some("") clears.

§mcp_servers: Option<Vec<AgentMcpServer>>

Replacement MCP-servers list. Some(vec![]) clears.

§skills: Option<Vec<Skill>>

Replacement skills list. Some(vec![]) clears.

§tools: Option<Vec<AgentTool>>

Replacement tools list. Some(vec![]) clears.

§metadata: Option<MetadataPatch>

Per-key metadata patch. See MetadataPatch.

§callable_agents: Option<Vec<CallableAgent>>

Replacement callable-agents list. Some(vec![]) clears (turns the agent back into a non-coordinator).

Implementations§

Source§

impl UpdateAgentRequest

Source

pub fn at_version(version: u32) -> Self

Build a minimal update request (pass version, then chain setters).

Source

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

Set the name.

Source

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

Set the model.

Source

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

Set or clear (Some("")) the description.

Source

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

Set or clear (Some("")) the system prompt.

Source

pub fn mcp_servers(self, servers: Vec<AgentMcpServer>) -> Self

Replace the MCP servers list. Pass an empty Vec to clear.

Source

pub fn skills(self, skills: Vec<Skill>) -> Self

Replace the skills list. Pass an empty Vec to clear.

Source

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

Replace the tools list. Pass an empty Vec to clear.

Source

pub fn metadata(self, patch: MetadataPatch) -> Self

Apply a metadata patch.

Source

pub fn callable_agents(self, callable: Vec<CallableAgent>) -> Self

Replace the callable-agents list. Pass an empty Vec to clear.

Trait Implementations§

Source§

impl Clone for UpdateAgentRequest

Source§

fn clone(&self) -> UpdateAgentRequest

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 UpdateAgentRequest

Source§

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

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

impl Default for UpdateAgentRequest

Source§

fn default() -> UpdateAgentRequest

Returns the “default value” for a type. Read more
Source§

impl Serialize for UpdateAgentRequest

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
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> Same for T

Source§

type Output = T

Should always be Self
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