Struct AgentDefinition 

pub struct AgentDefinition {

    pub id: String,
    pub slug: String,
    pub name: String,
    pub icon: String,
    pub provider: String,
    pub description: String,
    pub working_directory: String,
    pub shell: String,
    pub provider_flags: String,
    pub auto_start: i64,
    pub restart_on_crash: i64,
    pub idle_timeout_minutes: i64,
    pub created_at: i64,
    pub agent_type: String,
    pub environment: String,
    pub agent_bus_id: String,
    pub is_seeded: i64,
    pub accounts: String,
    pub parent_id: String,
    pub branch_label: String,
    pub updated_at: i64,
    pub user_hidden: i64,
    pub container_image: String,
    pub container_volumes: String,
    pub container_name: String,
    pub use_ambient_login: i64,
    pub model_vendor_base_url: String,
    pub auto_continue_enabled: i64,
    pub memory_id: String,
    pub conversation_visibility: String,
}

A user-defined AI agent in the user’s agent-definition catalog.

Fields

id: String

slug: String

Stable, filesystem-safe identifier. Drives working directory, env var keys (AGENTMUX_AGENT_ID), and cross-references. NEVER changes after creation — distinct from name which is the renameable display. See docs/specs/SPEC_AGENT_IDENTITY_RESTRUCTURE_2026_04_14.md.

name: String

icon: String

provider: String

description: String

working_directory: String

shell: String

provider_flags: String

auto_start: i64

restart_on_crash: i64

idle_timeout_minutes: i64

created_at: i64

agent_type: String

environment: String

agent_bus_id: String

is_seeded: i64

accounts: String

JSON-encoded per-provider account assignments ({"github":"acct-id", …}). Written by the Agent pane’s Identity tab (AgentIdentityPanel) via updateagent, read back by parseAgentAccounts and consumed by startup credential resolution. (An older v6 comment called this deprecated in favour of db_agent_identity_links; that migration never completed — the JSON blob is still the live store, so the schema flatten keeps the column.)

parent_id: String

Parent definition id (db_agent_definitions.id). Empty string = root definition; non-empty = this agent was forked from another. Added in v6. See spec §Phase 1.

branch_label: String

Label describing the branch (e.g. "pr-422-review", "experiment-refactor"). Empty for root definitions and for branches that didn’t set a label. Added in v6.

updated_at: i64

Last-modified timestamp (epoch ms). Set to created_at on insert and refreshed on every agent_def_update. Schema v2. 0 for rows written before v2 (until next update).

user_hidden: i64

Per-user hide flag for seeded templates. 1 = the user clicked “Hide template” on the picker’s + New from template tier; the row stays on disk (templates are manifest-managed; deletion would fight re-seed) but the default listagents view filters it out. Reset to 0 by the agent-seed re-sync flow for any NEW template id newly added to the manifest, so a fresh template surfaces once even if a same-named one was previously hidden. Schema v3 (Phase 2 of SPEC_AGENT_PICKER_TWO_TIER_2026_05_24.md — Q2 Decision Y). User-owned rows (is_seeded = 0) MUST stay at 0 here; their removal path is deleteagent, not hide.

container_image: String

Docker image to use when agent_type == "container". e.g. "ghcr.io/agentmuxai/agent-base:latest". Empty string for host agents. Schema v6.

container_volumes: String

JSON array of volume mount specs for container agents. Each element is a string in Docker bind-mount format: "source:target" or "source:target:options". Empty JSON array ("[]") for host agents. Schema v6.

container_name: String

Stable Docker container name managed by the server. Set to "agentmux-<slug>" on first container spawn; empty for host agents. Schema v6.

use_ambient_login: i64

Inert. It was a per-agent opt-in to the CLI’s global login when no account resolved at spawn; the spawn gate no longer reads it (an oauth-class agent with no bound account is always refused), no RPC sets it and no UI shows it. The column and this field stay only so the shared definition registry keeps the value older builds read (m0017/m0018 grandfathered linkless agents to 1 there). SPEC_MY_AGENTS_TILES_AUTH_AND_HISTORY_2026_10_03.md R10.

model_vendor_base_url: String

Redirects this agent’s harness (CLI) at a non-default model vendor backend — e.g. "https://my-proxy.example.com" for a claude-provider agent, injected into ANTHROPIC_BASE_URL at spawn time. Empty string (default) = use the harness’s default vendor endpoint. Only settable when the resolved provider declares ProviderConfig::base_url_env_var (validated in agent_define_core) — see docs/specs for the harness vs. model-vendor concept this formalizes. Schema v15. Channel-local: does not currently survive a cross-channel reopen of the same agent (known limitation, not wired into the registry mirror).

auto_continue_enabled: i64

Per-agent opt-in: when non-zero, a running Warden Supervisor watcher agent is permitted to auto-continue this agent’s session on turn-end (subject to a server-side consecutive-nudge ceiling). Default 0 = opt-in required. Schema v17. Toggled from the Warden Supervisor panel. See docs/analysis/ANALYSIS_WARDEN_AUTO_CONTROLLER_CONTINUATION_WATCHER_2026_08_12.md.

memory_id: String

The agent’s own dedicated ABF bundle (db_bundles.id). Distinct from AgentInstance.memory_id (a specific launch’s bundle, which can still be pointed at a different bundle on purpose — this is just the default a launch inherits when it doesn’t override). Empty string = not yet provisioned (legacy row predating this field, or a definition awaiting m0021’s backfill). Stored in db_agents.default_memory_id — a separate column from db_agents.memory_id, which is the instance-scoped field this doc paragraph opens by distinguishing it from. Schema v19; the two-column split dates to ARCHITECTURE_MANDATORY_ABF_RETHINK_2026_08_14.md §3.1.

conversation_visibility: String

This agent’s own disclosure policy for an incoming cross-tier transcript_request jekt (muxspect Phase B/C — LAN/WAN conversation visibility, SPEC_MUXSPECT_CROSS_TIER_CONVERSATION_VISIBILITY_2026_08_21.md, jekt tier rules confirmed in SPEC_JEKT_TRANSCRIPT_REQUEST_TIER_RULES_2026_08_22.md). One of "private" (default — auto-deny, fail-closed), "trusted_peers" (auto-approve only a requester in db_conversation_trust_grants), or "ask" (force human escalation, never auto-respond). Schema v26. Channel-local only, like model_vendor_base_url/memory_id above — deliberately NOT added to DefinitionRecordV1’s cross-channel wire format yet; a cross-channel-reopened agent starts back at the safe "private" default rather than carrying a stale value. Known limitation, not a bug — same precedent as those two fields.

Trait Implementations

impl Clone for AgentDefinition

fn clone(&self) -> AgentDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AgentDefinition

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for AgentDefinition

type WithoutGenerics = AgentDefinition

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = AgentDefinition

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use [TS::export_all].

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use [TS::export].

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.