Struct Agent 

pub struct Agent {

    pub public_id: AgentId,
    pub internal_id: Uuid,
    pub name: String,
    pub display_name: Option<String>,
    pub description: Option<String>,
    pub system_prompt: String,
    pub default_model_id: Option<ModelId>,
    pub default_version_id: Option<AgentVersionId>,
    pub forked_from_agent_id: Option<AgentId>,
    pub forked_from_version_id: Option<AgentVersionId>,
    pub root_agent_id: Option<AgentId>,
    pub tags: Vec<String>,
    pub capabilities: Vec<AgentCapabilityConfig>,
    pub initial_files: Vec<InitialFile>,
    pub network_access: Option<NetworkAccessList>,
    pub max_iterations: Option<usize>,
    pub tools: Vec<ToolDefinition>,
    pub mcp_servers: ScopedMcpServers,
    pub status: AgentStatus,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
    pub archived_at: Option<DateTime<Utc>>,
    pub deleted_at: Option<DateTime<Utc>>,
    pub usage: Option<TokenUsage>,
}

Agent configuration for agentic loop. An agent defines the behavior and capabilities of an AI assistant.

Fields

public_id: AgentId

External identifier (agent_<32-hex>). Shown as “id” in API. Client-supplied or auto-generated.

internal_id: Uuid

Internal UUID primary key. Used for FK references. Never exposed in API.

name: String

Name, unique per org (e.g. “customer-support”).

display_name: Option<String>

Human-readable display name shown in UI (e.g. “Customer Support Agent”). Falls back to name when absent.

description: Option<String>

Human-readable description of what the agent does.

system_prompt: String

System prompt that defines the agent’s behavior. Sent as the first message in every conversation.

default_model_id: Option<ModelId>

Default LLM model ID for this agent. Can be overridden at the session level.

default_version_id: Option<AgentVersionId>

Default immutable version used by deployments that choose the default policy.

forked_from_agent_id: Option<AgentId>

Source agent for a forked agent.

forked_from_version_id: Option<AgentVersionId>

Source version for a forked agent.

root_agent_id: Option<AgentId>

Root agent lineage identifier for grouping fork families.

tags: Vec<String>

Tags for organizing and filtering agents.

capabilities: Vec<AgentCapabilityConfig>

Capabilities enabled for this agent with per-agent configuration. Capabilities add tools and system prompt modifications.

initial_files: Vec<InitialFile>

Starter files copied into each new session for this agent.

network_access: Option<NetworkAccessList>

Network access list controlling which hosts/URLs agent sessions can reach. Merged with harness and session layers (allowed: intersect, blocked: union).

max_iterations: Option<usize>

Maximum number of LLM iterations per turn for this agent.

tools: Vec<ToolDefinition>

Client-side tools registered for this agent. These tools are executed by the client, not the server.

mcp_servers: ScopedMcpServers

Remote MCP servers scoped to this agent and inherited by its sessions.

status: AgentStatus

Current lifecycle status of the agent.

created_at: DateTime<Utc>

Timestamp when the agent was created.

updated_at: DateTime<Utc>

Timestamp when the agent was last updated.

archived_at: Option<DateTime<Utc>>

Timestamp when the agent was archived.

deleted_at: Option<DateTime<Utc>>

Timestamp when the agent was deleted.

usage: Option<TokenUsage>

Cumulative token usage across all sessions for this agent.

Trait Implementations

impl Clone for Agent

fn clone(&self) -> Agent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Agent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Agent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Agent> for AgentConfigOverlay

fn from(a: &Agent) -> Self

Converts to this type from the input type.

impl HasAuditTargetId for Agent

fn audit_target_id(&self) -> Option<String>

impl Serialize for Agent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.