Struct AgentConfig 

pub struct AgentConfig { /* private fields */ }

Portable agent-wide runtime configuration.

Workspace model, reasoning-effort, and knowledge defaults belong to crate::workspace::WorkspaceDefaults, not this type.

Examples

use std::num::NonZeroUsize;
use std::time::Duration;
use agents_kit::{
    config::{AgentConfig, CodexConfig},
    KitError,
};

let agent_config = || -> Result<AgentConfig, KitError> {
    let backend = CodexConfig::spawn(
        Duration::from_secs(15),
        Duration::from_secs(60),
    )?;
    AgentConfig::new(
        backend.into(),
        Duration::from_secs(60),
        NonZeroUsize::new(1).expect("one is nonzero"),
    )?
    .with_display_name("documentation-agent")
};
let config = agent_config()?;
assert_eq!(config.display_name(), Some("documentation-agent"));

Implementations

impl AgentConfig

pub fn new( backend: BackendConfig, lifecycle_timeout: Duration, prompt_limit: NonZeroUsize, ) -> Result<Self, KitError>

Creates agent-wide configuration with tracing disabled and no optional text.

Errors

Returns crate::error::ErrorKind::InvalidConfig when the lifecycle timeout is zero or the selected backend configuration is invalid.

use agents_kit::config::{AgentConfig, CodexConfig};
use std::{num::NonZeroUsize, time::Duration};
let config = AgentConfig::new(CodexConfig::spawn(Duration::from_secs(15),
    Duration::from_secs(60))?.into(), Duration::from_secs(30), NonZeroUsize::MIN)?;
assert_eq!(config.lifecycle_timeout(), Duration::from_secs(30));
assert_eq!(config.prompt_limit().get(), 1);

pub fn with_display_name( self, display_name: impl Into<String>, ) -> Result<Self, KitError>

Sets a nonempty, unpadded display name.

Errors

Returns crate::error::ErrorKind::InvalidConfig for an empty or padded display name.

use agents_kit::config::{AgentConfig, CodexConfig};
use std::{num::NonZeroUsize, time::Duration};
let config = AgentConfig::new(CodexConfig::spawn(Duration::from_secs(15),
    Duration::from_secs(60))?.into(), Duration::from_secs(30), NonZeroUsize::MIN)?;
let config = config.with_display_name("worker")?;
assert_eq!(config.display_name(), Some("worker"));

pub fn with_instructions( self, instructions: impl Into<String>, ) -> Result<Self, KitError>

Sets nonempty, unpadded agent-level instructions.

Errors

Returns crate::error::ErrorKind::InvalidConfig for empty or padded instructions.

use agents_kit::config::{AgentConfig, CodexConfig};
use std::{num::NonZeroUsize, time::Duration};
let config = AgentConfig::new(CodexConfig::spawn(Duration::from_secs(15),
    Duration::from_secs(60))?.into(), Duration::from_secs(30), NonZeroUsize::MIN)?;
let config = config.with_instructions("Use concise answers.")?;
assert_eq!(config.instructions(), Some("Use concise answers."));

pub fn with_tracing_enabled(self, tracing_enabled: bool) -> Self

Enables or disables runtime tracing for this agent.

use agents_kit::config::{AgentConfig, CodexConfig};
use std::{num::NonZeroUsize, time::Duration};
let config = AgentConfig::new(CodexConfig::spawn(Duration::from_secs(15),
    Duration::from_secs(60))?.into(), Duration::from_secs(30), NonZeroUsize::MIN)?;
let config = config.with_tracing_enabled(true);
assert!(config.tracing_enabled());

pub fn with_default_prompt_timeout( self, timeout: Duration, ) -> Result<Self, KitError>

Sets the default foreground prompt timeout used when a request omits one.

Errors

Returns crate::error::ErrorKind::InvalidConfig when the timeout is zero.

