Struct PromptAgentDefinition 

pub struct PromptAgentDefinition {
    pub name: String,
    pub model: String,
    pub instructions: Option<String>,
    pub description: Option<String>,
    pub tools: Vec<ToolDefinition>,
}

The serializable definition of a Foundry Prompt Agent: a name, a model, optional instructions/description, and its tools.

Maps to upstream’s PromptAgentDefinition (the declarative shape a Prompt Agent is created from, and that Agent.to_prompt_agent() emits). Used here to build a FoundryAgent (FoundryAgent::from_definition) and to read one back (FoundryAgent::to_prompt_agent).

ToolDefinition itself does not implement Serialize/Deserialize (a function tool carries a dyn Tool local executor, which isn’t serializable), so tools round-trips through a private wire shape capturing only the declarative fields a definition needs — see tool_definition_wire. A tool deserialized back out of a PromptAgentDefinition always has executor: None: a definition describes what a tool is, not a live local implementation to call it.

Fields

name: String

The agent’s name.

model: String

The model deployment this agent runs on.

instructions: Option<String>

The system prompt / instructions.

description: Option<String>

A human-readable description of what the agent does.

tools: Vec<ToolDefinition>

The tools available to the agent.

Implementations

impl PromptAgentDefinition

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

Create a definition with just a name and model — the minimum needed to run a Prompt Agent.

Trait Implementations

impl Clone for PromptAgentDefinition

fn clone(&self) -> PromptAgentDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PromptAgentDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PromptAgentDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for PromptAgentDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.