Header menu logo Nao

AgentDef Type

Parsed agent definition loaded from JSON configuration. References tools and sub-agents by name; resolved at build time.

Record fields

Record Field Description

Description

Full Usage: Description

Field type: string

Human-readable description of the agent's purpose

Field type: string

IsAsync

Full Usage: IsAsync

Field type: bool

When true, selecting this agent runs the turn as a background task (a spawned sub-session conversation) rather than inline; the turn returns a task token.

Field type: bool

MaxRounds

Full Usage: MaxRounds

Field type: int

Maximum orchestration rounds before forcing a response

Field type: int

Model

Full Usage: Model

Field type: string

Model identifier (e.g. "llama3", "gpt-4o")

Field type: string

Name

Full Usage: Name

Field type: string

Unique name identifying this agent definition

Field type: string

Options

Full Usage: Options

Field type: CompletionOptions

LLM completion options (temperature, max tokens, etc.)

Field type: CompletionOptions

Prompt

Full Usage: Prompt

Field type: Prompt

Structured prompt defining the agent's behavior

Field type: Prompt

Provenance

Full Usage: Provenance

Field type: ToolProvenance option

Where this agent definition came from (populated by the loading source).

Field type: ToolProvenance option

Provider

Full Usage: Provider

Field type: string

LLM provider name (e.g. "ollama", "openai", "anthropic")

Field type: string

SubAgents

Full Usage: SubAgents

Field type: string list

Sub-agent names for delegation (resolved from workspace)

Field type: string list

Tools

Full Usage: Tools

Field type: string list

Tool names this agent can invoke (resolved from workspace)

Field type: string list

Version

Full Usage: Version

Field type: string option

Optional version identifier (e.g. "1.0"). None = unversioned; matches any requested version.

Field type: string option

Type something to start searching.