Class ScratchpadManager

Manages the agent's ephemeral scratchpad (notes + task list) during a single run.

The scratchpad is:

In-memory only — not persisted to DB (snapshots are stored in step InputData/OutputData)
Ephemeral per run — starts empty, garbage collected when the run ends
Private — never shared with parent or sub-agents

Example

const manager = new ScratchpadManager();

// Apply changes from LLM response
manager.applyScratchpadChanges({
    notes: "Found 3 data sources to analyze",
    taskList: {
        upsert: [
            { id: "t1", title: "Analyze sales data", status: "in_progress" },
            { id: "t2", title: "Analyze marketing data", status: "pending" }
        ]
    }
});

// Get snapshot for step OutputData
const snapshot = manager.toJSON();

// Get prompt-friendly representation
const promptText = manager.toPromptString();

Index

Constructors

constructor

Methods

ApplyScratchpadChanges Clear EnforceTaskLimit GetNotes GetTaskCounts GetTasks GetTasksByStatus GetTaskSummary HasContent RemoveTasks SetNotes ToJSON ToPromptString UpsertTasks

Constructors

constructor

new ScratchpadManager(): ScratchpadManager
Returns ScratchpadManager

Methods

ApplyScratchpadChanges

ApplyScratchpadChanges(scratchpad: AgentScratchpad): void
Apply a scratchpad change from the LLM response. Handles both notes and task list changes in one call.
Parameters
- scratchpad: AgentScratchpad
Returns void
- Defined in AI/Agents/src/ScratchpadManager.ts:133

Clear

Clear(): void
Reset the scratchpad to empty state.

Returns void
- Defined in AI/Agents/src/ScratchpadManager.ts:244

EnforceTaskLimit

EnforceTaskLimit(maxTasks: number): number
Enforce the maximum task limit by pruning completed tasks (oldest first). Returns the number of tasks pruned.
Parameters
- maxTasks: number
Returns number
- Defined in AI/Agents/src/ScratchpadManager.ts:154

GetNotes

GetNotes(): string
Get the current notes content.

Returns string
- Defined in AI/Agents/src/ScratchpadManager.ts:61

GetTaskCounts

GetTaskCounts(): Record<AgentTaskStatus, number>
Return counts per status.

Returns Record<AgentTaskStatus, number>
- Defined in AI/Agents/src/ScratchpadManager.ts:112

GetTasks

GetTasks(): AgentTask[]
Return the current task list.

Returns AgentTask[]
- Defined in AI/Agents/src/ScratchpadManager.ts:98

GetTasksByStatus

GetTasksByStatus(
status: "blocked" | "pending" | "in_progress" | "completed",
): AgentTask[]
Return tasks filtered by status.
Parameters
- status: "blocked" | "pending" | "in_progress" | "completed"
Returns AgentTask[]
- Defined in AI/Agents/src/ScratchpadManager.ts:105

GetTaskSummary

GetTaskSummary(): string
Returns a compact one-line summary of task progress. E.g., "3 of 7 tasks complete, 1 blocked"

Returns string
- Defined in AI/Agents/src/ScratchpadManager.ts:220

HasContent

HasContent(): boolean
Returns true if the scratchpad has any content (notes or tasks).

Returns boolean
- Defined in AI/Agents/src/ScratchpadManager.ts:237

RemoveTasks

RemoveTasks(ids: string[]): void
Remove tasks by ID.
Parameters
- ids: string[]
Returns void
- Defined in AI/Agents/src/ScratchpadManager.ts:89

SetNotes

SetNotes(text: string): void
Replace the current notes content.
Parameters
- text: string
Returns void
- Defined in AI/Agents/src/ScratchpadManager.ts:54

ToJSON

ToJSON(): ScratchpadSnapshot
Returns a plain object snapshot for persisting in step InputData/OutputData.

Returns ScratchpadSnapshot
- Defined in AI/Agents/src/ScratchpadManager.ts:180

ToPromptString

ToPromptString(): string
Generates a compact markdown representation for prompt injection. More token-efficient than raw JSON dump.

Returns string
- Defined in AI/Agents/src/ScratchpadManager.ts:191

UpsertTasks

UpsertTasks(tasks: AgentTask[]): void
Add new tasks or update existing ones (matched by id). If a task with the same id exists, it is replaced entirely.
Parameters
- tasks: AgentTask[]
Returns void
- Defined in AI/Agents/src/ScratchpadManager.ts:71

Class ScratchpadManager

Example

Index

Constructors

Methods

Constructors

constructor

Returns ScratchpadManager

Methods

ApplyScratchpadChanges

Parameters

Returns void

Clear

Returns void

EnforceTaskLimit

Parameters

Returns number

GetNotes

Returns string

GetTaskCounts

Returns Record<AgentTaskStatus, number>

GetTasks

Returns AgentTask[]

GetTasksByStatus

Parameters

Returns AgentTask[]

GetTaskSummary

Returns string

HasContent

Returns boolean

RemoveTasks

Parameters

Returns void

SetNotes

Parameters

Returns void

ToJSON

Returns ScratchpadSnapshot

ToPromptString

Returns string

UpsertTasks

Parameters

Returns void

Settings

On This Page