Skip to main content

Agent

Struct Agent 

Source
pub struct Agent {
Show 17 fields pub runtime: String, pub model: Option<String>, pub role_prompt: Option<RolePrompt>, pub permission_mode: Option<String>, pub autonomy: String, pub can_dm: Vec<String>, pub can_broadcast: Vec<String>, pub reports_to: Option<String>, pub on_rate_limit: Option<Vec<String>>, pub effort: Option<EffortLevel>, pub ultracode: bool, pub interfaces: Option<AgentInterfaces>, pub display_name: Option<String>, pub hooks: Vec<HookSpec>, pub mcps: BTreeMap<String, McpServer>, pub subagents: Vec<PathBuf>, pub skills: Vec<PathBuf>,
}

Fields§

§runtime: String§model: Option<String>§role_prompt: Option<RolePrompt>§permission_mode: Option<String>§autonomy: String§can_dm: Vec<String>§can_broadcast: Vec<String>§reports_to: Option<String>§on_rate_limit: Option<Vec<String>>

Override the global rate-limit hook chain for this agent.

§effort: Option<EffortLevel>

Per-agent reasoning effort. Renders as EFFORT=<value> in the agent env file; the wrapper passes it to the runtime (e.g. claude --effort <value>). Strict enum: typos like hgih fail compose validation rather than silently falling back to the wrapper default.

§ultracode: bool

#461: per-agent ultracode opt-in. When true, teamctl emits "ultracode": true into the agent’s Claude Code settings JSON (the file the wrapper passes via --settings); the resulting session behavior is Claude Code’s, not teamctl’s. ultracode is a Claude Code setting — not an effort level and not a CLI flag — so it’s orthogonal to effort: above (which rides the --effort flag) and the two compose freely. Like the enableAllProjectMcpServers key in render_claude_settings, the name is vendor-owned: verified against Claude Code 2.1.175, and a future rename would silently no-op. claude-only v1: on non-claude runtimes the settings file is skipped and a declared opt-in warns (codex/gemini have no equivalent). Defaults to false → the settings JSON is byte-unchanged for agents that don’t opt in.

§interfaces: Option<AgentInterfaces>

Per-manager human-facing interfaces. Today’s only adapter is telegram; the shape is reserved for future adapters (discord, imessage, …) so a manager can declare every channel it speaks on in one place. Workers leave this unset.

§display_name: Option<String>

T-160: optional human-friendly label rendered by the TUI in place of the agent id (roster, details header, mailbox row attribution, statusline). Absent → render the agent id (current behavior). Validation: non-empty, ≤64 chars, UTF-8 anything. The agent id stays canonical for routing, tmux session names, CLI args, and YAML cross-refs (can_dm, can_broadcast, reports_to) — display_name is render-time only.

§hooks: Vec<HookSpec>

#383 Phase 2: per-agent Claude Code hooks, merged additively into the per-agent settings.json that render already builds, on top of the built-in interactive-prompt deny hook (which keeps precedence — see render::render_claude_settings). Commands are compose-root-relative paths, resolved like role_prompt. claude-only v1: declared on a non-claude-code agent they render nothing and render logs an “unsupported runtime” warning. Empty (the default) → settings unchanged.

§mcps: BTreeMap<String, McpServer>

#383 Phase 4: per-agent MCP servers, merged into the rendered per-agent MCP config alongside the built-in team mailbox server (which stays unconditional and non-clobberable — a declared server named team is rejected at validate and skipped at render). Unlike hooks, MCP is runtime-agnostic: declared servers render for every runtime whose descriptor sets supports_mcp, and are skipped with a warning otherwise. Empty (the default) → MCP config unchanged.

§subagents: Vec<PathBuf>

#383 Phase 3a: per-agent Claude Code sub-agents declared in compose. Each entry is a compose-root-relative path to a standard sub-agent markdown file (frontmatter name / description / optional tools / model, body → the sub-agent’s system prompt), resolved like role_prompt. render transforms the list into Claude Code’s --agents inline JSON so each agent gets its own sub-agents additively, on top of the project .claude/agents/ and the built-in sub-agents (verified: --agents adds, never replaces), without an arbitrary-path flag (the only cwd-stationary mechanism — see the Phase-1 spike). claude-only v1: declared on a non-claude-code agent they render nothing and render logs an “unsupported runtime” warning. Empty (the default) → no --agents flag.

§skills: Vec<PathBuf>

#383 Phase 3b: per-agent Claude Code skills declared in compose. Each entry is a compose-root-relative path to a skill directory (the folder holding SKILL.md), resolved like role_prompt. render materializes a per-agent scope dir under state/agent-scope/<project>-<agent>/.claude/skills/ holding a symlink to each declared skill, and the wrapper passes that scope dir via claude --add-dir so the agent discovers its skills additively, on top of the project .claude/skills/ (verified: --add-dir adds, never replaces — see the Phase-1 spike §9-E1). claude-only v1: declared on a non-claude-code agent they materialize nothing and render logs an “unsupported runtime” warning. Empty (the default) → no --add-dir flag.

Implementations§

Source§

impl Agent

Source

pub fn telegram(&self) -> Option<&TelegramConfig>

Convenience: pull the manager’s Telegram config out of interfaces.telegram without forcing every callsite to handle the nested options.

Trait Implementations§

Source§

impl Clone for Agent

Source§

fn clone(&self) -> Agent

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Agent

Source§

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

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

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Agent

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§

§

impl Freeze for Agent

§

impl RefUnwindSafe for Agent

§

impl Send for Agent

§

impl Sync for Agent

§

impl Unpin for Agent

§

impl UnsafeUnpin for Agent

§

impl UnwindSafe for Agent

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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