RunContext

Properties

abortSignal?

optional abortSignal?: AbortSignal;

---

agentTools?

optional agentTools?: Record<string, AnyTool>;

Agent-scoped tools (agent.tools) for toolScope: 'open' resolution in flow nodes.

---

autoRetrieve?

optional autoRetrieve?: AutoRetrieveProvider;

---

bargeIn?

optional bargeIn?: AbortSignal;

---

baseInstructions?

optional baseInstructions?: Instructions;

Agent base layer, set when entering a flow. baseInstructions is composed as a prefix into every node turn’s system prompt (persona / safety / grounding floor); globalTools are safe tools made model-visible in every speaking turn.

---

controlModel

controlModel: LanguageModel;

Control-path model (routing, decide, extraction) at temperature 0.

---

emit

emit: (part) => void;

Parameters

Parameter	Type
part	StreamPart

Returns

void

---

flowGateJudge?

optional flowGateJudge?:
  | LanguageModel
  | FlowGateJudgeProvider;

Structured judge for flow gates of kind judge. Absent at evaluation time is an execution error (always blocking).

---

fs?

optional fs?: FileSystem;

Agent workspace filesystem (same instance as AgentConfig.workspace).

---

globalTools?

optional globalTools?: Record<string, AnyTool>;

---

inputProcessors

inputProcessors: InputProcessor[];

---

lastRetrievalCitations?

optional lastRetrievalCitations?: SourceRef[];

Citations from the latest gather-phase retrieval on this turn.

---

limits?

optional limits?: Limits;

---

memoryService?

optional memoryService?: MemoryService;

---

model

model: LanguageModel;

---

outOfBandControl

outOfBandControl: boolean;

When true, flow reply nodes use the out-of-band control evaluator.

---

outputProcessors

outputProcessors: OutputProcessor[];

---

policy

policy: Policy;

Decides allow / ask / deny per tool call. Reassigned on handoff.

---

refinementPolicies

refinementPolicies: RefinementCapability[];

---

retrievalCache?

optional retrievalCache?: RetrievalCacheAdapter;

Session retrieval cache (G6): created once per run by the KnowledgeProvider, persists across in-session agent handoffs (this RunContext survives the handoff branch). Keyed by query embedding; RAG-only, undefined without a configured knowledge provider + embedder.

---

runState

runState: RunState;

---

runStore

runStore: RunStore;

---

session

session: Session;

---

skillActivations?

optional skillActivations?: SkillActivation[];

Turn-scoped skills activated by successful load_skill with allowed-tools.

---

skillCatalog?

optional skillCatalog?: LiveSkillCatalog;

The live skill catalog load_skill resolves against for this run. The frozen roster in skillPrompt is the baseline; this mutates freely and changes are announced in the transcript (never by rewriting skillPrompt). Undefined when the agent has no skills.

---

skillPrompt?

optional skillPrompt?: string;

Level-1 skill metadata injected by SkillsCapability when AgentConfig.skills is set.

---

telemetry?

optional telemetry?: TelemetryOptions;

---

toolExecutor

toolExecutor: EffectToolExecutor;

---

turnInputConsumed?

optional turnInputConsumed?: boolean;

Ephemeral, per-run-invocation flag: has the current turn’s user input been consumed yet by an input-node (collect/decide)? Input-nodes extract/decide from the turn’s fresh input; once it is consumed, later nodes in the same turn pause (present prompt, await next turn) instead of acting on stale context. Reset to false on every createRunContext (i.e. every turn).

---

validationPolicies

validationPolicies: ValidationCapability[];

---

workingMemoryPrompt?

optional workingMemoryPrompt?: string;

Frozen persistent memory blocks loaded at session start (AgentMemory.workingMemory).

---

workingMemoryTools?

optional workingMemoryTools?: Record<string, AnyTool>;

Model-visible tools from working memory wiring (not in globalTools — mutating but scoped).

Methods

addSkill()

addSkill(skill): Promise<void>;

Add a skill to the live catalog for the current session. Announces the change once in the transcript and leaves skillPrompt byte-identical. No-op when the agent has no skills.

Parameters

Parameter	Type
skill	SkillLike

Returns

Promise<void>

---

approve()

approve(req): Promise<{
  approved: boolean;
  by?: string;
}>;

Parameters

Parameter	Type
req	{ description?: string; title: string; }
req.description?	string
req.title	string

Returns

Promise<{ approved: boolean; by?: string; }>

---

getSkill()

getSkill(name): SkillHandle;

Read-only access to bundled skill resources for tool/action code.

Parameters

Parameter	Type
name	string

Returns

SkillHandle

---

now()

now(): Promise<number>;

Returns

Promise<number>

---

removeSkill()

removeSkill(name): Promise<void>;

Withdraw a skill from the live catalog. Announces the withdrawal once. No-op when the agent has no skills or the skill was never available.

Parameters

Parameter	Type
name	string

Returns

Promise<void>

---

reserveCallsites()

reserveCallsites(count): string[];

Reserve N contiguous effect callsite ordinals for parallel-safe tool batches (G9).

Parameters

Parameter	Type
count	number

Returns

string[]

---

resetCallsites()

resetCallsites(): void;

Rebase durable effect callsites to 0. The runtime calls this at flow entry so a flow’s durable callsites are anchored to the flow — identical on fresh entry (after an answering turn) and on resume (where that turn does not re-run).

Returns

void

---

signal()

signal<T>(name, opts): Promise<T>;

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
name	string
opts	{ deadline?: number; description?: string; meta?: Record<string, unknown>; responseSchema?: Record<string, unknown>; schema: StandardSchemaV1<unknown, T>; title?: string; }
opts.deadline?	number
opts.description?	string
opts.meta?	Record<string, unknown>
opts.responseSchema?	Record<string, unknown>
opts.schema	StandardSchemaV1<unknown, T>
opts.title?	string

Returns

Promise<T>

---

tool()

tool(
   name,
   args,
options?): Promise<unknown>;

Parameters

Parameter	Type	Description
name	string	‐
args	unknown	‐
options?	{ callsite?: string; def?: AnyTool; index?: number; toolCallId?: string; toolCtx?: ToolContext; }	‐
options.callsite?	string	Pre-reserved callsite ordinal for parallel-safe tool batches (G9).
options.def?	AnyTool	‐
options.index?	number	Pre-reserved journal index for parallel-safe tool batches (G9).
options.toolCallId?	string	‐
options.toolCtx?	ToolContext	‐

Returns

Promise<unknown>

---

uuid()

uuid(): Promise<string>;

Returns

Promise<string>