Struct CommandAgentDefineData 

pub struct CommandAgentDefineData {

    pub name: String,
    pub provider: String,
    pub model: String,
    pub icon: String,
    pub description: String,
    pub working_directory: String,
    pub shell: String,
    pub environment: String,
    pub system_prompt: Option<String>,
    pub env: Option<HashMap<String, String>>,
    pub if_exists: Option<String>,
    pub create_instance_stub: Option<bool>,
    pub agent_type: String,
    pub container_image: String,
    pub container_volumes: String,
}

Request for agent.define — create or upsert an agent definition. if_exists controls behaviour when a slug-matching definition exists: "skip" (default) — return existing id unchanged "update" — overwrite all provided non-empty fields "error" — fail with an error message

Fields

name: String

provider: String

model: String

Alternative to provider — inferred from model prefix. If both are set, provider wins.

icon: String

description: String

working_directory: String

shell: String

environment: String

system_prompt: Option<String>

System/instruction text written to the agent’s CLAUDE.md on spawn.

env: Option<HashMap<String, String>>

Extra env vars injected at agent spawn, stored as KEY=VALUE lines.

if_exists: Option<String>

create_instance_stub: Option<bool>

agent_type: String

“host” or “container”. Defaults to “host” when absent — the safe default that works without Docker. Callers must explicitly pass “container” so a missing field never silently starts the wrong runtime.

container_image: String

Docker image for container-type agents. Empty string for host agents.

container_volumes: String

JSON array of volume mount specs. Empty array ("[]") for host agents.

Trait Implementations

impl Clone for CommandAgentDefineData

fn clone(&self) -> CommandAgentDefineData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandAgentDefineData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CommandAgentDefineData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.