agents

Classes

AgenticAdapter

Defined in: packages/nexus-agents/src/agents/agentic/agentic-adapter.ts:97

Agents exports - Agent framework, Orchestrator, Experts Split from index.ts for file size compliance (Issue #285)

Implements

• IAgenticAdapter

Constructors

Constructor

new AgenticAdapter(modelAdapter, options?): AgenticAdapter;

Defined in: packages/nexus-agents/src/agents/agentic/agentic-adapter.ts:120

Parameters

modelAdapter

IModelAdapter

options?

AgenticAdapterOptions = {}

Returns

AgenticAdapter

Properties

adapterStrategy

adapterStrategy: string;

Defined in: packages/nexus-agents/src/agents/agentic/agentic-adapter.ts:110

Adapter strategy stamp — composed from the resolved model identity, NOT the IModelAdapter’s providerId. For a custom OpenAI gateway fronting Claude, this reads native:anthropic even though IModelAdapter.providerId === 'openai'.

Initialised eagerly from the modelId parse (sync); upgraded after the first runAgent if the probe contributes a higher-confidence vendor signal.

Implementation of

IAgenticAdapter.adapterStrategy

modelId

readonly modelId: string;

Defined in: packages/nexus-agents/src/agents/agentic/agentic-adapter.ts:99

Implementation of

IAgenticAdapter.modelId

providerId

readonly providerId: string;

Defined in: packages/nexus-agents/src/agents/agentic/agentic-adapter.ts:98

Implementation of

IAgenticAdapter.providerId

Methods

getProfile()

getProfile(): ModelEntry;

Defined in: packages/nexus-agents/src/agents/agentic/agentic-adapter.ts:152

Read-only accessor for the resolved profile. Mostly used in tests

• observability surfaces; production callers shouldn’t need this.

Returns

ModelEntry

getResolvedIdentity()

getResolvedIdentity(): ResolvedModelIdentity;

Defined in: packages/nexus-agents/src/agents/agentic/agentic-adapter.ts:161

Read-only accessor for the resolved identity. After the first runAgent call (if a probe ran), this may differ from what the sync constructor stored — useful for audit logs.

Returns

ResolvedModelIdentity

runAgent()

runAgent(args): Promise<Result<AgentRunResult, AgentError>>;

Defined in: packages/nexus-agents/src/agents/agentic/agentic-adapter.ts:228

Parameters

args

RunAgentArgs

Returns

Promise<Result<AgentRunResult, AgentError>>

Implementation of

IAgenticAdapter.runAgent

AgentStateMachine

Defined in: packages/nexus-agents/src/agents/state-machine.ts:42

Agent State Machine.

Manages agent lifecycle states with validation, event callbacks, and error recovery mechanisms.

Constructors

Constructor

new AgentStateMachine(options?): AgentStateMachine;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:53

Parameters

options?

StateMachineOptions = {}

Returns

AgentStateMachine

Accessors

errors

Get Signature

get errors(): number;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:77

Gets the current error count.

Returns

number

state

Get Signature

get state(): AgentState;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:63

Gets the current state.

Returns

AgentState

transitionHistory

Get Signature

get transitionHistory(): readonly StateTransition[];

Defined in: packages/nexus-agents/src/agents/state-machine.ts:70

Gets the transition history.

Returns

readonly StateTransition[]

Methods

canTransition()

canTransition(event): boolean;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:84

Checks if a transition is valid from the current state.

Parameters

event

StateTransitionEvent

Returns

boolean

forceError()

forceError(context?): void;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:146

Forces a transition to the error state. Use for unrecoverable errors that should bypass normal transition rules.

Parameters

context?

Record<string, unknown>

Optional context data about the error

Returns

void

getNextState()

getNextState(event): AgentState | undefined;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:92

Gets the next state for an event, if valid.

Parameters

event

StateTransitionEvent

Returns

AgentState | undefined

getValidEvents()

getValidEvents(): StateTransitionEvent[];

Defined in: packages/nexus-agents/src/agents/state-machine.ts:100

Gets all valid events from the current state.

Returns

StateTransitionEvent[]

hasError()

hasError(): boolean;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:250

Checks if the agent is in an error state.

Returns

boolean

isAvailable()

isAvailable(): boolean;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:236

Checks if the agent is in a state where it can accept new tasks.

Returns

boolean

isWorking()

isWorking(): boolean;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:243

Checks if the agent is currently working.

Returns

boolean

onStateChange()

onStateChange(callback): () => void;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:213

Subscribes to state change events.

Parameters

callback

StateChangeCallback

Callback to invoke on state changes

Returns

Unsubscribe function

() => void

onTransitionError()

onTransitionError(callback): () => void;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:226

Subscribes to transition error events.

Parameters

callback

TransitionErrorCallback

Callback to invoke on transition errors

Returns

Unsubscribe function

() => void

recover()

recover(context?): Result<AgentState, AgentError>;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:161

Attempts recovery from the error state.

Parameters

context?

Record<string, unknown>

Optional context data about the recovery

Returns

Result<AgentState, AgentError>

Result with the new state or an AgentError if recovery failed

reset()

reset(clearHistory?): void;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:199

Resets the state machine to its initial state.

Parameters

clearHistory?

boolean = false

Whether to clear the transition history

Returns

void

resetErrorCount()

resetErrorCount(): void;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:190

Resets the error count. Call after successful task completion.

Returns

void

transition()

transition(event, context?): Result<AgentState, AgentError>;

Defined in: packages/nexus-agents/src/agents/state-machine.ts:112

Attempts a state transition.

Parameters

event

StateTransitionEvent

The event triggering the transition

context?

Record<string, unknown>

Optional context data for the transition

Returns

Result<AgentState, AgentError>

Result with the new state or an AgentError

ArchitectureExpert

Defined in: packages/nexus-agents/src/agents/experts/architecture-expert.ts:64

ArchitectureExpert - Expert agent for architecture-related tasks.

Extends

• BaseAgent

Constructors

Constructor

new ArchitectureExpert(options?): ArchitectureExpert;

Defined in: packages/nexus-agents/src/agents/experts/architecture-expert.ts:67

Parameters

options?

Partial<BaseAgentOptions> & { expertOptions?: ArchitectureExpertOptions; } = {}

Returns

ArchitectureExpert

Overrides

BaseAgent.constructor

Properties

adapter

protected adapter: IModelAdapter | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:98

Inherited from

BaseAgent.adapter

budgetTracker

protected readonly budgetTracker: ITokenBudgetTracker;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:97

Inherited from

BaseAgent.budgetTracker

capabilities

readonly capabilities: readonly AgentCapability[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:95

Agent capabilities

Inherited from

BaseAgent.capabilities

config

protected config: AgentConfig | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:100

Inherited from

BaseAgent.config

emitMessageEvents

protected readonly emitMessageEvents: boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:107

Inherited from

BaseAgent.emitMessageEvents

eventBus

protected readonly eventBus: ICollaborationEventBus;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:106

Inherited from

BaseAgent.eventBus

history

protected history: Message[] = [];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:102

Inherited from

BaseAgent.history

id

readonly id: string;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:93

Unique agent identifier

Inherited from

BaseAgent.id

logger

protected readonly logger: ILogger;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:99

Inherited from

BaseAgent.logger

maxTokens

protected readonly maxTokens: number;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:105

Inherited from

BaseAgent.maxTokens

role

readonly role: AgentRole;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:94

Agent role

Inherited from

BaseAgent.role

sharedState

protected sharedState: Record<string, unknown> = {};

Defined in: packages/nexus-agents/src/agents/base-agent.ts:101

Inherited from

BaseAgent.sharedState

stateMachine

protected readonly stateMachine: AgentStateMachine;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:96

Inherited from

BaseAgent.stateMachine

systemPrompt

protected readonly systemPrompt: string | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:103

Inherited from

BaseAgent.systemPrompt

temperature

protected readonly temperature: number;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:104

Inherited from

BaseAgent.temperature

Accessors

state

Get Signature

get state(): AgentState;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:176

Current state

Returns

AgentState

Current state

Inherited from

BaseAgent.state

Methods

addContextItem()

protected addContextItem(
   content, 
   priority?, 
   category?
): Promise<void>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:344

Parameters

content

string

priority?

100 | 20 | 60 | 80 | 40

category?

"system" | "task" | "active"

Returns

Promise<void>

Inherited from

BaseAgent.addContextItem

addToHistory()

protected addToHistory(message): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:331

Parameters

message

Message

Returns

void

Inherited from

BaseAgent.addToHistory

buildPrompt()

protected buildPrompt(task): Message[];

Defined in: packages/nexus-agents/src/agents/experts/architecture-expert.ts:95

Parameters

task

Task

Returns

Message[]

Overrides

BaseAgent.buildPrompt

cleanup()

cleanup(): Promise<void>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:276

Cleanup agent resources.

Returns

Promise<void>

Inherited from

BaseAgent.cleanup

clearHistory()

protected clearHistory(): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:337

Returns

void

Inherited from

BaseAgent.clearHistory

complete()

protected complete(request): Promise<Result<CompletionResponse, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:303

Parameters

request

CompletionRequest

Returns

Promise<Result<CompletionResponse, AgentError>>

Inherited from

BaseAgent.complete

execute()

execute(task, options?): Promise<Result<TaskResult, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:218

Execute a task.

Parameters

task

Task

Task to execute

options?

Optional execution options (#3016/#3040). signal cancels the in-flight model call when the caller’s deadline wins a race; without it, the SDK keeps running to its own 10-minute timeout after the caller has already discarded the result.

signal?

AbortSignal

Returns

Promise<Result<TaskResult, AgentError>>

Result with TaskResult or AgentError

Inherited from

BaseAgent.execute

executeTask()

protected executeTask(task): Promise<Result<TaskResult, AgentError>>;

Defined in: packages/nexus-agents/src/agents/experts/architecture-expert.ts:77

Parameters

task

Task

Returns

Promise<Result<TaskResult, AgentError>>

Overrides

BaseAgent.executeTask

findResolutionForError()

protected findResolutionForError(errorMessage): ErrorResolution | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:393

Parameters

errorMessage

string

Returns

ErrorResolution | undefined

Inherited from

BaseAgent.findResolutionForError

flushMemory()

flushMemory(): Promise<Result<void, AgentMemoryError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:371

Returns

Promise<Result<void, AgentMemoryError>>

Inherited from

BaseAgent.flushMemory

getExpertOptions()

getExpertOptions(): Readonly<ArchitectureExpertOptions>;

Defined in: packages/nexus-agents/src/agents/experts/architecture-expert.ts:111

Returns

Readonly<ArchitectureExpertOptions>

getHistory()

protected getHistory(): Message[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:334

Returns

Message[]

Inherited from

BaseAgent.getHistory

getMemoryState()

getMemoryState(): Readonly<AgentMemoryState> | null;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:364

Returns

Readonly<AgentMemoryState> | null

Inherited from

BaseAgent.getMemoryState

getPruningMetrics()

getPruningMetrics(): Readonly<ContextPruningMetrics>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:340

Returns

Readonly<ContextPruningMetrics>

Inherited from

BaseAgent.getPruningMetrics

getRelevantMemories()

getRelevantMemories(): readonly TypedMemoryEntry<MemoryType>[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:367

Returns

readonly TypedMemoryEntry<MemoryType>[]

Inherited from

BaseAgent.getRelevantMemories

getTaskLearnings()

protected getTaskLearnings(taskType): readonly TaskLearning[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:396

Parameters

taskType

string

Returns

readonly TaskLearning[]

Inherited from

BaseAgent.getTaskLearnings

handleMessage()

handleMessage(msg): Promise<Result<AgentResponse, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:261

Handle an inter-agent message and return a response.

Delivery semantics (#3222). This is a direct, awaited request/response call: the caller invokes it and holds the returned promise. It is NOT a queued or broadcast channel — that is the collaboration event bus (agents/collaboration/event-bus.ts), a fire-and-forget pub/sub with its own semantics. For this method specifically:

• Ordering is the caller’s responsibility. Sequential awaits are handled in call order; concurrent calls carry no cross-message ordering guarantee.
• Delivery is exactly the method invocation — there is no automatic retry or redelivery. A returned err(...) is the caller’s signal to decide whether to retry; the agent does not re-queue the message.
• Errors surface as Result.err, not as a throw for expected conditions; the caller branches on the Result.

Parameters

msg

AgentMessage

Message to handle

Returns

Promise<Result<AgentResponse, AgentError>>

Result with AgentResponse, or AgentError on failure (not retried)

Inherited from

BaseAgent.handleMessage

hasCapability()

hasCapability(capability): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:292

Parameters

capability

AgentCapability

Returns

boolean

Inherited from

BaseAgent.hasCapability

initialize()

initialize(ctx): Promise<Result<void, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:205

Initialize the agent with context.

Parameters

ctx

AgentContext

Agent context

Returns

Promise<Result<void, AgentError>>

Result with void or AgentError

Inherited from

BaseAgent.initialize

isContextPruningEnabled()

isContextPruningEnabled(): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:358

Returns

boolean

Inherited from

BaseAgent.isContextPruningEnabled

isMemoryEnabled()

isMemoryEnabled(): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:361

Returns

boolean

Inherited from

BaseAgent.isMemoryEnabled

recordLearning()

protected recordLearning(learning): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:384

Parameters

learning

Omit<TaskLearning, "id" | "learnedAt">

Returns

void

Inherited from

BaseAgent.recordLearning

recordPattern()

protected recordPattern(p): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:387

Parameters

p

Omit<ExecutionPattern, "id" | "lastSeen" | "occurrences">

Returns

void

Inherited from

BaseAgent.recordPattern

recordResolution()

protected recordResolution(r): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:390

Parameters

r

Omit<ErrorResolution, "resolvedAt">

Returns

void

Inherited from

BaseAgent.recordResolution

transformError()

protected transformError(error, taskId): AgentError;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:299

Parameters

error

unknown

taskId

string

Returns

AgentError

Inherited from

BaseAgent.transformError

abstract BaseAgent

Defined in: packages/nexus-agents/src/agents/base-agent.ts:92

Abstract base class for all agents. Subclasses must implement executeTask and buildPrompt.

Extended by

• SimpleAgent
• Orchestrator
• CodeExpert
• SecurityExpert
• ArchitectureExpert
• TestingExpert
• DocumentationExpert

Implements

• IAgent

Constructors

Constructor

new BaseAgent(options): BaseAgent;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:129

Parameters

options

BaseAgentOptions

Returns

BaseAgent

Properties

adapter

protected adapter: IModelAdapter | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:98

budgetTracker

protected readonly budgetTracker: ITokenBudgetTracker;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:97

capabilities

readonly capabilities: readonly AgentCapability[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:95

Agent capabilities

Implementation of

IAgent.capabilities

config

protected config: AgentConfig | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:100

emitMessageEvents

protected readonly emitMessageEvents: boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:107

eventBus

protected readonly eventBus: ICollaborationEventBus;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:106

history

protected history: Message[] = [];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:102

id

readonly id: string;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:93

Unique agent identifier

Implementation of

IAgent.id

logger

protected readonly logger: ILogger;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:99

maxTokens

protected readonly maxTokens: number;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:105

role

readonly role: AgentRole;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:94

Agent role

Implementation of

IAgent.role

sharedState

protected sharedState: Record<string, unknown> = {};

Defined in: packages/nexus-agents/src/agents/base-agent.ts:101

stateMachine

protected readonly stateMachine: AgentStateMachine;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:96

systemPrompt

protected readonly systemPrompt: string | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:103

temperature

protected readonly temperature: number;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:104

Accessors

state

Get Signature

get state(): AgentState;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:176

Current state

Returns

AgentState

Current state

Implementation of

IAgent.state

Methods

addContextItem()

protected addContextItem(
   content, 
   priority?, 
   category?
): Promise<void>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:344

Parameters

content

string

priority?

100 | 20 | 60 | 80 | 40

category?

"system" | "task" | "active"

Returns

Promise<void>

addToHistory()

protected addToHistory(message): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:331

Parameters

message

Message

Returns

void

buildPrompt()

abstract protected buildPrompt(task): Message[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:297

Parameters

task

Task

Returns

Message[]

cleanup()

cleanup(): Promise<void>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:276

Cleanup agent resources.

Returns

Promise<void>

Implementation of

IAgent.cleanup

clearHistory()

protected clearHistory(): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:337

Returns

void

complete()

protected complete(request): Promise<Result<CompletionResponse, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:303

Parameters

request

CompletionRequest

Returns

Promise<Result<CompletionResponse, AgentError>>

execute()

execute(task, options?): Promise<Result<TaskResult, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:218

Execute a task.

Parameters

task

Task

Task to execute

options?

Optional execution options (#3016/#3040). signal cancels the in-flight model call when the caller’s deadline wins a race; without it, the SDK keeps running to its own 10-minute timeout after the caller has already discarded the result.

signal?

AbortSignal

Returns

Promise<Result<TaskResult, AgentError>>

Result with TaskResult or AgentError

Implementation of

IAgent.execute

executeTask()

abstract protected executeTask(task): Promise<Result<TaskResult, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:296

Parameters

task

Task

Returns

Promise<Result<TaskResult, AgentError>>

findResolutionForError()

protected findResolutionForError(errorMessage): ErrorResolution | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:393

Parameters

errorMessage

string

Returns

ErrorResolution | undefined

flushMemory()

flushMemory(): Promise<Result<void, AgentMemoryError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:371

Returns

Promise<Result<void, AgentMemoryError>>

getHistory()

protected getHistory(): Message[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:334

Returns

Message[]

getMemoryState()

getMemoryState(): Readonly<AgentMemoryState> | null;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:364

Returns

Readonly<AgentMemoryState> | null

getPruningMetrics()

getPruningMetrics(): Readonly<ContextPruningMetrics>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:340

Returns

Readonly<ContextPruningMetrics>

getRelevantMemories()

getRelevantMemories(): readonly TypedMemoryEntry<MemoryType>[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:367

Returns

readonly TypedMemoryEntry<MemoryType>[]

getTaskLearnings()

protected getTaskLearnings(taskType): readonly TaskLearning[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:396

Parameters

taskType

string

Returns

readonly TaskLearning[]

handleMessage()

handleMessage(msg): Promise<Result<AgentResponse, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:261

Handle an inter-agent message and return a response.

Delivery semantics (#3222). This is a direct, awaited request/response call: the caller invokes it and holds the returned promise. It is NOT a queued or broadcast channel — that is the collaboration event bus (agents/collaboration/event-bus.ts), a fire-and-forget pub/sub with its own semantics. For this method specifically:

• Ordering is the caller’s responsibility. Sequential awaits are handled in call order; concurrent calls carry no cross-message ordering guarantee.
• Delivery is exactly the method invocation — there is no automatic retry or redelivery. A returned err(...) is the caller’s signal to decide whether to retry; the agent does not re-queue the message.
• Errors surface as Result.err, not as a throw for expected conditions; the caller branches on the Result.

Parameters

msg

AgentMessage

Message to handle

Returns

Promise<Result<AgentResponse, AgentError>>

Result with AgentResponse, or AgentError on failure (not retried)

Implementation of

IAgent.handleMessage

hasCapability()

hasCapability(capability): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:292

Parameters

capability

AgentCapability

Returns

boolean

initialize()

initialize(ctx): Promise<Result<void, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:205

Initialize the agent with context.

Parameters

ctx

AgentContext

Agent context

Returns

Promise<Result<void, AgentError>>

Result with void or AgentError

Implementation of

IAgent.initialize

isContextPruningEnabled()

isContextPruningEnabled(): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:358

Returns

boolean

isMemoryEnabled()

isMemoryEnabled(): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:361

Returns

boolean

recordLearning()

protected recordLearning(learning): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:384

Parameters

learning

Omit<TaskLearning, "id" | "learnedAt">

Returns

void

recordPattern()

protected recordPattern(p): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:387

Parameters

p

Omit<ExecutionPattern, "id" | "lastSeen" | "occurrences">

Returns

void

recordResolution()

protected recordResolution(r): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:390

Parameters

r

Omit<ErrorResolution, "resolvedAt">

Returns

void

transformError()

protected transformError(error, taskId): AgentError;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:299

Parameters

error

unknown

taskId

string

Returns

AgentError

CodeExpert

Defined in: packages/nexus-agents/src/agents/experts/code-expert.ts:40

CodeExpert - Expert agent for code-related tasks.

Specialized in:

• Code generation from specifications
• Code refactoring and cleanup
• Performance optimization
• Bug detection and debugging

Extends

• BaseAgent

Constructors

Constructor

new CodeExpert(options?): CodeExpert;

Defined in: packages/nexus-agents/src/agents/experts/code-expert.ts:43

Parameters

options?

Partial<BaseAgentOptions> & { expertOptions?: CodeExpertOptions; } = {}

Returns

CodeExpert

Overrides

BaseAgent.constructor

Properties

adapter

protected adapter: IModelAdapter | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:98

Inherited from

BaseAgent.adapter

budgetTracker

protected readonly budgetTracker: ITokenBudgetTracker;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:97

Inherited from

BaseAgent.budgetTracker

capabilities

readonly capabilities: readonly AgentCapability[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:95

Agent capabilities

Inherited from

BaseAgent.capabilities

config

protected config: AgentConfig | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:100

Inherited from

BaseAgent.config

emitMessageEvents

protected readonly emitMessageEvents: boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:107

Inherited from

BaseAgent.emitMessageEvents

eventBus

protected readonly eventBus: ICollaborationEventBus;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:106

Inherited from

BaseAgent.eventBus

history

protected history: Message[] = [];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:102

Inherited from

BaseAgent.history

id

readonly id: string;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:93

Unique agent identifier

Inherited from

BaseAgent.id

logger

protected readonly logger: ILogger;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:99

Inherited from

BaseAgent.logger

maxTokens

protected readonly maxTokens: number;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:105

Inherited from

BaseAgent.maxTokens

role

readonly role: AgentRole;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:94

Agent role

Inherited from

BaseAgent.role

sharedState

protected sharedState: Record<string, unknown> = {};

Defined in: packages/nexus-agents/src/agents/base-agent.ts:101

Inherited from

BaseAgent.sharedState

stateMachine

protected readonly stateMachine: AgentStateMachine;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:96

Inherited from

BaseAgent.stateMachine

systemPrompt

protected readonly systemPrompt: string | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:103

Inherited from

BaseAgent.systemPrompt

temperature

protected readonly temperature: number;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:104

Inherited from

BaseAgent.temperature

Accessors

state

Get Signature

get state(): AgentState;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:176

Current state

Returns

AgentState

Current state

Inherited from

BaseAgent.state

Methods

addContextItem()

protected addContextItem(
   content, 
   priority?, 
   category?
): Promise<void>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:344

Parameters

content

string

priority?

100 | 20 | 60 | 80 | 40

category?

"system" | "task" | "active"

Returns

Promise<void>

Inherited from

BaseAgent.addContextItem

addToHistory()

protected addToHistory(message): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:331

Parameters

message

Message

Returns

void

Inherited from

BaseAgent.addToHistory

buildPrompt()

protected buildPrompt(task): Message[];

Defined in: packages/nexus-agents/src/agents/experts/code-expert.ts:76

Build prompt messages for the task.

Parameters

task

Task

Returns

Message[]

Overrides

BaseAgent.buildPrompt

cleanup()

cleanup(): Promise<void>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:276

Cleanup agent resources.

Returns

Promise<void>

Inherited from

BaseAgent.cleanup

clearHistory()

protected clearHistory(): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:337

Returns

void

Inherited from

BaseAgent.clearHistory

complete()

protected complete(request): Promise<Result<CompletionResponse, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:303

Parameters

request

CompletionRequest

Returns

Promise<Result<CompletionResponse, AgentError>>

Inherited from

BaseAgent.complete

execute()

execute(task, options?): Promise<Result<TaskResult, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:218

Execute a task.

Parameters

task

Task

Task to execute

options?

Optional execution options (#3016/#3040). signal cancels the in-flight model call when the caller’s deadline wins a race; without it, the SDK keeps running to its own 10-minute timeout after the caller has already discarded the result.

signal?

AbortSignal

Returns

Promise<Result<TaskResult, AgentError>>

Result with TaskResult or AgentError

Inherited from

BaseAgent.execute

executeTask()

protected executeTask(task): Promise<Result<TaskResult, AgentError>>;

Defined in: packages/nexus-agents/src/agents/experts/code-expert.ts:54

Execute a code-related task.

Parameters

task

Task

Returns

Promise<Result<TaskResult, AgentError>>

Overrides

BaseAgent.executeTask

findResolutionForError()

protected findResolutionForError(errorMessage): ErrorResolution | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:393

Parameters

errorMessage

string

Returns

ErrorResolution | undefined

Inherited from

BaseAgent.findResolutionForError

flushMemory()

flushMemory(): Promise<Result<void, AgentMemoryError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:371

Returns

Promise<Result<void, AgentMemoryError>>

Inherited from

BaseAgent.flushMemory

getExpertOptions()

getExpertOptions(): Readonly<CodeExpertOptions>;

Defined in: packages/nexus-agents/src/agents/experts/code-expert.ts:95

Get the expert options.

Returns

Readonly<CodeExpertOptions>

getHistory()

protected getHistory(): Message[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:334

Returns

Message[]

Inherited from

BaseAgent.getHistory

getMemoryState()

getMemoryState(): Readonly<AgentMemoryState> | null;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:364

Returns

Readonly<AgentMemoryState> | null

Inherited from

BaseAgent.getMemoryState

getPruningMetrics()

getPruningMetrics(): Readonly<ContextPruningMetrics>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:340

Returns

Readonly<ContextPruningMetrics>

Inherited from

BaseAgent.getPruningMetrics

getRelevantMemories()

getRelevantMemories(): readonly TypedMemoryEntry<MemoryType>[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:367

Returns

readonly TypedMemoryEntry<MemoryType>[]

Inherited from

BaseAgent.getRelevantMemories

getTaskLearnings()

protected getTaskLearnings(taskType): readonly TaskLearning[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:396

Parameters

taskType

string

Returns

readonly TaskLearning[]

Inherited from

BaseAgent.getTaskLearnings

handleMessage()

handleMessage(msg): Promise<Result<AgentResponse, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:261

Handle an inter-agent message and return a response.

Delivery semantics (#3222). This is a direct, awaited request/response call: the caller invokes it and holds the returned promise. It is NOT a queued or broadcast channel — that is the collaboration event bus (agents/collaboration/event-bus.ts), a fire-and-forget pub/sub with its own semantics. For this method specifically:

• Ordering is the caller’s responsibility. Sequential awaits are handled in call order; concurrent calls carry no cross-message ordering guarantee.
• Delivery is exactly the method invocation — there is no automatic retry or redelivery. A returned err(...) is the caller’s signal to decide whether to retry; the agent does not re-queue the message.
• Errors surface as Result.err, not as a throw for expected conditions; the caller branches on the Result.

Parameters

msg

AgentMessage

Message to handle

Returns

Promise<Result<AgentResponse, AgentError>>

Result with AgentResponse, or AgentError on failure (not retried)

Inherited from

BaseAgent.handleMessage

hasCapability()

hasCapability(capability): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:292

Parameters

capability

AgentCapability

Returns

boolean

Inherited from

BaseAgent.hasCapability

initialize()

initialize(ctx): Promise<Result<void, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:205

Initialize the agent with context.

Parameters

ctx

AgentContext

Agent context

Returns

Promise<Result<void, AgentError>>

Result with void or AgentError

Inherited from

BaseAgent.initialize

isContextPruningEnabled()

isContextPruningEnabled(): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:358

Returns

boolean

Inherited from

BaseAgent.isContextPruningEnabled

isMemoryEnabled()

isMemoryEnabled(): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:361

Returns

boolean

Inherited from

BaseAgent.isMemoryEnabled

recordLearning()

protected recordLearning(learning): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:384

Parameters

learning

Omit<TaskLearning, "id" | "learnedAt">

Returns

void

Inherited from

BaseAgent.recordLearning

recordPattern()

protected recordPattern(p): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:387

Parameters

p

Omit<ExecutionPattern, "id" | "lastSeen" | "occurrences">

Returns

void

Inherited from

BaseAgent.recordPattern

recordResolution()

protected recordResolution(r): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:390

Parameters

r

Omit<ErrorResolution, "resolvedAt">

Returns

void

Inherited from

BaseAgent.recordResolution

transformError()

protected transformError(error, taskId): AgentError;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:299

Parameters

error

unknown

taskId

string

Returns

AgentError

Inherited from

BaseAgent.transformError

CollaborationSession

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:49

Manages a collaboration session between multiple experts.

Constructors

Constructor

new CollaborationSession(options?): CollaborationSession;

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:59

Parameters

options?

CollaborationSessionOptions = {}

Returns

CollaborationSession

Methods

addEventListener()

addEventListener(listener): void;

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:359

Parameters

listener

(event) => void

Returns

void

cancel()

cancel(reason): void;

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:349

Parameters

reason

string

Returns

void

finalize()

finalize(): Result<CollaborationResult, AgentError>;

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:298

Finalizes the session and returns aggregated result.

Returns

Result<CollaborationResult, AgentError>

getSessionId()

getSessionId(): string | null;

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:247

Returns

string | null

getStatus()

getStatus(): SessionState | null;

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:244

Returns

SessionState | null

getTaskAssignments()

getTaskAssignments(): TaskAssignmentMessage[];

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:291

Gets task assignments for experts based on pattern.

Returns

TaskAssignmentMessage[]

markExpertFailed()

markExpertFailed(expertId, error): Result<void, AgentError>;

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:252

Marks an expert as failed.

Parameters

expertId

string

error

string

Returns

Result<void, AgentError>

removeEventListener()

removeEventListener(listener): void;

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:370

Parameters

listener

(event) => void

Returns

void

requestReview()

requestReview(
   fromExpert, 
   toExpert, 
   artifact
): Result<void, AgentError>;

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:150

Requests a review from one expert to another.

Parameters

fromExpert

string

toExpert

string

artifact

unknown

Returns

Result<void, AgentError>

start()

start(config): Result<string, AgentError>;

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:68

Starts a new collaboration session.

Parameters

config

CollaborationConfig

Returns

Result<string, AgentError>

submitResult()

submitResult(expertId, result): Result<void, AgentError>;

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:118

Submits a result from an expert.

Parameters

expertId

string

result

TaskResult

Returns

Result<void, AgentError>

submitReview()

submitReview(
   reviewerId, 
   requesterId, 
   approved, 
   feedback
): Result<void, AgentError>;

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:171

Submits a review response.

Parameters

reviewerId

string

requesterId

string

approved

boolean

feedback

string

Returns

Result<void, AgentError>

vote()

vote(
   expertId, 
   decision, 
   reasoning
): Result<void, AgentError>;

Defined in: packages/nexus-agents/src/agents/collaboration/collaboration-session.ts:201

Submits a vote for consensus protocol.

Parameters

expertId

string

decision

"approve" | "reject" | "abstain"

reasoning

string

Returns

Result<void, AgentError>

ConsensusProtocol

Defined in: packages/nexus-agents/src/agents/collaboration/consensus-protocol.ts:22

Consensus collaboration protocol.

Implements

• ICollaborationProtocol

Constructors

Constructor

new ConsensusProtocol(options?): ConsensusProtocol;

Defined in: packages/nexus-agents/src/agents/collaboration/consensus-protocol.ts:29

Parameters

options?

ProtocolOptions = {}

Returns

ConsensusProtocol

Properties

cancelled

protected cancelled: boolean = false;

Defined in: packages/nexus-agents/src/agents/collaboration/consensus-protocol.ts:26

logger

protected readonly logger: ILogger;

Defined in: packages/nexus-agents/src/agents/collaboration/consensus-protocol.ts:24

options

protected readonly options: ProtocolOptions;

Defined in: packages/nexus-agents/src/agents/collaboration/consensus-protocol.ts:27

pattern

readonly pattern: "consensus";

Defined in: packages/nexus-agents/src/agents/collaboration/consensus-protocol.ts:23

Implementation of

ICollaborationProtocol.pattern

session

protected session: CollaborationSession | null = null;

Defined in: packages/nexus-agents/src/agents/collaboration/consensus-protocol.ts:25

Methods

cancel()

cancel(reason): void;

Defined in: packages/nexus-agents/src/agents/collaboration/consensus-protocol.ts:34

Parameters

reason

string

Returns

void

Implementation of

ICollaborationProtocol.cancel

execute()

execute(config, agents): Promise<Result<CollaborationResult, AgentError>>;

Defined in: packages/nexus-agents/src/agents/collaboration/consensus-protocol.ts:40

Parameters

config

CollaborationConfig

agents

Map<string, IAgent>

Returns

Promise<Result<CollaborationResult, AgentError>>

Implementation of

ICollaborationProtocol.execute

ContextManager

Defined in: packages/nexus-agents/src/agents/context-manager.ts:58

Manages context window for agents with token budget enforcement.

Constructors

Constructor

new ContextManager(config): ContextManager;

Defined in: packages/nexus-agents/src/agents/context-manager.ts:71

Parameters

config

ContextManagerConfig

Returns

ContextManager

Methods

add()

add(item): Promise<Result<ContextItem, ValidationError>>;

Defined in: packages/nexus-agents/src/agents/context-manager.ts:90

Add an item to the context. Returns Result with the added item or error.

Parameters

item

Omit<ContextItem, "tokenCount" | "addedAt">

Returns

Promise<Result<ContextItem, ValidationError>>

buildMessages()

buildMessages(): Message[];

Defined in: packages/nexus-agents/src/agents/context-manager.ts:247

Build messages array from context items for model requests.

Returns

Message[]

canAdd()

canAdd(content, category): Promise<boolean>;

Defined in: packages/nexus-agents/src/agents/context-manager.ts:221

Check if an item with the given content can be added to a category.

Parameters

content

string

category

"system" | "task" | "active"

Returns

Promise<boolean>

clear()

clear(): void;

Defined in: packages/nexus-agents/src/agents/context-manager.ts:280

Clear all items from the context.

Returns

void

clearCategory()

clearCategory(category): number;

Defined in: packages/nexus-agents/src/agents/context-manager.ts:288

Clear items from a specific category. Returns number of items removed.

Parameters

category

"system" | "task" | "active"

Returns

number

countTokens()

countTokens(text): Promise<number>;

Defined in: packages/nexus-agents/src/agents/context-manager.ts:308

Count tokens in text using adapter or fallback estimation.

Parameters

text

string

Returns

Promise<number>

get()

get(id): ContextItem | undefined;

Defined in: packages/nexus-agents/src/agents/context-manager.ts:216

Get an item by ID.

Parameters

id

string

Returns

ContextItem | undefined

getAllItems()

getAllItems(): ContextItem[];

Defined in: packages/nexus-agents/src/agents/context-manager.ts:242

Get all items sorted by priority (desc) then addedAt (asc).

Returns

ContextItem[]

getByCategory()

getByCategory(category): ContextItem[];

Defined in: packages/nexus-agents/src/agents/context-manager.ts:237

Get all items in a category, sorted by priority (desc) then addedAt (asc).

Parameters

category

"system" | "task" | "active"

Returns

ContextItem[]

getRemainingTokens()

getRemainingTokens(category): number;

Defined in: packages/nexus-agents/src/agents/context-manager.ts:267

Get remaining tokens available in a category.

Parameters

category

"system" | "task" | "active"

Returns

number

getStats()

getStats(): ContextStats;

Defined in: packages/nexus-agents/src/agents/context-manager.ts:257

Get current context statistics.

Returns

ContextStats

getSystemPrompt()

getSystemPrompt(): string | undefined;

Defined in: packages/nexus-agents/src/agents/context-manager.ts:252

Get the system prompt from system category items.

Returns

string | undefined

getTotalRemainingTokens()

getTotalRemainingTokens(): number;

Defined in: packages/nexus-agents/src/agents/context-manager.ts:274

Get total remaining tokens across all categories.

Returns

number

remove()

remove(id): boolean;

Defined in: packages/nexus-agents/src/agents/context-manager.ts:200

Remove an item from the context. Returns true if removed, false if not found.

Parameters

id

string

Returns

boolean

ContextPruner

Defined in: packages/nexus-agents/src/agents/context-pruner.ts:96

Handles context pruning with multiple strategies.

Constructors

Constructor

new ContextPruner(config): ContextPruner;

Defined in: packages/nexus-agents/src/agents/context-pruner.ts:105

Parameters

config

ContextPrunerConfig

Returns

ContextPruner

Methods

estimateFreeableTokens()

estimateFreeableTokens(categories): number;

Defined in: packages/nexus-agents/src/agents/context-pruner.ts:193

Estimate tokens that can be freed from specified categories.

Parameters

categories

("system" | "task" | "active")[]

Returns

number

getPruneCandidates()

getPruneCandidates(categories): ContextItem[];

Defined in: packages/nexus-agents/src/agents/context-pruner.ts:184

Get candidates for pruning from specified categories.

Parameters

categories

("system" | "task" | "active")[]

Returns

ContextItem[]

prune()

prune(options?): Promise<Result<PruneResult, ValidationError>>;

Defined in: packages/nexus-agents/src/agents/context-pruner.ts:132

Prune context to free tokens or reach target capacity.

Parameters

options?

PruneOptions = {}

Returns

Promise<Result<PruneResult, ValidationError>>

pruneCategory()

pruneCategory(category, targetTokens): Promise<Result<PruneResult, ValidationError>>;

Defined in: packages/nexus-agents/src/agents/context-pruner.ts:176

Prune items from a specific category.

Parameters

category

"system" | "task" | "active"

targetTokens

number

Returns

Promise<Result<PruneResult, ValidationError>>

shouldPrune()

shouldPrune(): boolean;

Defined in: packages/nexus-agents/src/agents/context-pruner.ts:127

Check if pruning should be triggered based on usage threshold.

Returns

boolean

DocumentationExpert

Defined in: packages/nexus-agents/src/agents/experts/documentation-expert.ts:52

DocumentationExpert - Expert agent for documentation-related tasks.

Extends

• BaseAgent

Constructors

Constructor

new DocumentationExpert(options?): DocumentationExpert;

Defined in: packages/nexus-agents/src/agents/experts/documentation-expert.ts:55

Parameters

options?

Partial<BaseAgentOptions> & { expertOptions?: DocumentationExpertOptions; } = {}

Returns

DocumentationExpert

Overrides

BaseAgent.constructor

Properties

adapter

protected adapter: IModelAdapter | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:98

Inherited from

BaseAgent.adapter

budgetTracker

protected readonly budgetTracker: ITokenBudgetTracker;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:97

Inherited from

BaseAgent.budgetTracker

capabilities

readonly capabilities: readonly AgentCapability[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:95

Agent capabilities

Inherited from

BaseAgent.capabilities

config

protected config: AgentConfig | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:100

Inherited from

BaseAgent.config

emitMessageEvents

protected readonly emitMessageEvents: boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:107

Inherited from

BaseAgent.emitMessageEvents

eventBus

protected readonly eventBus: ICollaborationEventBus;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:106

Inherited from

BaseAgent.eventBus

history

protected history: Message[] = [];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:102

Inherited from

BaseAgent.history

id

readonly id: string;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:93

Unique agent identifier

Inherited from

BaseAgent.id

logger

protected readonly logger: ILogger;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:99

Inherited from

BaseAgent.logger

maxTokens

protected readonly maxTokens: number;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:105

Inherited from

BaseAgent.maxTokens

role

readonly role: AgentRole;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:94

Agent role

Inherited from

BaseAgent.role

sharedState

protected sharedState: Record<string, unknown> = {};

Defined in: packages/nexus-agents/src/agents/base-agent.ts:101

Inherited from

BaseAgent.sharedState

stateMachine

protected readonly stateMachine: AgentStateMachine;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:96

Inherited from

BaseAgent.stateMachine

systemPrompt

protected readonly systemPrompt: string | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:103

Inherited from

BaseAgent.systemPrompt

temperature

protected readonly temperature: number;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:104

Inherited from

BaseAgent.temperature

Accessors

state

Get Signature

get state(): AgentState;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:176

Current state

Returns

AgentState

Current state

Inherited from

BaseAgent.state

Methods

addContextItem()

protected addContextItem(
   content, 
   priority?, 
   category?
): Promise<void>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:344

Parameters

content

string

priority?

100 | 20 | 60 | 80 | 40

category?

"system" | "task" | "active"

Returns

Promise<void>

Inherited from

BaseAgent.addContextItem

addToHistory()

protected addToHistory(message): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:331

Parameters

message

Message

Returns

void

Inherited from

BaseAgent.addToHistory

buildPrompt()

protected buildPrompt(task): Message[];

Defined in: packages/nexus-agents/src/agents/experts/documentation-expert.ts:83

Parameters

task

Task

Returns

Message[]

Overrides

BaseAgent.buildPrompt

cleanup()

cleanup(): Promise<void>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:276

Cleanup agent resources.

Returns

Promise<void>

Inherited from

BaseAgent.cleanup

clearHistory()

protected clearHistory(): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:337

Returns

void

Inherited from

BaseAgent.clearHistory

complete()

protected complete(request): Promise<Result<CompletionResponse, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:303

Parameters

request

CompletionRequest

Returns

Promise<Result<CompletionResponse, AgentError>>

Inherited from

BaseAgent.complete

execute()

execute(task, options?): Promise<Result<TaskResult, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:218

Execute a task.

Parameters

task

Task

Task to execute

options?

Optional execution options (#3016/#3040). signal cancels the in-flight model call when the caller’s deadline wins a race; without it, the SDK keeps running to its own 10-minute timeout after the caller has already discarded the result.

signal?

AbortSignal

Returns

Promise<Result<TaskResult, AgentError>>

Result with TaskResult or AgentError

Inherited from

BaseAgent.execute

executeTask()

protected executeTask(task): Promise<Result<TaskResult, AgentError>>;

Defined in: packages/nexus-agents/src/agents/experts/documentation-expert.ts:65

Parameters

task

Task

Returns

Promise<Result<TaskResult, AgentError>>

Overrides

BaseAgent.executeTask

findResolutionForError()

protected findResolutionForError(errorMessage): ErrorResolution | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:393

Parameters

errorMessage

string

Returns

ErrorResolution | undefined

Inherited from

BaseAgent.findResolutionForError

flushMemory()

flushMemory(): Promise<Result<void, AgentMemoryError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:371

Returns

Promise<Result<void, AgentMemoryError>>

Inherited from

BaseAgent.flushMemory

getExpertOptions()

getExpertOptions(): Readonly<DocumentationExpertOptions>;

Defined in: packages/nexus-agents/src/agents/experts/documentation-expert.ts:99

Returns

Readonly<DocumentationExpertOptions>

getHistory()

protected getHistory(): Message[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:334

Returns

Message[]

Inherited from

BaseAgent.getHistory

getMemoryState()

getMemoryState(): Readonly<AgentMemoryState> | null;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:364

Returns

Readonly<AgentMemoryState> | null

Inherited from

BaseAgent.getMemoryState

getPruningMetrics()

getPruningMetrics(): Readonly<ContextPruningMetrics>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:340

Returns

Readonly<ContextPruningMetrics>

Inherited from

BaseAgent.getPruningMetrics

getRelevantMemories()

getRelevantMemories(): readonly TypedMemoryEntry<MemoryType>[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:367

Returns

readonly TypedMemoryEntry<MemoryType>[]

Inherited from

BaseAgent.getRelevantMemories

getTaskLearnings()

protected getTaskLearnings(taskType): readonly TaskLearning[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:396

Parameters

taskType

string

Returns

readonly TaskLearning[]

Inherited from

BaseAgent.getTaskLearnings

handleMessage()

handleMessage(msg): Promise<Result<AgentResponse, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:261

Handle an inter-agent message and return a response.

Delivery semantics (#3222). This is a direct, awaited request/response call: the caller invokes it and holds the returned promise. It is NOT a queued or broadcast channel — that is the collaboration event bus (agents/collaboration/event-bus.ts), a fire-and-forget pub/sub with its own semantics. For this method specifically:

• Ordering is the caller’s responsibility. Sequential awaits are handled in call order; concurrent calls carry no cross-message ordering guarantee.
• Delivery is exactly the method invocation — there is no automatic retry or redelivery. A returned err(...) is the caller’s signal to decide whether to retry; the agent does not re-queue the message.
• Errors surface as Result.err, not as a throw for expected conditions; the caller branches on the Result.

Parameters

msg

AgentMessage

Message to handle

Returns

Promise<Result<AgentResponse, AgentError>>

Result with AgentResponse, or AgentError on failure (not retried)

Inherited from

BaseAgent.handleMessage

hasCapability()

hasCapability(capability): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:292

Parameters

capability

AgentCapability

Returns

boolean

Inherited from

BaseAgent.hasCapability

initialize()

initialize(ctx): Promise<Result<void, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:205

Initialize the agent with context.

Parameters

ctx

AgentContext

Agent context

Returns

Promise<Result<void, AgentError>>

Result with void or AgentError

Inherited from

BaseAgent.initialize

isContextPruningEnabled()

isContextPruningEnabled(): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:358

Returns

boolean

Inherited from

BaseAgent.isContextPruningEnabled

isMemoryEnabled()

isMemoryEnabled(): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:361

Returns

boolean

Inherited from

BaseAgent.isMemoryEnabled

recordLearning()

protected recordLearning(learning): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:384

Parameters

learning

Omit<TaskLearning, "id" | "learnedAt">

Returns

void

Inherited from

BaseAgent.recordLearning

recordPattern()

protected recordPattern(p): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:387

Parameters

p

Omit<ExecutionPattern, "id" | "lastSeen" | "occurrences">

Returns

void

Inherited from

BaseAgent.recordPattern

recordResolution()

protected recordResolution(r): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:390

Parameters

r

Omit<ErrorResolution, "resolvedAt">

Returns

void

Inherited from

BaseAgent.recordResolution

transformError()

protected transformError(error, taskId): AgentError;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:299

Parameters

error

unknown

taskId

string

Returns

AgentError

Inherited from

BaseAgent.transformError

Expert

Defined in: packages/nexus-agents/src/agents/experts/expert-agent.ts:17

Expert agent extending SimpleAgent with configuration-based setup.

Extends

• SimpleAgent

Extended by

• RecoverableExpert

Constructors

Constructor

new Expert(options, config): Expert;

Defined in: packages/nexus-agents/src/agents/experts/expert-agent.ts:20

Parameters

options

BaseAgentOptions

config

ExpertConfig

Returns

Expert

Overrides

SimpleAgent.constructor

Properties

adapter

protected adapter: IModelAdapter | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:98

Inherited from

SimpleAgent.adapter

budgetTracker

protected readonly budgetTracker: ITokenBudgetTracker;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:97

Inherited from

SimpleAgent.budgetTracker

capabilities

readonly capabilities: readonly AgentCapability[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:95

Agent capabilities

Inherited from

SimpleAgent.capabilities

config

protected config: AgentConfig | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:100

Inherited from

SimpleAgent.config

emitMessageEvents

protected readonly emitMessageEvents: boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:107

Inherited from

SimpleAgent.emitMessageEvents

eventBus

protected readonly eventBus: ICollaborationEventBus;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:106

Inherited from

SimpleAgent.eventBus

expertConfig

readonly expertConfig: ExpertConfig;

Defined in: packages/nexus-agents/src/agents/experts/expert-agent.ts:18

history

protected history: Message[] = [];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:102

Inherited from

SimpleAgent.history

id

readonly id: string;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:93

Unique agent identifier

Inherited from

SimpleAgent.id

logger

protected readonly logger: ILogger;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:99

Inherited from

SimpleAgent.logger

maxTokens

protected readonly maxTokens: number;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:105

Inherited from

SimpleAgent.maxTokens

role

readonly role: AgentRole;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:94

Agent role

Inherited from

SimpleAgent.role

sharedState

protected sharedState: Record<string, unknown> = {};

Defined in: packages/nexus-agents/src/agents/base-agent.ts:101

Inherited from

SimpleAgent.sharedState

stateMachine

protected readonly stateMachine: AgentStateMachine;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:96

Inherited from

SimpleAgent.stateMachine

systemPrompt

protected readonly systemPrompt: string | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:103

Inherited from

SimpleAgent.systemPrompt

temperature

protected readonly temperature: number;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:104

Inherited from

SimpleAgent.temperature

Accessors

metadata

Get Signature

get metadata(): Record<string, unknown> | undefined;

Defined in: packages/nexus-agents/src/agents/experts/expert-agent.ts:35

Get the expert’s metadata.

Returns

Record<string, unknown> | undefined

name

Get Signature

get name(): string;

Defined in: packages/nexus-agents/src/agents/experts/expert-agent.ts:28

Get the expert’s name.

Returns

string

state

Get Signature

get state(): AgentState;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:176

Current state

Returns

AgentState

Current state

Inherited from

SimpleAgent.state

Methods

addContextItem()

protected addContextItem(
   content, 
   priority?, 
   category?
): Promise<void>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:344

Parameters

content

string

priority?

100 | 20 | 60 | 80 | 40

category?

"system" | "task" | "active"

Returns

Promise<void>

Inherited from

SimpleAgent.addContextItem

addToHistory()

protected addToHistory(message): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:331

Parameters

message

Message

Returns

void

Inherited from

SimpleAgent.addToHistory

buildPrompt()

protected buildPrompt(task): Message[];

Defined in: packages/nexus-agents/src/agents/simple-agent.ts:105

Build prompt messages from a task.

Parameters

task

Task

Returns

Message[]

Inherited from

SimpleAgent.buildPrompt

cleanup()

cleanup(): Promise<void>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:276

Cleanup agent resources.

Returns

Promise<void>

Inherited from

SimpleAgent.cleanup

clearHistory()

protected clearHistory(): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:337

Returns

void

Inherited from

SimpleAgent.clearHistory

complete()

protected complete(request): Promise<Result<CompletionResponse, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:303

Parameters

request

CompletionRequest

Returns

Promise<Result<CompletionResponse, AgentError>>

Inherited from

SimpleAgent.complete

execute()

execute(task, options?): Promise<Result<TaskResult, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:218

Execute a task.

Parameters

task

Task

Task to execute

options?

Optional execution options (#3016/#3040). signal cancels the in-flight model call when the caller’s deadline wins a race; without it, the SDK keeps running to its own 10-minute timeout after the caller has already discarded the result.

signal?

AbortSignal

Returns

Promise<Result<TaskResult, AgentError>>

Result with TaskResult or AgentError

Inherited from

SimpleAgent.execute

executeTask()

protected executeTask(task): Promise<Result<TaskResult, AgentError>>;

Defined in: packages/nexus-agents/src/agents/simple-agent.ts:21

Execute a task by sending it to the model.

Parameters

task

Task

Returns

Promise<Result<TaskResult, AgentError>>

Inherited from

SimpleAgent.executeTask

findResolutionForError()

protected findResolutionForError(errorMessage): ErrorResolution | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:393

Parameters

errorMessage

string

Returns

ErrorResolution | undefined

Inherited from

SimpleAgent.findResolutionForError

flushMemory()

flushMemory(): Promise<Result<void, AgentMemoryError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:371

Returns

Promise<Result<void, AgentMemoryError>>

Inherited from

SimpleAgent.flushMemory

getHistory()

protected getHistory(): Message[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:334

Returns

Message[]

Inherited from

SimpleAgent.getHistory

getMemoryState()

getMemoryState(): Readonly<AgentMemoryState> | null;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:364

Returns

Readonly<AgentMemoryState> | null

Inherited from

SimpleAgent.getMemoryState

getPruningMetrics()

getPruningMetrics(): Readonly<ContextPruningMetrics>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:340

Returns

Readonly<ContextPruningMetrics>

Inherited from

SimpleAgent.getPruningMetrics

getRelevantMemories()

getRelevantMemories(): readonly TypedMemoryEntry<MemoryType>[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:367

Returns

readonly TypedMemoryEntry<MemoryType>[]

Inherited from

SimpleAgent.getRelevantMemories

getTaskLearnings()

protected getTaskLearnings(taskType): readonly TaskLearning[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:396

Parameters

taskType

string

Returns

readonly TaskLearning[]

Inherited from

SimpleAgent.getTaskLearnings

handleMessage()

handleMessage(msg): Promise<Result<AgentResponse, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:261

Handle an inter-agent message and return a response.

Delivery semantics (#3222). This is a direct, awaited request/response call: the caller invokes it and holds the returned promise. It is NOT a queued or broadcast channel — that is the collaboration event bus (agents/collaboration/event-bus.ts), a fire-and-forget pub/sub with its own semantics. For this method specifically:

• Ordering is the caller’s responsibility. Sequential awaits are handled in call order; concurrent calls carry no cross-message ordering guarantee.
• Delivery is exactly the method invocation — there is no automatic retry or redelivery. A returned err(...) is the caller’s signal to decide whether to retry; the agent does not re-queue the message.
• Errors surface as Result.err, not as a throw for expected conditions; the caller branches on the Result.

Parameters

msg

AgentMessage

Message to handle

Returns

Promise<Result<AgentResponse, AgentError>>

Result with AgentResponse, or AgentError on failure (not retried)

Inherited from

SimpleAgent.handleMessage

hasCapability()

hasCapability(capability): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:292

Parameters

capability

AgentCapability

Returns

boolean

Inherited from

SimpleAgent.hasCapability

initialize()

initialize(ctx): Promise<Result<void, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:205

Initialize the agent with context.

Parameters

ctx

AgentContext

Agent context

Returns

Promise<Result<void, AgentError>>

Result with void or AgentError

Inherited from

SimpleAgent.initialize

isContextPruningEnabled()

isContextPruningEnabled(): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:358

Returns

boolean

Inherited from

SimpleAgent.isContextPruningEnabled

isMemoryEnabled()

isMemoryEnabled(): boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:361

Returns

boolean

Inherited from

SimpleAgent.isMemoryEnabled

recordLearning()

protected recordLearning(learning): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:384

Parameters

learning

Omit<TaskLearning, "id" | "learnedAt">

Returns

void

Inherited from

SimpleAgent.recordLearning

recordPattern()

protected recordPattern(p): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:387

Parameters

p

Omit<ExecutionPattern, "id" | "lastSeen" | "occurrences">

Returns

void

Inherited from

SimpleAgent.recordPattern

recordResolution()

protected recordResolution(r): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:390

Parameters

r

Omit<ErrorResolution, "resolvedAt">

Returns

void

Inherited from

SimpleAgent.recordResolution

transformError()

protected transformError(error, taskId): AgentError;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:299

Parameters

error

unknown

taskId

string

Returns

AgentError

Inherited from

SimpleAgent.transformError

ExpertRegistry

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:68

Singleton registry for managing expert agents.

Provides thread-safe registration and lookup of experts. Supports querying by ID, role, and capabilities.

Implements IRegistry<Expert, RegistryError> for unified registry API.

Implements

• IRegistry<Expert, RegistryError>

Accessors

isEmpty

Get Signature

get isEmpty(): boolean;

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:319

Check if the registry is empty.

Returns

boolean

Implementation of

IRegistry.isEmpty

size

Get Signature

get size(): number;

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:312

Get the number of registered experts.

Returns

number

Implementation of

IRegistry.size

Methods

clear()

clear(): void;

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:326

Clear all registered experts.

Returns

void

Implementation of

IRegistry.clear

findBestMatch()

findBestMatch(requiredCapabilities): Result<Expert, RegistryError>;

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:363

Find the best expert for a set of required capabilities.

Returns the expert that matches the most capabilities.

Parameters

requiredCapabilities

AgentCapability[]

Capabilities needed

Returns

Result<Expert, RegistryError>

Result with best Expert or RegistryError if none found

get()

get(id): Result<Expert, RegistryError>;

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:163

Get an expert by ID.

Parameters

id

string

Expert ID to retrieve

Returns

Result<Expert, RegistryError>

Result with Expert or RegistryError

Implementation of

IRegistry.get

getAll()

getAll(): Expert[];

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:274

Get all registered experts. IRegistry interface method.

Returns

Expert[]

Array of all registered experts

Implementation of

IRegistry.getAll

getAllIds()

getAllIds(): string[];

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:284

Get all registered expert IDs. IRegistry interface method.

Returns

string[]

Array of all registered expert IDs

Implementation of

IRegistry.getAllIds

getByCapability()

getByCapability(capability): Expert[];

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:198

Get experts by capability.

Returns all experts that have the specified capability.

Parameters

capability

AgentCapability

Capability to search for

Returns

Expert[]

Array of matching experts

getByRole()

getByRole(role): Expert[];

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:210

Get experts by role.

Parameters

role

string

Role to search for

Returns

Expert[]

Array of matching experts

getStats()

getStats(): RegistryStats;

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:334

Get statistics about the registry. Returns IRegistryStats-compatible stats with domain-specific extensions.

Returns

RegistryStats

Implementation of

IRegistry.getStats

has()

has(id): boolean;

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:186

Check if an expert is registered.

Parameters

id

string

Expert ID to check

Returns

boolean

True if expert is registered

Implementation of

IRegistry.has

query()

query(predicate): Expert[];

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:260

Query experts with predicate function. IRegistry interface method.

Parameters

predicate

(item) => boolean

Function to test each expert

Returns

Expert[]

Array of matching experts

Implementation of

IRegistry.query

queryWithOptions()

queryWithOptions(options): Expert[];

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:221

Query experts with multiple criteria. Domain-specific query with structured options.

Parameters

options

QueryOptions

Query options

Returns

Expert[]

Array of matching experts

register()

register(expert, options?): Result<void, RegistryError>;

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:101

Register an expert in the registry.

Parameters

expert

Expert

Expert to register

options?

ExpertRegisterOptions

Registration options

Returns

Result<void, RegistryError>

Result with void or RegistryError

Implementation of

IRegistry.register

registerMany()

registerMany(experts, options?): Result<void, RegistryError>;

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:126

Register multiple experts.

Parameters

experts

Expert[]

Experts to register

options?

ExpertRegisterOptions

Registration options

Returns

Result<void, RegistryError>

Result with void or first RegistryError

search()

search(searchTerm): Expert[];

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:297

Search experts by text query. IRegistry interface method.

Searches expert ID, name, role, and capabilities.

Parameters

searchTerm

string

Search term to match

Returns

Expert[]

Array of matching experts

Implementation of

IRegistry.search

unregister()

unregister(id): Result<Expert, RegistryError>;

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:142

Unregister an expert by ID.

Parameters

id

string

Expert ID to unregister

Returns

Result<Expert, RegistryError>

Result with the removed Expert or RegistryError

Implementation of

IRegistry.unregister

getInstance()

static getInstance(): ExpertRegistry;

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:79

Get the singleton instance.

Returns

ExpertRegistry

resetInstance()

static resetInstance(): void;

Defined in: packages/nexus-agents/src/agents/experts/expert-registry.ts:87

Reset the singleton instance (for testing).

Returns

void

FactoryError

Defined in: packages/nexus-agents/src/agents/experts/expert-factory.ts:37

Error specific to factory operations.

Extends

• AgentError

Constructors

Constructor

new FactoryError(message, options?): FactoryError;

Defined in: packages/nexus-agents/src/agents/experts/expert-factory.ts:38

Parameters

message

string

options?

cause?

Error

context?

Record<string, unknown>

Returns

FactoryError

Overrides

AgentError.constructor

Properties

cause

readonly cause: Error | undefined;

Defined in: packages/nexus-agents/src/core/errors.ts:105

Inherited from

AgentError.cause

code

readonly code: ErrorCode;

Defined in: packages/nexus-agents/src/core/errors.ts:103

Inherited from

AgentError.code

context

readonly context: Record<string, unknown> | undefined;

Defined in: packages/nexus-agents/src/core/errors.ts:104

Inherited from

AgentError.context

message

message: string;

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

AgentError.message

name

name: string;

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

AgentError.name

stack?

optional stack?: string;

Defined in: node_modules/.pnpm/typescript@6.0.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

AgentError.stack

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@types+node@25.9.8/node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

AgentError.stackTraceLimit

Methods

toJSON()

toJSON(): SerializedError;

Defined in: packages/nexus-agents/src/core/errors.ts:121

Serializes the error to a JSON-safe object.

Returns

SerializedError

Inherited from

AgentError.toJSON

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@25.9.8/node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

AgentError.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@25.9.8/node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

AgentError.prepareStackTrace

Orchestrator

Defined in: packages/nexus-agents/src/agents/tech-lead.ts:202

Agents exports - Agent framework, Orchestrator, Experts Split from index.ts for file size compliance (Issue #285)

Extends

• BaseAgent

Constructors

Constructor

new Orchestrator(options?): Orchestrator;

Defined in: packages/nexus-agents/src/agents/tech-lead.ts:208

Parameters

options?

Partial<BaseAgentOptions> & OrchestratorExtendedOptions & { techLeadOptions?: OrchestratorOptions; } = {}

Returns

Orchestrator

Overrides

BaseAgent.constructor

Properties

adapter

protected adapter: IModelAdapter | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:98

Inherited from

BaseAgent.adapter

budgetTracker

protected readonly budgetTracker: ITokenBudgetTracker;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:97

Inherited from

BaseAgent.budgetTracker

capabilities

readonly capabilities: readonly AgentCapability[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:95

Agent capabilities

Inherited from

BaseAgent.capabilities

config

protected config: AgentConfig | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:100

Inherited from

BaseAgent.config

emitMessageEvents

protected readonly emitMessageEvents: boolean;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:107

Inherited from

BaseAgent.emitMessageEvents

eventBus

protected readonly eventBus: ICollaborationEventBus;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:106

Inherited from

BaseAgent.eventBus

history

protected history: Message[] = [];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:102

Inherited from

BaseAgent.history

id

readonly id: string;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:93

Unique agent identifier

Inherited from

BaseAgent.id

logger

protected readonly logger: ILogger;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:99

Inherited from

BaseAgent.logger

maxTokens

protected readonly maxTokens: number;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:105

Inherited from

BaseAgent.maxTokens

role

readonly role: AgentRole;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:94

Agent role

Inherited from

BaseAgent.role

sharedState

protected sharedState: Record<string, unknown> = {};

Defined in: packages/nexus-agents/src/agents/base-agent.ts:101

Inherited from

BaseAgent.sharedState

stateMachine

protected readonly stateMachine: AgentStateMachine;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:96

Inherited from

BaseAgent.stateMachine

systemPrompt

protected readonly systemPrompt: string | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:103

Inherited from

BaseAgent.systemPrompt

temperature

protected readonly temperature: number;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:104

Inherited from

BaseAgent.temperature

Accessors

state

Get Signature

get state(): AgentState;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:176

Current state

Returns

AgentState

Current state

Inherited from

BaseAgent.state

Methods

addContextItem()

protected addContextItem(
   content, 
   priority?, 
   category?
): Promise<void>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:344

Parameters

content

string

priority?

100 | 20 | 60 | 80 | 40

category?

"system" | "task" | "active"

Returns

Promise<void>

Inherited from

BaseAgent.addContextItem

addToHistory()

protected addToHistory(message): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:331

Parameters

message

Message

Returns

void

Inherited from

BaseAgent.addToHistory

analyzeTask()

analyzeTask(task): Promise<Result<TaskAnalysis, AgentError>>;

Defined in: packages/nexus-agents/src/agents/tech-lead.ts:308

Analyze a task to understand its complexity and requirements.

Parameters

task

Task

Returns

Promise<Result<TaskAnalysis, AgentError>>

buildPrompt()

protected buildPrompt(task): Message[];

Defined in: packages/nexus-agents/src/agents/tech-lead.ts:303

Build prompt messages for task execution.

Parameters

task

Task

Returns

Message[]

Overrides

BaseAgent.buildPrompt

cleanup()

cleanup(): Promise<void>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:276

Cleanup agent resources.

Returns

Promise<void>

Inherited from

BaseAgent.cleanup

clearHistory()

protected clearHistory(): void;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:337

Returns

void

Inherited from

BaseAgent.clearHistory

complete()

protected complete(request): Promise<Result<CompletionResponse, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:303

Parameters

request

CompletionRequest

Returns

Promise<Result<CompletionResponse, AgentError>>

Inherited from

BaseAgent.complete

decomposeTask()

decomposeTask(task, analysis): Promise<Result<SubTask[], AgentError>>;

Defined in: packages/nexus-agents/src/agents/tech-lead.ts:350

Decompose a task into subtasks.

Parameters

task

Task

analysis

TaskAnalysis

Returns

Promise<Result<SubTask[], AgentError>>

execute()

execute(task, options?): Promise<Result<TaskResult, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:218

Execute a task.

Parameters

task

Task

Task to execute

options?

Optional execution options (#3016/#3040). signal cancels the in-flight model call when the caller’s deadline wins a race; without it, the SDK keeps running to its own 10-minute timeout after the caller has already discarded the result.

signal?

AbortSignal

Returns

Promise<Result<TaskResult, AgentError>>

Result with TaskResult or AgentError

Inherited from

BaseAgent.execute

executeTask()

protected executeTask(task): Promise<Result<TaskResult, AgentError>>;

Defined in: packages/nexus-agents/src/agents/tech-lead.ts:245

Execute a task by analyzing, decomposing (if needed), and coordinating.

Parameters

task

Task

Returns

Promise<Result<TaskResult, AgentError>>

Overrides

BaseAgent.executeTask

findResolutionForError()

protected findResolutionForError(errorMessage): ErrorResolution | undefined;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:393

Parameters

errorMessage

string

Returns

ErrorResolution | undefined

Inherited from

BaseAgent.findResolutionForError

flushMemory()

flushMemory(): Promise<Result<void, AgentMemoryError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:371

Returns

Promise<Result<void, AgentMemoryError>>

Inherited from

BaseAgent.flushMemory

getCollaborationHelper()

getCollaborationHelper(): OrchestratorCollaborationHelper;

Defined in: packages/nexus-agents/src/agents/tech-lead.ts:518

Get the collaboration helper for external use.

Returns

OrchestratorCollaborationHelper

getHistory()

protected getHistory(): Message[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:334

Returns

Message[]

Inherited from

BaseAgent.getHistory

getMemoryState()

getMemoryState(): Readonly<AgentMemoryState> | null;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:364

Returns

Readonly<AgentMemoryState> | null

Inherited from

BaseAgent.getMemoryState

getOptions()

getOptions(): Readonly<Required<OrchestratorOptions>>;

Defined in: packages/nexus-agents/src/agents/tech-lead.ts:523

Get the Orchestrator options.

Returns

Readonly<Required<OrchestratorOptions>>

getPruningMetrics()

getPruningMetrics(): Readonly<ContextPruningMetrics>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:340

Returns

Readonly<ContextPruningMetrics>

Inherited from

BaseAgent.getPruningMetrics

getRelevantMemories()

getRelevantMemories(): readonly TypedMemoryEntry<MemoryType>[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:367

Returns

readonly TypedMemoryEntry<MemoryType>[]

Inherited from

BaseAgent.getRelevantMemories

getTaskLearnings()

protected getTaskLearnings(taskType): readonly TaskLearning[];

Defined in: packages/nexus-agents/src/agents/base-agent.ts:396

Parameters

taskType

string

Returns

readonly TaskLearning[]

Inherited from

BaseAgent.getTaskLearnings

handleMessage()

handleMessage(msg): Promise<Result<AgentResponse, AgentError>>;

Defined in: packages/nexus-agents/src/agents/base-agent.ts:261

Handle an inter-agent message and return a response.

Delivery semantics (#3222). This is a direct, awaited request/response call: the caller invokes it and holds the returned promise. It is NOT a queued or broadcast channel — that is the collaboration event bus (agents/collaboration/event-bus.ts), a fire-and-forget pub/sub with its own semantics. For this method specifically:

• Ordering is the caller’s responsibility. Sequential awaits are handled in call order; concurrent calls carry no cross-message ordering guarantee.
• Delivery is exactly the method invocation — there is no automatic retry or redelivery. A returned err(...) is the caller’s signal to decide whether to retry; the agent does not re-queue the message.
• Errors surface as Result.err, not as a throw for expected conditions; the caller branches on the Result.

Parameters

msg

AgentMessage

Message to handle

Returns

Promise<Result<AgentResponse, AgentError>>

Result with AgentResponse, or AgentError on failure (not retried)

Inherited from

BaseAgent.handleMessage

hasCapability()

hasCapability(capability): boolean;