@memberjunction/ai-agents
Complete framework for building and executing AI agents in MemberJunction. Provides the BaseAgent execution engine, pluggable agent type system (Loop and Flow agents), hierarchical sub-agent orchestration, action execution, memory management with notes and examples, payload management, conversation context with message lifecycle management, and reranker integration.
Architecture
graph TD
subgraph "@memberjunction/ai-agents"
BA["BaseAgent<br/>Core Execution Engine"]
style BA fill:#2d8659,stroke:#1a5c3a,color:#fff
AR["AgentRunner<br/>Orchestration Entry Point"]
style AR fill:#2d8659,stroke:#1a5c3a,color:#fff
subgraph "Agent Types"
BAT["BaseAgentType"]
style BAT fill:#7c5295,stroke:#563a6b,color:#fff
LAT["LoopAgentType"]
style LAT fill:#7c5295,stroke:#563a6b,color:#fff
FAT["FlowAgentType"]
style FAT fill:#7c5295,stroke:#563a6b,color:#fff
end
subgraph "Support Systems"
PM["PayloadManager<br/>Data Flow Between Steps"]
style PM fill:#b8762f,stroke:#8a5722,color:#fff
PCA["PayloadChangeAnalyzer"]
style PCA fill:#b8762f,stroke:#8a5722,color:#fff
PFM["PayloadFeedbackManager"]
style PFM fill:#b8762f,stroke:#8a5722,color:#fff
ACI["AgentContextInjector<br/>Notes, Examples, Data Sources"]
style ACI fill:#b8762f,stroke:#8a5722,color:#fff
ADP["AgentDataPreloader<br/>Batch Metadata Loading"]
style ADP fill:#b8762f,stroke:#8a5722,color:#fff
MMA["MemoryManagerAgent<br/>Note/Example Management"]
style MMA fill:#b8762f,stroke:#8a5722,color:#fff
end
end
BA --> BAT
BA --> PM
BA --> ACI
BA --> ADP
AR --> BA
subgraph Dependencies
AIP["@memberjunction/ai-prompts<br/>AIPromptRunner"]
style AIP fill:#2d6a9f,stroke:#1a4971,color:#fff
AIE["@memberjunction/aiengine<br/>AIEngine"]
style AIE fill:#2d6a9f,stroke:#1a4971,color:#fff
ACT["@memberjunction/actions<br/>ActionEngineServer"]
style ACT fill:#2d6a9f,stroke:#1a4971,color:#fff
RR["@memberjunction/ai-reranker<br/>RerankerService"]
style RR fill:#2d6a9f,stroke:#1a4971,color:#fff
end
AIP --> BA
AIE --> BA
ACT --> BA
RR --> BA
Installation
npm install @memberjunction/ai-agents
Key Components
BaseAgent
The core execution engine that all agents use. Handles:
- Hierarchical prompt execution (agent type's system prompt as parent, agent's prompts as children)
- Action execution through the MJ Actions framework
- Client tool invocation for browser-side UI operations (navigate to records, switch tabs, show search results) via PubSub round-trip
- Sub-agent orchestration with full context propagation
- Conversation context management with automatic message compaction
- Memory retrieval (notes and examples) with optional reranking
- Payload data management across execution steps
- ForEach and While loop operations
- Comprehensive execution tracking (AIAgentRun, AIAgentRunStep records)
AgentRunner
High-level entry point for agent execution. Provides:
- Agent resolution by ID or entity reference
- Permission checking before execution
- Data preloading for performance
- Simplified execution interface
import { AgentRunner } from '@memberjunction/ai-agents';
const runner = new AgentRunner();
const result = await runner.ExecuteAgent({
agentId: 'agent-uuid',
conversationMessages: [{ role: 'user', content: 'Analyze Q3 sales trends' }],
contextUser: currentUser,
onProgress: (step) => console.log(`${step.step}: ${step.message}`)
});
Agent Type System
Agents execute using a pluggable type system. The type determines how the agent decides its next action after each LLM call.
BaseAgentType
Abstract base that all agent types extend. Defines the DetermineNextStep() interface that produces a BaseAgentNextStep decision:
Chat | Send a message back to the user |
Actions | Execute one or more server-side actions |
ClientTools | Invoke browser-side tools (navigate, switch tabs, show results) |
SubAgents | Delegate to sub-agents |
MoreInfo | Ask the user for additional information |
Retry | Retry the current step (e.g., after validation failure) |
End | Complete execution |
ForEach | Iterate over a collection |
While | Loop while a condition is true |
LoopAgentType
Conversational agent that runs in a loop: prompt -> decide -> act -> repeat. Best for interactive, chat-based agents. The LLM decides the next step at each iteration by producing a structured JSON response.
FlowAgentType
Step-based agent that follows a predefined flow graph. Each step has explicit paths to the next step based on conditions. Best for deterministic workflows where the execution path is known in advance.
RealtimeAgentType
Session-driven agent type for live, low-latency, full-duplex interaction (voice today; the contract is modality-agnostic). Unlike Loop and Flow, a Realtime agent does not run an iterative reasoning loop — modern realtime stacks (GPT Realtime, Gemini Live, ElevenLabs Agents, AssemblyAI Voice Agent) own the listen-reason-speak loop themselves, so RealtimeAgentType wraps a long-lived BaseRealtimeModel session instead. The marker is its IsSessionDriven getter (always true): BaseAgent duck-types it and routes execution to a RealtimeSessionRunner rather than entering the loop. See Real-Time Co-Agents below.
graph LR
subgraph "Loop Agent"
L1["Prompt LLM"] --> L2["Parse Response"]
L2 --> L3{Decision}
L3 -->|"Actions"| L4["Execute Actions"]
L4 --> L1
L3 -->|"Chat"| L5["Reply to User"]
L5 --> L1
L3 -->|"End"| L6["Complete"]
end
subgraph "Flow Agent"
F1["Step 1"] -->|"Path A"| F2["Step 2a"]
F1 -->|"Path B"| F3["Step 2b"]
F2 --> F4["Step 3"]
F3 --> F4
F4 --> F5["End"]
end
style L1 fill:#2d6a9f,stroke:#1a4971,color:#fff
style L2 fill:#7c5295,stroke:#563a6b,color:#fff
style L3 fill:#b8762f,stroke:#8a5722,color:#fff
style L4 fill:#2d8659,stroke:#1a5c3a,color:#fff
style L5 fill:#2d8659,stroke:#1a5c3a,color:#fff
style L6 fill:#2d8659,stroke:#1a5c3a,color:#fff
style F1 fill:#2d6a9f,stroke:#1a4971,color:#fff
style F2 fill:#7c5295,stroke:#563a6b,color:#fff
style F3 fill:#7c5295,stroke:#563a6b,color:#fff
style F4 fill:#b8762f,stroke:#8a5722,color:#fff
style F5 fill:#2d8659,stroke:#1a5c3a,color:#fff
Real-Time Co-Agents
Real-time is the live, low-latency complement to the async Loop/Flow paradigm — not a replacement for it. Loop and Flow agents stay asynchronous and untouched; what they cannot deliver is a natural spoken conversation, because the loop is intentionally long-running while realtime models own sub-second turn taking, VAD, and barge-in natively. The Realtime agent type bridges the two worlds: a realtime model holds the conversation, and real work is delegated back to the async agents you already have as ordinary AIAgentRuns.
The first shipped agent of this type is the Realtime Co-Agent (seeded in metadata/agents/): a generic companion that acts as the live voice for any target MJ agent. The target is a runtime parameter — agents gain voice by configuration, never by being rewritten. Which co-agent voices a given target resolves through a metadata chain at session start: runtime coAgentId parameter → AIAgent.DefaultCoAgentID → AIAgentType.DefaultCoAgentID → the seeded global Realtime Co-Agent.
Key pieces in this package:
RealtimeAgentType (src/agent-types/realtime-agent-type.ts) — the registered agent type (@RegisterClass(BaseAgentType, "RealtimeAgentType")). Its IsSessionDriven getter makes BaseAgent.ExecuteAgent branch into executeRealtimeSession() instead of the loop; the loop-oriented abstract methods are implemented defensively and should never be reached.
RealtimeSessionRunner (src/realtime/realtime-session-runner.ts) — dependency-injected orchestrator for the server-bridged topology: opens the IRealtimeSession, registers the stable tool set, persists transcript turns, checkpoints usage onto the single long-lived AIPromptRun on a debounced cadence (crash-safe — a janitor close finalizes from the last-persisted values), and aborts an in-flight delegated run on barge-in. It also narrates delegated work itself: each significant progress event is fed to the session's optional SendContextNote, and a built-in pacing engine (first spoken update ~5 s into a burst, ≥8 s session-global spacing, deduped multi-message digests, cancellation on completion/barge-in) drives RequestSpokenUpdate — both feature-detected, since providers may omit either capability. Fully unit-testable against a mock realtime model.
realtime-narration.ts (src/realtime/realtime-narration.ts) — the shared narration module both topologies use: ResolveNarrationInstructionsTemplate() resolves the DB-driven Realtime Co-Agent - Progress Narration prompt (with a deprecated fallback to the pre-rename Voice Co-Agent - Progress Narration seed name) from AIEngine's cache, and BuildServerNarrationInstructions() substitutes its placeholders for the server-bridged runner (the browser host has its own richer builder that chains the model's actual prior narrations — only the browser can observe those).
RealtimeToolBroker (src/realtime/realtime-tool-broker.ts) — the topology-agnostic tool-execution path both topologies share, so a tool call produces byte-for-byte identical results whether the provider socket lives on the server or in the browser. Routes the stable invoke-target-agent tool (the co-agent's one headline capability — the target rides inside the call, never as a per-target tool) to the delegation seam, everything else to the tool executor; owns the per-call AbortController; serializes failures as structured errors the model can narrate.
RealtimeClientSessionService (src/realtime/realtime-client-session-service.ts) — the server half of the client-direct topology (the shipped audio path: the browser opens its own provider socket with a server-minted ephemeral token, while the server keeps prompt/tool authority and executes every relayed tool call). PrepareClientSession resolves the Realtime model, assembles the companion system prompt + memory context (including a resumed session's prior-leg transcript when the caller threads one in), mints the ClientRealtimeSessionConfig, and creates the co-agent observability run (an AIAgentRun + linked AIPromptRun stamped with the co-agent's AgentID, plus a single Prompt-type AIAgentRunStep whose TargetLogID points at the prompt run — finalized with a Success stamp by FinalizeCoAgentRun). ExecuteRelayedTool runs relayed calls through the shared broker — registering each in a per-session in-flight delegation registry so CancelInFlightDelegations(sessionId, callId?) (the engine behind the CancelRealtimeSessionTool mutation) can abort them on explicit user cancel — including resuming a paused (AwaitingFeedback) interactive run and creating artifacts from delegated-run payloads.
RealtimeChannelServerHost (src/realtime/realtime-channel-server-host.ts) — the server half of the interactive-channel plugin registry (MJ: AI Agent Channels.ServerPluginClass; base class BaseRealtimeChannelServer in @memberjunction/ai, mirroring the browser's BaseRealtimeChannelClient). A BaseSingleton host that resolves the ACTIVE registry rows at session mint into one fresh plugin instance per session (unregistered keys skip with a log, never fatal) and routes the durable lifecycle into them: session started (SessionManager.CreateSession), channel-state saves pre-persistence (a plugin may validate/normalize the persisted state of record — it can transform a save, never lose or block one), and session close from every provenance (explicit / janitor / shutdown / error), with a brief post-close linger so the client's final state flush still routes through the plugin before disposal. Every hook is failure-isolated — a throwing plugin can never break a live call.
WhiteboardChannelServer (src/realtime/whiteboard-channel-server.ts, key 'WhiteboardChannelServer') — the reference server channel plugin: guards the Whiteboard's persisted state of record by validating each landed save parses as a JSON object (flagging corrupt payloads at save time instead of at the next resume) and canonicalizing valid payloads to compact JSON. LoadWhiteboardChannelServer() is invoked from MJServer's agentSessions module.
AgentMemoryContextBuilder (src/agent-memory-context-builder.ts) — the memory/RAG injection orchestration extracted out of BaseAgent so the co-agent assembles the same notes/examples/context a loop agent does, with no duplicated logic.
Delegated runs link to the co-agent's run via ParentRunID and share the session's AgentSessionID, so the whole episode — session, co-agent run (with its prompt run + Timeline step), delegated runs, transcript (ConversationDetail rows), channel state, usage telemetry (checkpointed server-side, or relayed from the browser via RelayRealtimeUsage) — groups under one session record with full standard observability.
The browser-side driver layer lives in @memberjunction/ai-realtime-client; the model primitive (BaseRealtimeModel / IRealtimeSession) lives in @memberjunction/ai; the Angular UX (call overlay, interactive channels, the live whiteboard) lives in @memberjunction/ng-conversations. The flagship guide — concept, triple-registry plugin architecture, topologies, session lifecycle, channels, narration, security — is guides/REALTIME_CO_AGENTS_GUIDE.md.
PayloadManager
Manages data flow through agent execution:
- Stores key-value data accessible across all steps and sub-agents
- Supports typed payload changes requested by the LLM
- Validates and applies changes through PayloadChangeAnalyzer
- Provides feedback to the LLM about successful/failed changes via PayloadFeedbackManager
const manager = new PayloadManager();
manager.Set('customerData', { name: 'Acme', revenue: 1000000 });
const data = manager.Get('customerData');
AgentContextInjector
Injects contextual information into agent prompts:
- Retrieves relevant notes via vector similarity search
- Retrieves relevant examples for few-shot learning
- Injects data source content
- Applies reranking when configured
AgentDataPreloader
Optimizes agent startup by batch-loading all required metadata in parallel:
- Agent entity with all relationships
- Actions and their parameters
- Sub-agent data
- Prompt configurations
📖 Memory is a big topic. For the complete architecture — the three-tier model, injection and scoping, the in-flight write pipeline, and the Memory Manager's hardening/consolidation/decay phases — see the Agent Memory Guide. The sections below are component-level summaries.
MemoryWriteManager (In-Flight Memory Writes)
Lets agents commit durable, cross-run memories mid-run — the user says "I prefer bar charts" and the agent records it the moment it's stated, via a memoryWrites field on the loop response (a sibling of scratchpad and artifactToolCalls, processed inline with zero turn cost). Gated per agent via AIAgent.AllowMemoryWrite (on by default — opt out for restricted or experimental agents); disabled agents never see the capability in their system prompt, and the turn loop independently rejects drift.
The agent-facing surface is intentionally trivial ("remember this") — the framework enforces every guard:
- Type restriction — only descriptive
Preference/Context memories in-flight; behavioral/Constraint memories require Memory Manager or human promotion (prompt-injection defense)
- Scope clamp — writes land ≤ Agent + User scope; hints can narrow but never broaden, and never global
- Near-duplicate guard (vector similarity, default
0.85) — a near-dup of a note written earlier in the same run is superseded in place (last write wins); a pre-existing note is reinforced (AccessCount bump) only when the request exactly restates it (normalized text equality). Any textual difference writes a new provisional note instead — a difference may be a correction ("never use pie charts" must not be absorbed into a stale "loves pie charts" note); true paraphrase duplicates are consolidated later by the Memory Manager's hardening dedupe. Fails open if the vector service is unavailable.
- Per-run cap (default 5) and within-run idempotency hashing
- Provenance + TTL — notes land with
Status='Provisional', AuthorType='Agent', source run/conversation stamped, and a 7-day ExpiresAt safety net
Provisional notes are immediately injectable into future runs — rendered first with (provisional) labels, per-note recorded dates ([Preference, 2026-06-10] …, so the policy's most-recent-wins tiebreaker is resolvable), and recency-wins precedence (a just-stated preference beats stale vetted memory) — and are later hardened or pruned by MemoryManagerAgent's hardening pass (below). Every write is recorded as a Tool run step, and outcomes are reported back to the agent in an expiring conversation message so it doesn't re-emit. Writes execute sequentially by design: each save syncs the in-memory vector store that the next write's dedupe check reads.
For the full design see plans/agent-inflight-memory-writes.md; end-to-end verification harness at scripts/memory-write-smoke.ts.
MemoryManagerAgent
Handles persistent memory operations for agents:
- Creating and updating agent notes
- Managing agent examples
- Scoped memory for multi-tenant deployments (UserScope support)
- Consolidation, decay, and protection-tier maintenance over the agent note pool (see below)
- Hardening pass over agent-authored provisional notes — runs unconditionally at the start of every cycle (before the consolidation-gated phases): LLM-dedupes each
Status='Provisional' note against hardened notes (duplicates archived with ConsolidatedIntoNoteID lineage), and hardens survivors to Status='Active' with ExpiresAt=NULL so they join importance scoring, consolidation, contradiction detection, and decay in the same cycle
Consolidation Pipeline
When invoked in maintenance mode, MemoryManagerAgent runs an end-to-end pipeline over the agent's notes to keep the memory pool useful and bounded over time. The pipeline is a sequence of phases on the run, each emitting its own observability data.
- Clustering — groups semantically similar notes by cosine similarity. The clustering threshold is
0.60 (intentionally broad — the LLM is the final arbiter for ambiguous clusters during the consolidate phase).
- Cluster splitting —
splitOversizedCluster breaks any cluster larger than 7 notes so the consolidation prompt stays focused.
- Drift prevention —
maxConsolidationCount = 3 caps the number of times any one note can be folded into successor consolidations. When a cluster reaches the cap, anchored-mode drilling resolves the original sources via DerivedFromNoteIDs so consolidation operates on the underlying facts rather than re-summarizing summaries.
- Consolidate — the LLM generates a merged note for each cluster. The pipeline records
DerivedFromNoteIDs, increments ConsolidationCount, and revokes source notes with ConsolidatedIntoNoteID back-links to preserve provenance.
- Verify Consolidation Output — post-check phase (
verifyConsolidationOutput) confirms entity-attribute coverage hasn't been lost in the merge; reports entitiesChecked and entitiesMissing.
- Contradiction detection — extracts entity-attribute-value triples across active notes, flags conflicting values, and resolves contradictions by revoking the older or lower-importance side.
- Ebbinghaus decay archival — applies a forgetting curve to the importance score over time; low-importance notes that haven't been retrieved are archived.
ProtectionTier modulates the decay rate.
- Protection tiers —
Immutable / Protected / Standard / Ephemeral. Immutable notes are never modified; Protected notes are excluded from consolidation but still age normally; Ephemeral notes decay faster.
- Outlier auto-promotion — notes whose semantic uniqueness lands in the 95th percentile are auto-promoted to
Protected so they aren't swallowed by future consolidations.
The pipeline emits two new run-step types for observability:
Process Consolidation Cluster — one child step per cluster, with clusterSize, noteIds, shouldConsolidate, consolidatedNoteId, sourceNotesArchived, verificationPassed, entitiesChecked, entitiesMissing.
Verify Consolidation Output — phase-level step covering the post-consolidation verification pass.
Run-level payload fields added: scoreDistribution, entityTriplesExtracted, decayScoreDistribution, protectedPreserved, ephemeralAccelerated, and consolidation triggerType (one of forced / time / event / count).
Memory Cleanup Agent has been deprecated — its responsibilities are folded into MemoryManagerAgent's pipeline.
For the full design (functional requirements, threshold rationale, decay curve, contradiction taxonomy), see specs/001-memory-consolidation/spec.md and the implementation in src/memory-manager-agent.ts.
Usage
Basic Agent Execution
import { AgentRunner } from '@memberjunction/ai-agents';
import { ExecuteAgentParams } from '@memberjunction/ai-core-plus';
const runner = new AgentRunner();
const result = await runner.ExecuteAgent({
agentId: 'my-agent-id',
conversationMessages: [
{ role: 'user', content: 'What are the top 5 customers by revenue?' }
],
contextUser: currentUser
});
if (result.success) {
console.log(result.outputMessages);
}
With Sub-Agent Orchestration
Sub-agents are automatically discovered from the agent's relationships and invoked when the LLM requests delegation:
const result = await runner.ExecuteAgent({
agentId: 'orchestrator-agent-id',
conversationMessages: messages,
contextUser: currentUser,
onProgress: (step) => {
console.log(`[${step.agentName}] ${step.message}`);
}
});
With Runtime Action Changes
const result = await runner.ExecuteAgent({
agentId: 'my-agent-id',
conversationMessages: messages,
contextUser: currentUser,
actionChanges: [
{ scope: 'global', mode: 'add', actionIds: ['crm-search-id'] },
{ scope: 'all-subagents', mode: 'remove', actionIds: ['delete-record-id'] }
]
});
With Memory Scope (Multi-Tenant)
Multi-tenant deployments can isolate the agent's memory cohort (notes and examples) per request by passing scope fields on ExecuteAgentParams. The fields are top-level — there is no userScope wrapper:
const result = await runner.ExecuteAgent({
agentId: 'my-agent-id',
conversationMessages: messages,
contextUser: currentUser,
PrimaryScopeEntityName: 'Organizations',
PrimaryScopeRecordID: orgId,
SecondaryScopes: { TeamID: teamId }
});
See docs/AGENT_MEMORY_SCOPING.md for the full model — built-in scopes, primary/secondary semantics, inheritance modes, and how scope propagates through sub-agent invocations.
With Message Lifecycle Management
const result = await runner.ExecuteAgent({
agentId: 'my-agent-id',
conversationMessages: messages,
contextUser: currentUser,
messageExpirationOverride: {
expirationTurns: 3,
expirationMode: 'Compact',
compactMode: 'First N Chars',
compactLength: 500
},
onMessageLifecycle: (event) => {
console.log(`${event.type}: ${event.reason} (saved ${event.tokensSaved} tokens)`);
}
});
Latency Optimizations & Concurrent Sub-Agent Execution
To drastically reduce execution latency, the framework includes the following optimizations:
1. In-Memory Query Embedding Caching
In-memory caching is integrated into AIEngine.EmbedText to bypass redundant local ONNX embedding inference, eliminating CPU-bound event-loop blockages.
- Eviction: Backed by
MJLruCache from @memberjunction/global — a bounded LRU keeps hot queries warm across bursts (default capacity 5000 entries).
- Cache keys:
${modelID}|sha256(text) so a large text doesn't pin its full string in the cache map.
- Promise dedup: Concurrent callers for the same
(model, text) share a single in-flight inference promise — only one ONNX run happens even under fan-out load.
- Control: Callers can supply options
{ bypassCache: true } (re-calculates but caches the new result) or { noCache: true } (bypasses and does not store the result).
- Empty input: Empty/whitespace text short-circuits to
null without invoking the embedding provider.
- Negative result eviction: Failed or empty-vector responses are evicted so subsequent calls retry rather than returning a stale failure.
- Reset: The cache can be manually cleared by calling
AIEngine.Instance.ClearEmbeddingCache().
2. Parallel Data Source Preloading
AgentDataPreloader.PreloadAgentData resolves agent data sources concurrently with a bounded concurrency cap (default 10 in-flight at once) so a long list of sources can't saturate the DB connection pool.
3. Non-blocking Observability DB Logging
Observability writes (AIAgentRunStep records) are completely non-blocking:
- Step creation and finalization
.Save() operations are queued immediately into _pendingSaves promises.
- Sequenced queueing via
_stepSavePromises chains saves on the same step ID to prevent database write races (e.g. executing a step UPDATE before its initial INSERT completes).
- All pending logging writes are drained with
Promise.allSettled inside finalizeAgentRun() and the queues are cleared, so a reused agent instance doesn't leak settled promises. Save failures (rejected promises OR Save()===false) are logged via LogError and a summary is folded into agentRun.ErrorMessage for visibility.
4. Concurrent Sub-Agent Execution
Loop agents can request multiple sub-agents to run in parallel by returning a subAgents array in their nextStep decision:
- Bounded fan-out: Sub-agents dispatch with a configurable concurrency cap (default 5) so a misbehaving LLM can't spawn unbounded parallel runs.
- Deterministic transcript: Delegation messages and progress events are pushed synchronously in the source order of the
subAgents array — completion order doesn't reorder the conversation.
- Payload isolation: Each child sub-agent receives a deep-cloned copy of its input payload, so in-flight mutations by one sibling can't be observed by another.
- State Merging: Aggregates all media/file outputs and sequentially merges child/related sub-agent payloads back into the parent state via the
PayloadManager to avoid race conditions.
- Per-sibling audit trail: Each parallel sub-agent's
AIAgentRunStep records its own contribution as PayloadAtEnd rather than the cumulative merged state, so forensic logs distinguish each sibling.
- Termination semantics: Matches the single sub-agent path — if any dispatched child requested
terminateAfter: true, the parent terminates regardless of whether that child succeeded. The parent's step is reported as Failed when any child failed, Success when terminating cleanly, and Retry otherwise.
- Context Preservation: Appends an aggregated delegation and completion log to the parent conversation context once all parallel steps complete.
Loop Response Schema
{
"taskComplete": false,
"nextStep": {
"type": "Sub-Agent",
"subAgents": [
{ "name": "DbAgent", "message": "Search the database", "terminateAfter": false },
{ "name": "WebAgent", "message": "Gather details from web search", "terminateAfter": false }
]
}
}
Documentation
Detailed guides are available in the docs/ directory:
| Actions Guide | Action discovery, execution, result lifecycle, expiration/compaction, context recovery |
| Client Tools Guide | Browser-side tool invocation, runtime decoration, timeout config, prompt design, security |
| Sub-Agents Guide | Child agents, related agents, payload flow, context propagation, loops |
| Human-in-the-Loop | Feedback requests, assignment strategies, request lifecycle |
| Agent Memory Scoping | Multi-tenant memory (notes/examples) with UserScope support |
| Iterative Operations | ForEach and While loop patterns, parallel execution |
| State Management | Payload management, agent type state |
| Expression Context (PRD) | Expression evaluation in agent contexts |
| Agent Profiles (Proposal) | Proposed agent profile system |
| Code Refactoring Notes | Internal refactoring notes |
| Real-Time Co-Agents Guide | Repo-level flagship guide: Realtime agent type, Realtime Co-Agent, dual topologies, sessions, channels, whiteboard, narration, security |
Re-exports
For backward compatibility, this package re-exports the following from @memberjunction/ai-reranker:
RerankerService
RerankerConfiguration
parseRerankerConfiguration
RerankServiceResult
RerankObservabilityOptions
LLMReranker
New code should import these directly from @memberjunction/ai-reranker.
Dependencies
@memberjunction/ai-prompts -- AIPromptRunner for prompt execution
@memberjunction/aiengine -- AIEngine for metadata and vector search
@memberjunction/ai-core-plus -- Shared types (ExecuteAgentParams, ExecuteAgentResult)
@memberjunction/ai-engine-base -- Base metadata cache and permissions
Storage Account Resolution
When agents create file-based artifacts (PDF, Excel, Word), the system resolves which FileStorageAccount to use via a hierarchical chain. The first non-null value wins:
| 1 (highest) | Runtime | ExecuteAgentParams.override.storageAccountId |
| 2 | Agent | AIAgent.DefaultStorageAccountID |
| 3 | Category tree | AIAgentCategory.DefaultStorageAccountID (walks up ParentID) |
| 4 (lowest) | Agent Type | AIAgentType.DefaultStorageAccountID |
| Fallback | System | Single active account (if only one exists) |
How it works
BaseAgent.getStorageAccountID(params) implements the resolution logic. It is protected so subclasses can override it for custom routing.
- The resolved ID is stored in
ExecuteAgentResult.resolvedStorageAccountId and passed to AgentRunner.ProcessFileArtifacts() for upload routing.
AgentRunner.uploadBase64ToStorage() uses FileStorageEngine.Instance.GetAccountWithProvider() to get the account + provider, then initializeDriverWithAccountCredentials() for proper OAuth credential handling.
Startup validation
AIEngine.validateStorageAccountDefaults() runs at server startup. If 2+ active storage accounts exist but agent types lack a DefaultStorageAccountID, it auto-assigns the highest-priority account and logs a prominent warning.
Configuration
Set DefaultStorageAccountID at any level via the admin UI or metadata sync:
- Agent Type -- broadest default (e.g., all Loop agents → Dropbox)
- Agent Category -- business-domain default (e.g., Marketing → Box, Finance → SharePoint)
- Agent -- per-agent override
- Runtime --
ExecuteAgentParams.override.storageAccountId for programmatic callers
Dependencies
@memberjunction/ai -- Core AI abstractions
@memberjunction/ai-reranker -- Two-stage retrieval reranking
@memberjunction/actions -- Server-side action execution
@memberjunction/actions-base -- Action framework base types
@memberjunction/core -- MJ framework core
@memberjunction/core-entities -- Generated entity classes
@memberjunction/global -- Class factory and utilities
lodash -- Utility functions