@mastra/memory 1.5.0 → 1.5.1

package/dist/docs/references/docs-memory-working-memory.md

@@ -1,400 +0,0 @@
-# Working Memory
-
-While [message history](https://mastra.ai/docs/memory/message-history) and [semantic recall](https://mastra.ai/docs/memory/semantic-recall) help agents remember conversations, working memory allows them to maintain persistent information about users across interactions.
-
-Think of it as the agent's active thoughts or scratchpad – the key information they keep available about the user or task. It's similar to how a person would naturally remember someone's name, preferences, or important details during a conversation.
-
-This is useful for maintaining ongoing state that's always relevant and should always be available to the agent.
-
-Working memory can persist at two different scopes:
-
-- **Resource-scoped** (default): Memory persists across all conversation threads for the same user
-- **Thread-scoped**: Memory is isolated per conversation thread
-
-**Important:** Switching between scopes means the agent won't see memory from the other scope - thread-scoped memory is completely separate from resource-scoped memory.
-
-## Quick Start
-
-Here's a minimal example of setting up an agent with working memory:
-
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { Memory } from "@mastra/memory";
-
-// Create agent with working memory enabled
-const agent = new Agent({
-  id: "personal-assistant",
-  name: "PersonalAssistant",
-  instructions: "You are a helpful personal assistant.",
-  model: "openai/gpt-5.1",
-  memory: new Memory({
-    options: {
-      workingMemory: {
-        enabled: true,
-      },
-    },
-  }),
-});
-```
-
-## How it Works
-
-Working memory is a block of Markdown text that the agent is able to update over time to store continuously relevant information:
-
-[YouTube video player](https://www.youtube-nocookie.com/embed/UMy_JHLf1n8)
-
-## Memory Persistence Scopes
-
-Working memory can operate in two different scopes, allowing you to choose how memory persists across conversations:
-
-### Resource-Scoped Memory (Default)
-
-By default, working memory persists across all conversation threads for the same user (resourceId), enabling persistent user memory:
-
-```typescript
-const memory = new Memory({
-  storage,
-  options: {
-    workingMemory: {
-      enabled: true,
-      scope: "resource", // Memory persists across all user threads
-      template: `# User Profile
-- **Name**:
-- **Location**:
-- **Interests**:
-- **Preferences**:
-- **Long-term Goals**:
-`,
-    },
-  },
-});
-```
-
-**Use cases:**
-
-- Personal assistants that remember user preferences
-- Customer service bots that maintain customer context
-- Educational applications that track student progress
-
-### Usage with Agents
-
-When using resource-scoped memory, make sure to pass the `resource` parameter in the memory options:
-
-```typescript
-// Resource-scoped memory requires resource
-const response = await agent.generate("Hello!", {
-  memory: {
-    thread: "conversation-123",
-    resource: "user-alice-456", // Same user across different threads
-  },
-});
-```
-
-### Thread-Scoped Memory
-
-Thread-scoped memory isolates working memory to individual conversation threads. Each thread maintains its own isolated memory:
-
-```typescript
-const memory = new Memory({
-  storage,
-  options: {
-    workingMemory: {
-      enabled: true,
-      scope: "thread", // Memory is isolated per thread
-      template: `# User Profile
-- **Name**:
-- **Interests**:
-- **Current Goal**:
-`,
-    },
-  },
-});
-```
-
-**Use cases:**
-
-- Different conversations about separate topics
-- Temporary or session-specific information
-- Workflows where each thread needs working memory but threads are ephemeral and not related to each other
-
-## Storage Adapter Support
-
-Resource-scoped working memory requires specific storage adapters that support the `mastra_resources` table:
-
-### Supported Storage Adapters
-
-- **libSQL** (`@mastra/libsql`)
-- **PostgreSQL** (`@mastra/pg`)
-- **Upstash** (`@mastra/upstash`)
-- **MongoDB** (`@mastra/mongodb`)
-
-## Custom Templates
-
-Templates guide the agent on what information to track and update in working memory. While a default template is used if none is provided, you'll typically want to define a custom template tailored to your agent's specific use case to ensure it remembers the most relevant information.
-
-Here's an example of a custom template. In this example the agent will store the users name, location, timezone, etc as soon as the user sends a message containing any of the info:
-
-```typescript
-const memory = new Memory({
-  options: {
-    workingMemory: {
-      enabled: true,
-      template: `
-# User Profile
-
-## Personal Info
-
-- Name:
-- Location:
-- Timezone:
-
-## Preferences
-
-- Communication Style: [e.g., Formal, Casual]
-- Project Goal:
-- Key Deadlines:
-  - [Deadline 1]: [Date]
-  - [Deadline 2]: [Date]
-
-## Session State
-
-- Last Task Discussed:
-- Open Questions:
-  - [Question 1]
-  - [Question 2]
-`,
-    },
-  },
-});
-```
-
-## Designing Effective Templates
-
-A well-structured template keeps the information easy for the agent to parse and update. Treat the template as a short form that you want the assistant to keep up to date.
-
-- **Short, focused labels.** Avoid paragraphs or very long headings. Keep labels brief (for example `## Personal Info` or `- Name:`) so updates are easy to read and less likely to be truncated.
-- **Use consistent casing.** Inconsistent capitalization (`Timezone:` vs `timezone:`) can cause messy updates. Stick to Title Case or lower case for headings and bullet labels.
-- **Keep placeholder text simple.** Use hints such as `[e.g., Formal]` or `[Date]` to help the LLM fill in the correct spots.
-- **Abbreviate very long values.** If you only need a short form, include guidance like `- Name: [First name or nickname]` or `- Address (short):` rather than the full legal text.
-- **Mention update rules in `instructions`.** You can instruct how and when to fill or clear parts of the template directly in the agent's `instructions` field.
-
-### Alternative Template Styles
-
-Use a shorter single block if you only need a few items:
-
-```typescript
-const basicMemory = new Memory({
-  options: {
-    workingMemory: {
-      enabled: true,
-      template: `User Facts:\n- Name:\n- Favorite Color:\n- Current Topic:`,
-    },
-  },
-});
-```
-
-You can also store the key facts in a short paragraph format if you prefer a more narrative style:
-
-```typescript
-const paragraphMemory = new Memory({
-  options: {
-    workingMemory: {
-      enabled: true,
-      template: `Important Details:\n\nKeep a short paragraph capturing the user's important facts (name, main goal, current task).`,
-    },
-  },
-});
-```
-
-## Structured Working Memory
-
-Working memory can also be defined using a structured schema instead of a Markdown template. This allows you to specify the exact fields and types that should be tracked, using a [Zod](https://zod.dev/) schema. When using a schema, the agent will see and update working memory as a JSON object matching your schema.
-
-**Important:** You must specify either `template` or `schema`, but not both.
-
-### Example: Schema-Based Working Memory
-
-```typescript
-import { z } from "zod";
-import { Memory } from "@mastra/memory";
-
-const userProfileSchema = z.object({
-  name: z.string().optional(),
-  location: z.string().optional(),
-  timezone: z.string().optional(),
-  preferences: z
-    .object({
-      communicationStyle: z.string().optional(),
-      projectGoal: z.string().optional(),
-      deadlines: z.array(z.string()).optional(),
-    })
-    .optional(),
-});
-
-const memory = new Memory({
-  options: {
-    workingMemory: {
-      enabled: true,
-      schema: userProfileSchema,
-      // template: ... (do not set)
-    },
-  },
-});
-```
-
-When a schema is provided, the agent receives the working memory as a JSON object. For example:
-
-```json
-{
-  "name": "Sam",
-  "location": "Berlin",
-  "timezone": "CET",
-  "preferences": {
-    "communicationStyle": "Formal",
-    "projectGoal": "Launch MVP",
-    "deadlines": ["2025-07-01"]
-  }
-}
-```
-
-### Merge Semantics for Schema-Based Memory
-
-Schema-based working memory uses **merge semantics**, meaning the agent only needs to include fields it wants to add or update. Existing fields are preserved automatically.
-
-- **Object fields are deep merged:** Only provided fields are updated; others remain unchanged
-- **Set a field to `null` to delete it:** This explicitly removes the field from memory
-- **Arrays are replaced entirely:** When an array field is provided, it replaces the existing array (arrays are not merged element-by-element)
-
-## Choosing Between Template and Schema
-
-- Use a **template** (Markdown) if you want the agent to maintain memory as a free-form text block, such as a user profile or scratchpad. Templates use **replace semantics** — the agent must provide the complete memory content on each update.
-- Use a **schema** if you need structured, type-safe data that can be validated and programmatically accessed as JSON. Schemas use **merge semantics** — the agent only provides fields to update, and existing fields are preserved.
-- Only one mode can be active at a time: setting both `template` and `schema` is not supported.
-
-## Example: Multi-step Retention
-
-Below is a simplified view of how the `User Profile` template updates across a short user conversation:
-
-```nohighlight
-# User Profile
-
-## Personal Info
-
-- Name:
-- Location:
-- Timezone:
-
---- After user says "My name is **Sam** and I'm from **Berlin**" ---
-
-# User Profile
-- Name: Sam
-- Location: Berlin
-- Timezone:
-
---- After user adds "By the way I'm normally in **CET**" ---
-
-# User Profile
-- Name: Sam
-- Location: Berlin
-- Timezone: CET
-```
-
-The agent can now refer to `Sam` or `Berlin` in later responses without requesting the information again because it has been stored in working memory.
-
-If your agent is not properly updating working memory when you expect it to, you can add system instructions on _how_ and _when_ to use this template in your agent's `instructions` setting.
-
-## Setting Initial Working Memory
-
-While agents typically update working memory through the `updateWorkingMemory` tool, you can also set initial working memory programmatically when creating or updating threads. This is useful for injecting user data (like their name, preferences, or other info) that you want available to the agent without passing it in every request.
-
-### Setting Working Memory via Thread Metadata
-
-When creating a thread, you can provide initial working memory through the metadata's `workingMemory` key:
-
-```typescript
-// Create a thread with initial working memory
-const thread = await memory.createThread({
-  threadId: "thread-123",
-  resourceId: "user-456",
-  title: "Medical Consultation",
-  metadata: {
-    workingMemory: `# Patient Profile
-- Name: John Doe
-- Blood Type: O+
-- Allergies: Penicillin
-- Current Medications: None
-- Medical History: Hypertension (controlled)
-`,
-  },
-});
-
-// The agent will now have access to this information in all messages
-await agent.generate("What's my blood type?", {
-  memory: {
-    thread: thread.id,
-    resource: "user-456",
-  },
-});
-// Response: "Your blood type is O+."
-```
-
-### Updating Working Memory Programmatically
-
-You can also update an existing thread's working memory:
-
-```typescript
-// Update thread metadata to add/modify working memory
-await memory.updateThread({
-  id: "thread-123",
-  title: thread.title,
-  metadata: {
-    ...thread.metadata,
-    workingMemory: `# Patient Profile
-- Name: John Doe
-- Blood Type: O+
-- Allergies: Penicillin, Ibuprofen  // Updated
-- Current Medications: Lisinopril 10mg daily  // Added
-- Medical History: Hypertension (controlled)
-`,
-  },
-});
-```
-
-### Direct Memory Update
-
-Alternatively, use the `updateWorkingMemory` method directly:
-
-```typescript
-await memory.updateWorkingMemory({
-  threadId: "thread-123",
-  resourceId: "user-456", // Required for resource-scoped memory
-  workingMemory: "Updated memory content...",
-});
-```
-
-## Read-Only Working Memory
-
-In some scenarios, you may want an agent to have access to working memory data without the ability to modify it. This is useful for:
-
-- **Routing agents** that need context but shouldn't update user profiles
-- **Sub agents** in a multi-agent system that should reference but not own the memory
-
-To enable read-only mode, set `readOnly: true` in the memory options:
-
-```typescript
-const response = await agent.generate("What do you know about me?", {
-  memory: {
-    thread: "conversation-123",
-    resource: "user-alice-456",
-    options: {
-      readOnly: true, // Working memory is provided but cannot be updated
-    },
-  },
-});
-```
-
-## Examples
-
-- [Working memory with template](https://github.com/mastra-ai/mastra/tree/main/examples/memory-with-template)
-- [Working memory with schema](https://github.com/mastra-ai/mastra/tree/main/examples/memory-with-schema)
-- [Per-resource working memory](https://github.com/mastra-ai/mastra/tree/main/examples/memory-per-resource-example) - Complete example showing resource-scoped memory persistence

package/dist/docs/references/reference-core-getMemory.md

@@ -1,50 +0,0 @@
-# Mastra.getMemory()
-
-The `.getMemory()` method retrieves a memory instance from the Mastra registry by its key. Memory instances are registered in the Mastra constructor and can be referenced by stored agents.
-
-## Usage example
-
-```typescript
-const memory = mastra.getMemory("conversationMemory");
-
-// Use the memory instance
-const thread = await memory.createThread({
-  resourceId: "user-123",
-  title: "New Conversation",
-});
-```
-
-## Parameters
-
-**key:** (`TMemoryKey extends keyof TMemory`): The registry key of the memory instance to retrieve. Must match a key used when registering memory in the Mastra constructor.
-
-## Returns
-
-**memory:** (`TMemory[TMemoryKey]`): The memory instance with the specified key. Throws an error if the memory is not found.
-
-## Example: Registering and Retrieving Memory
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { Memory } from "@mastra/memory";
-import { LibSQLStore } from "@mastra/libsql";
-
-const conversationMemory = new Memory({
-  storage: new LibSQLStore({ id: 'conversation-store', url: ":memory:" }),
-});
-
-const mastra = new Mastra({
-  memory: {
-    conversationMemory,
-  },
-});
-
-// Later, retrieve the memory instance
-const memory = mastra.getMemory("conversationMemory");
-```
-
-## Related
-
-- [Mastra.listMemory()](https://mastra.ai/reference/core/listMemory)
-- [Memory overview](https://mastra.ai/docs/memory/overview)
-- [Agent Memory](https://mastra.ai/docs/agents/agent-memory)

package/dist/docs/references/reference-core-listMemory.md

@@ -1,56 +0,0 @@
-# Mastra.listMemory()
-
-The `.listMemory()` method returns all memory instances registered with the Mastra instance.
-
-## Usage example
-
-```typescript
-const memoryInstances = mastra.listMemory();
-
-for (const [key, memory] of Object.entries(memoryInstances)) {
-  console.log(`Memory "${key}": ${memory.id}`);
-}
-```
-
-## Parameters
-
-This method takes no parameters.
-
-## Returns
-
-**memory:** (`Record<string, MastraMemory>`): An object containing all registered memory instances, keyed by their registry keys.
-
-## Example: Checking Registered Memory
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { Memory } from "@mastra/memory";
-import { LibSQLStore } from "@mastra/libsql";
-
-const conversationMemory = new Memory({
-  id: "conversation-memory",
-  storage: new LibSQLStore({ id: 'conversation-store', url: ":memory:" }),
-});
-
-const analyticsMemory = new Memory({
-  id: "analytics-memory",
-  storage: new LibSQLStore({ id: 'analytics-store', url: ":memory:" }),
-});
-
-const mastra = new Mastra({
-  memory: {
-    conversationMemory,
-    analyticsMemory,
-  },
-});
-
-// List all registered memory instances
-const allMemory = mastra.listMemory();
-console.log(Object.keys(allMemory)); // ["conversationMemory", "analyticsMemory"]
-```
-
-## Related
-
-- [Mastra.getMemory()](https://mastra.ai/reference/core/getMemory)
-- [Memory overview](https://mastra.ai/docs/memory/overview)
-- [Agent Memory](https://mastra.ai/docs/agents/agent-memory)

package/dist/docs/references/reference-memory-clone-utilities.md

@@ -1,199 +0,0 @@
-# Cloned Thread Utilities
-
-The Memory class provides utility methods for working with cloned threads. These methods help you check clone status, retrieve clone metadata, navigate clone relationships, and track clone history.
-
-## isClone()
-
-Checks whether a thread is a clone of another thread.
-
-### Usage
-
-```typescript
-const isClonedThread = memory.isClone(thread);
-```
-
-### Parameters
-
-**thread:** (`StorageThreadType`): The thread object to check.
-
-### Example
-
-```typescript
-const thread = await memory.getThreadById({ threadId: "some-thread-id" });
-
-if (memory.isClone(thread)) {
-  console.log("This thread was cloned from another thread");
-} else {
-  console.log("This is an original thread");
-}
-```
-
-## getCloneMetadata()
-
-Retrieves the clone metadata from a thread if it exists.
-
-### Usage
-
-```typescript
-const metadata = memory.getCloneMetadata(thread);
-```
-
-### Parameters
-
-**thread:** (`StorageThreadType`): The thread object to extract clone metadata from.
-
-### Example
-
-```typescript
-const thread = await memory.getThreadById({ threadId: "cloned-thread-id" });
-const cloneInfo = memory.getCloneMetadata(thread);
-
-if (cloneInfo) {
-  console.log(`Cloned from: ${cloneInfo.sourceThreadId}`);
-  console.log(`Cloned at: ${cloneInfo.clonedAt}`);
-}
-```
-
-## getSourceThread()
-
-Retrieves the original source thread that a cloned thread was created from.
-
-### Usage
-
-```typescript
-const sourceThread = await memory.getSourceThread(threadId);
-```
-
-### Parameters
-
-**threadId:** (`string`): The ID of the cloned thread.
-
-### Example
-
-```typescript
-const sourceThread = await memory.getSourceThread("cloned-thread-id");
-
-if (sourceThread) {
-  console.log(`Original thread title: ${sourceThread.title}`);
-  console.log(`Original thread created: ${sourceThread.createdAt}`);
-}
-```
-
-## listClones()
-
-Lists all threads that were cloned from a specific source thread.
-
-### Usage
-
-```typescript
-const clones = await memory.listClones(sourceThreadId);
-```
-
-### Parameters
-
-**sourceThreadId:** (`string`): The ID of the source thread to find clones for.
-
-### Example
-
-```typescript
-const clones = await memory.listClones("original-thread-id");
-
-console.log(`Found ${clones.length} clones`);
-for (const clone of clones) {
-  console.log(`- ${clone.id}: ${clone.title}`);
-}
-```
-
-## getCloneHistory()
-
-Retrieves the full clone history chain for a thread, tracing back to the original.
-
-### Usage
-
-```typescript
-const history = await memory.getCloneHistory(threadId);
-```
-
-### Parameters
-
-**threadId:** (`string`): The ID of the thread to get clone history for.
-
-### Example
-
-```typescript
-// If thread-c was cloned from thread-b, which was cloned from thread-a
-const history = await memory.getCloneHistory("thread-c");
-
-// history = [thread-a, thread-b, thread-c]
-console.log(`Clone depth: ${history.length - 1}`);
-console.log(`Original thread: ${history[0].id}`);
-console.log(`Current thread: ${history[history.length - 1].id}`);
-
-// Display the clone chain
-for (let i = 0; i < history.length; i++) {
-  const prefix = i === 0 ? "Original" : `Clone ${i}`;
-  console.log(`${prefix}: ${history[i].title}`);
-}
-```
-
-## Complete Example
-
-```typescript
-import { mastra } from "./mastra";
-
-async function manageClones() {
-  const agent = mastra.getAgent("agent");
-  const memory = await agent.getMemory();
-
-  // Create an original conversation
-  const originalThread = await memory.createThread({
-    resourceId: "user-123",
-    title: "Original Conversation",
-  });
-
-  // Have a conversation...
-  await agent.generate("Hello! Let's discuss project options.", {
-    threadId: originalThread.id,
-    resourceId: "user-123",
-  });
-
-  // Create multiple branches (clones) to explore different paths
-  const { thread: optionA } = await memory.cloneThread({
-    sourceThreadId: originalThread.id,
-    title: "Option A - Conservative Approach",
-  });
-
-  const { thread: optionB } = await memory.cloneThread({
-    sourceThreadId: originalThread.id,
-    title: "Option B - Aggressive Approach",
-  });
-
-  // Check clone status
-  console.log(memory.isClone(originalThread)); // false
-  console.log(memory.isClone(optionA)); // true
-  console.log(memory.isClone(optionB)); // true
-
-  // Get clone metadata
-  const metadataA = memory.getCloneMetadata(optionA);
-  console.log(metadataA?.sourceThreadId); // originalThread.id
-
-  // List all clones of the original
-  const allClones = await memory.listClones(originalThread.id);
-  console.log(`Total alternatives: ${allClones.length}`); // 2
-
-  // Get source thread from a clone
-  const source = await memory.getSourceThread(optionA.id);
-  console.log(source?.id === originalThread.id); // true
-
-  // Create a deeper clone chain
-  const { thread: optionA2 } = await memory.cloneThread({
-    sourceThreadId: optionA.id,
-    title: "Option A - Variant 2",
-  });
-
-  // Get the full history
-  const history = await memory.getCloneHistory(optionA2.id);
-  // history = [originalThread, optionA, optionA2]
-  console.log(`Clone depth: ${history.length - 1}`); // 2
-}
-```