use agents_kit::config::{AgentConfig, CodexConfig};
use std::{num::NonZeroUsize, time::Duration};
let config = AgentConfig::new(CodexConfig::spawn(Duration::from_secs(15),
    Duration::from_secs(60))?.into(), Duration::from_secs(30), NonZeroUsize::MIN)?;
let config = config.with_default_prompt_timeout(Duration::from_secs(45))?;
assert_eq!(config.default_prompt_timeout(), Some(Duration::from_secs(45)));

pub fn backend(&self) -> &BackendConfig

Returns the selected backend configuration.

use agents_kit::config::{AgentConfig, CodexConfig};
use std::{num::NonZeroUsize, time::Duration};
let config = AgentConfig::new(CodexConfig::spawn(Duration::from_secs(15),
    Duration::from_secs(60))?.into(), Duration::from_secs(30), NonZeroUsize::MIN)?;
assert!(matches!(config.backend(), agents_kit::config::BackendConfig::Codex(_)));

pub fn display_name(&self) -> Option<&str>

Returns the configured display name, when present.

use agents_kit::config::{AgentConfig, CodexConfig};
use std::{num::NonZeroUsize, time::Duration};
let config = AgentConfig::new(CodexConfig::spawn(Duration::from_secs(15),
    Duration::from_secs(60))?.into(), Duration::from_secs(30), NonZeroUsize::MIN)?;
assert_eq!(config.display_name(), None);

pub fn instructions(&self) -> Option<&str>

Returns the configured agent-level instructions, when present.

use agents_kit::config::{AgentConfig, CodexConfig};
use std::{num::NonZeroUsize, time::Duration};
let config = AgentConfig::new(CodexConfig::spawn(Duration::from_secs(15),
    Duration::from_secs(60))?.into(), Duration::from_secs(30), NonZeroUsize::MIN)?;
assert_eq!(config.instructions(), None);

pub fn tracing_enabled(&self) -> bool

Returns whether runtime tracing is enabled.

use agents_kit::config::{AgentConfig, CodexConfig};
use std::{num::NonZeroUsize, time::Duration};
let config = AgentConfig::new(CodexConfig::spawn(Duration::from_secs(15),
    Duration::from_secs(60))?.into(), Duration::from_secs(30), NonZeroUsize::MIN)?;
assert!(!config.tracing_enabled());

pub fn lifecycle_timeout(&self) -> Duration

Returns the bound used for agent lifecycle and recovery work.

use agents_kit::config::{AgentConfig, CodexConfig};
use std::{num::NonZeroUsize, time::Duration};
let config = AgentConfig::new(CodexConfig::spawn(Duration::from_secs(15),
    Duration::from_secs(60))?.into(), Duration::from_secs(30), NonZeroUsize::MIN)?;
assert_eq!(config.lifecycle_timeout(), Duration::from_secs(30));

pub fn prompt_limit(&self) -> NonZeroUsize

Returns the maximum number of concurrently admitted prompts for the agent.

use agents_kit::config::{AgentConfig, CodexConfig};
use std::{num::NonZeroUsize, time::Duration};
let config = AgentConfig::new(CodexConfig::spawn(Duration::from_secs(15),
    Duration::from_secs(60))?.into(), Duration::from_secs(30), NonZeroUsize::MIN)?;
assert_eq!(config.prompt_limit().get(), 1);

pub fn default_prompt_timeout(&self) -> Option<Duration>

Returns the default foreground prompt timeout, when configured.

use agents_kit::config::{AgentConfig, CodexConfig};
use std::{num::NonZeroUsize, time::Duration};
let config = AgentConfig::new(CodexConfig::spawn(Duration::from_secs(15),
    Duration::from_secs(60))?.into(), Duration::from_secs(30), NonZeroUsize::MIN)?;
assert_eq!(config.default_prompt_timeout(), None);

Trait Implementations

impl Clone for AgentConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentConfig

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

Formats the value using the given formatter.