@mastra/memory 1.0.0 → 1.0.1-alpha.1

package/dist/docs/memory/03-message-history.md

@@ -0,0 +1,249 @@
+> Learn how to configure message history in Mastra to store recent messages from the current conversation.
+
+# Message History
+
+Message history is the most basic and important form of memory. It gives the LLM a view of recent messages in the context window, enabling your agent to reference earlier exchanges and respond coherently. 
+
+You can also retrieve message history to display past conversations in your UI.
+
+> **Note:**
+Each message belongs to a thread (the conversation) and a resource (the user or entity it's associated with). See [Threads and resources](https://mastra.ai/docs/memory/storage#threads-and-resources) for more detail.
+
+## Getting started
+
+Install the Mastra memory module along with a [storage adapter](https://mastra.ai/docs/memory/storage#supported-providers) for your database. The examples below use `@mastra/libsql`, which stores data locally in a `mastra.db` file.
+
+```bash npm2yarn
+npm install @mastra/memory@latest @mastra/libsql@latest
+```
+
+Message history requires a storage adapter to persist conversations. Configure storage on your Mastra instance if you haven't already:
+
+```typescript title="src/mastra/index.ts"
+import { Mastra } from "@mastra/core";
+import { LibSQLStore } from "@mastra/libsql";
+
+export const mastra = new Mastra({
+  storage: new LibSQLStore({
+    id: 'mastra-storage',
+    url: "file:./mastra.db",
+  }),
+});
+```
+
+Give your agent a `Memory`:
+
+```typescript title="src/mastra/agents/your-agent.ts"
+import { Memory } from "@mastra/memory";
+import { Agent } from "@mastra/core/agent";
+
+export const agent = new Agent({
+  id: "test-agent",
+  memory: new Memory({
+    options: {
+      lastMessages: 10,
+    },
+  }),
+});
+```
+
+When you call the agent, messages are automatically saved to the database. You can specify a `threadId`, `resourceId`, and optional `metadata`:
+
+  **generate:**
+
+```typescript
+await agent.generate("Hello", {
+  memory: {
+    thread: {
+      id: "thread-123",
+      title: "Support conversation",
+      metadata: { category: "billing" },
+    },
+    resource: "user-456",
+  },
+});
+```
+
+  
+  **stream:**
+
+```typescript
+await agent.stream("Hello", {
+  memory: {
+    thread: {
+      id: "thread-123",
+      title: "Support conversation",
+      metadata: { category: "billing" },
+    },
+    resource: "user-456",
+  },
+});
+```
+
+  
+
+> **Note:**
+
+Threads and messages are created automatically when you call `agent.generate()` or `agent.stream()`, but you can also create them manually with [`createThread()`](https://mastra.ai/reference/memory/createThread) and [`saveMessages()`](https://mastra.ai/reference/memory/memory-class). 
+
+There are two ways to use this history:
+
+- **Automatic inclusion** - Mastra automatically fetches and includes recent messages in the context window. By default, it includes the last 10 messages, keeping agents grounded in the conversation. You can adjust this number with `lastMessages`, but in most cases you don't need to think about it.
+- [**Manual querying**](#querying) - For more control, use the `recall()` function to query threads and messages directly. This lets you choose exactly which memories are included in the context window, or fetch messages to render conversation history in your UI.
+
+## Accessing Memory
+
+To access memory functions for querying, cloning, or deleting threads and messages, call `getMemory()` on an agent:
+
+```typescript
+const agent = mastra.getAgent("weatherAgent");
+const memory = await agent.getMemory();
+```
+
+The `Memory` instance gives you access to functions for listing threads, recalling messages, cloning conversations, and more.
+
+## Querying
+
+Use these methods to fetch threads and messages for displaying conversation history in your UI or for custom memory retrieval logic.
+
+> **Note:**
+The memory system does not enforce access control. Before running any query, verify in your application logic that the current user is authorized to access the `resourceId` being queried.
+
+### Threads
+
+Use [`listThreads()`](https://mastra.ai/reference/memory/listThreads) to retrieve threads for a resource:
+
+```typescript
+const result = await memory.listThreads({
+  filter: { resourceId: "user-123" },
+  perPage: false,
+});
+```
+
+Paginate through threads:
+
+```typescript
+const result = await memory.listThreads({
+  filter: { resourceId: "user-123" },
+  page: 0,
+  perPage: 10,
+});
+
+console.log(result.threads); // thread objects
+console.log(result.hasMore); // more pages available?
+```
+
+You can also filter by metadata and control sort order:
+
+```typescript
+const result = await memory.listThreads({
+  filter: {
+    resourceId: "user-123",
+    metadata: { status: "active" },
+  },
+  orderBy: { field: "createdAt", direction: "DESC" },
+});
+```
+
+To fetch a single thread by ID, use [`getThreadById()`](https://mastra.ai/reference/memory/getThreadById):
+
+```typescript
+const thread = await memory.getThreadById({ threadId: "thread-123" });
+```
+
+### Messages
+
+Once you have a thread, use [`recall()`](https://mastra.ai/reference/memory/recall) to retrieve its messages. It supports pagination, date filtering, and [semantic search](https://mastra.ai/docs/memory/semantic-recall).
+
+Basic recall returns all messages from a thread:
+
+```typescript
+const { messages } = await memory.recall({
+  threadId: "thread-123",
+  perPage: false,
+});
+```
+
+Paginate through messages:
+
+```typescript
+const { messages } = await memory.recall({
+  threadId: "thread-123",
+  page: 0,
+  perPage: 50,
+});
+```
+
+Filter by date range:
+
+```typescript
+const { messages } = await memory.recall({
+  threadId: "thread-123",
+  filter: {
+    dateRange: {
+      start: new Date("2025-01-01"),
+      end: new Date("2025-06-01"),
+    },
+  },
+});
+```
+
+Fetch a single message by ID:
+
+```typescript
+const { messages } = await memory.recall({
+  threadId: "thread-123",
+  include: [{ id: "msg-123" }],
+});
+```
+
+Fetch multiple messages by ID with surrounding context:
+
+```typescript
+const { messages } = await memory.recall({
+  threadId: "thread-123",
+  include: [
+    { id: "msg-123" },
+    {
+      id: "msg-456",
+      withPreviousMessages: 3,
+      withNextMessages: 1,
+    },
+  ],
+});
+```
+
+Search by meaning (see [Semantic recall](https://mastra.ai/docs/memory/semantic-recall) for setup):
+
+```typescript
+const { messages } = await memory.recall({
+  threadId: "thread-123",
+  vectorSearchString: "project deadline discussion",
+  threadConfig: {
+    semanticRecall: true,
+  },
+});
+```
+
+### UI format
+
+Message queries return `MastraDBMessage[]` format. To display messages in a frontend, you may need to convert them to a format your UI library expects. For example, [`toAISdkV5Messages`](https://mastra.ai/reference/ai-sdk/to-ai-sdk-v5-messages) converts messages to AI SDK UI format.
+
+## Thread cloning
+
+Thread cloning creates a copy of an existing thread with its messages. This is useful for branching conversations, creating checkpoints before a potentially destructive operation, or testing variations of a conversation.
+
+```typescript
+const { thread, clonedMessages } = await memory.cloneThread({
+  sourceThreadId: "thread-123",
+  title: "Branched conversation",
+});
+```
+
+You can filter which messages get cloned (by count or date range), specify custom thread IDs, and use utility methods to inspect clone relationships. 
+
+See [`cloneThread()`](https://mastra.ai/reference/memory/cloneThread) and [clone utilities](https://mastra.ai/reference/memory/clone-utilities) for the full API.
+
+## Deleting messages
+
+To remove messages from a thread, use [`deleteMessages()`](https://mastra.ai/reference/memory/deleteMessages). You can delete by message ID or clear all messages from a thread.

package/dist/docs/memory/{03-working-memory.md → 04-working-memory.md}

@@ -2,7 +2,7 @@
 
 # Working Memory
 
-While [message history](https://mastra.ai/docs/v1/memory/message-history) and [semantic recall](./semantic-recall) help agents remember conversations, working memory allows them to maintain persistent information about users across interactions.
+While [message history](https://mastra.ai/docs/memory/message-history) and [semantic recall](./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.
 
@@ -383,6 +383,27 @@ await memory.updateWorkingMemory({
 });
 ```
 
+## 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)

package/dist/docs/memory/{04-semantic-recall.md → 05-semantic-recall.md}

@@ -37,9 +37,32 @@ const agent = new Agent({
 });
 ```
 
+## Using the recall() Method
+
+While `listMessages` retrieves messages by thread ID with basic pagination, [`recall()`](https://mastra.ai/reference/memory/recall) adds support for **semantic search**. When you need to find messages by meaning rather than just recency, use `recall()` with a `vectorSearchString`:
+
+```typescript
+const memory = await agent.getMemory();
+
+// Basic recall - similar to listMessages
+const { messages } = await memory!.recall({
+  threadId: "thread-123",
+  perPage: 50,
+});
+
+// Semantic recall - find messages by meaning
+const { messages: relevantMessages } = await memory!.recall({
+  threadId: "thread-123",
+  vectorSearchString: "What did we discuss about the project deadline?",
+  threadConfig: {
+    semanticRecall: true,
+  },
+});
+```
+
 ## Storage configuration
 
-Semantic recall relies on a [storage and vector db](https://mastra.ai/reference/v1/memory/memory-class) to store messages and their embeddings.
+Semantic recall relies on a [storage and vector db](https://mastra.ai/reference/memory/memory-class) to store messages and their embeddings.
 
 ```ts {8-16}
 import { Memory } from "@mastra/memory";
@@ -64,23 +87,23 @@ const agent = new Agent({
 
 Each vector store page below includes installation instructions, configuration parameters, and usage examples:
 
-- [Astra](https://mastra.ai/reference/v1/vectors/astra)
-- [Chroma](https://mastra.ai/reference/v1/vectors/chroma)
-- [Cloudflare Vectorize](https://mastra.ai/reference/v1/vectors/vectorize)
-- [Convex](https://mastra.ai/reference/v1/vectors/convex)
-- [Couchbase](https://mastra.ai/reference/v1/vectors/couchbase)
-- [DuckDB](https://mastra.ai/reference/v1/vectors/duckdb)
-- [Elasticsearch](https://mastra.ai/reference/v1/vectors/elasticsearch)
-- [LanceDB](https://mastra.ai/reference/v1/vectors/lance)
-- [libSQL](https://mastra.ai/reference/v1/vectors/libsql)
-- [MongoDB](https://mastra.ai/reference/v1/vectors/mongodb)
-- [OpenSearch](https://mastra.ai/reference/v1/vectors/opensearch)
-- [Pinecone](https://mastra.ai/reference/v1/vectors/pinecone)
-- [PostgreSQL](https://mastra.ai/reference/v1/vectors/pg)
-- [Qdrant](https://mastra.ai/reference/v1/vectors/qdrant)
-- [S3 Vectors](https://mastra.ai/reference/v1/vectors/s3vectors)
-- [Turbopuffer](https://mastra.ai/reference/v1/vectors/turbopuffer)
-- [Upstash](https://mastra.ai/reference/v1/vectors/upstash)
+- [Astra](https://mastra.ai/reference/vectors/astra)
+- [Chroma](https://mastra.ai/reference/vectors/chroma)
+- [Cloudflare Vectorize](https://mastra.ai/reference/vectors/vectorize)
+- [Convex](https://mastra.ai/reference/vectors/convex)
+- [Couchbase](https://mastra.ai/reference/vectors/couchbase)
+- [DuckDB](https://mastra.ai/reference/vectors/duckdb)
+- [Elasticsearch](https://mastra.ai/reference/vectors/elasticsearch)
+- [LanceDB](https://mastra.ai/reference/vectors/lance)
+- [libSQL](https://mastra.ai/reference/vectors/libsql)
+- [MongoDB](https://mastra.ai/reference/vectors/mongodb)
+- [OpenSearch](https://mastra.ai/reference/vectors/opensearch)
+- [Pinecone](https://mastra.ai/reference/vectors/pinecone)
+- [PostgreSQL](https://mastra.ai/reference/vectors/pg)
+- [Qdrant](https://mastra.ai/reference/vectors/qdrant)
+- [S3 Vectors](https://mastra.ai/reference/vectors/s3vectors)
+- [Turbopuffer](https://mastra.ai/reference/vectors/turbopuffer)
+- [Upstash](https://mastra.ai/reference/vectors/upstash)
 
 ## Recall configuration
 
@@ -106,7 +129,7 @@ const agent = new Agent({
 
 ## Embedder configuration
 
-Semantic recall relies on an [embedding model](https://mastra.ai/reference/v1/memory/memory-class) to convert messages into embeddings. Mastra supports embedding models through the model router using `provider/model` strings, or you can use any [embedding model](https://sdk.vercel.ai/docs/ai-sdk-core/embeddings) compatible with the AI SDK.
+Semantic recall relies on an [embedding model](https://mastra.ai/reference/memory/memory-class) to convert messages into embeddings. Mastra supports embedding models through the model router using `provider/model` strings, or you can use any [embedding model](https://sdk.vercel.ai/docs/ai-sdk-core/embeddings) compatible with the AI SDK.
 
 #### Using the Model Router (Recommended)
 
@@ -127,7 +150,7 @@ const agent = new Agent({
 Supported embedding models:
 
 - **OpenAI**: `text-embedding-3-small`, `text-embedding-3-large`, `text-embedding-ada-002`
-- **Google**: `gemini-embedding-001`, `text-embedding-004`
+- **Google**: `gemini-embedding-001`
 
 The model router automatically handles API key detection from environment variables (`OPENAI_API_KEY`, `GOOGLE_GENERATIVE_AI_API_KEY`).
 
@@ -152,7 +175,7 @@ const agent = new Agent({
 To use FastEmbed (a local embedding model), install `@mastra/fastembed`:
 
 ```bash npm2yarn
-npm install @mastra/fastembed@beta
+npm install @mastra/fastembed@latest
 ```
 
 Then configure it in your memory:
@@ -205,7 +228,7 @@ const agent = new Agent({
 });
 ```
 
-For detailed information about index configuration options and performance tuning, see the [PgVector configuration guide](https://mastra.ai/reference/v1/vectors/pg#index-configuration-guide).
+For detailed information about index configuration options and performance tuning, see the [PgVector configuration guide](https://mastra.ai/reference/vectors/pg#index-configuration-guide).
 
 ## Disabling
 

package/dist/docs/memory/{05-memory-processors.md → 06-memory-processors.md}

@@ -6,7 +6,7 @@ Memory processors transform and filter messages as they pass through an agent wi
 
 When memory is enabled on an agent, Mastra adds memory processors to the agent's processor pipeline. These processors retrieve message history, working memory, and semantically relevant messages, then persist new messages after the model responds.
 
-Memory processors are [processors](https://mastra.ai/docs/v1/agents/processors) that operate specifically on memory-related messages and state.
+Memory processors are [processors](https://mastra.ai/docs/agents/processors) that operate specifically on memory-related messages and state.
 
 ## Built-in Memory Processors
 
@@ -311,8 +311,8 @@ Both scenarios are safe - guardrails prevent inappropriate content from being pe
 
 ## Related documentation
 
-- [Processors](https://mastra.ai/docs/v1/agents/processors) - General processor concepts and custom processor creation
-- [Guardrails](https://mastra.ai/docs/v1/agents/guardrails) - Security and validation processors
-- [Memory Overview](https://mastra.ai/docs/v1/memory/overview) - Memory types and configuration
+- [Processors](https://mastra.ai/docs/agents/processors) - General processor concepts and custom processor creation
+- [Guardrails](https://mastra.ai/docs/agents/guardrails) - Security and validation processors
+- [Memory Overview](https://mastra.ai/docs/memory/overview) - Memory types and configuration
 
 When creating custom processors avoid mutating the input `messages` array or its objects directly.

package/dist/docs/memory/{06-reference.md → 07-reference.md}

@@ -221,10 +221,10 @@ async function manageClones() {
 
 ### Related
 
-- [cloneThread](https://mastra.ai/reference/v1/memory/cloneThread)
-- [Memory Class Reference](https://mastra.ai/reference/v1/memory/memory-class)
-- [getThreadById](https://mastra.ai/reference/v1/memory/getThreadById)
-- [listThreads](https://mastra.ai/reference/v1/memory/listThreads)
+- [cloneThread](https://mastra.ai/reference/memory/cloneThread)
+- [Memory Class Reference](https://mastra.ai/reference/memory/memory-class)
+- [getThreadById](https://mastra.ai/reference/memory/getThreadById)
+- [listThreads](https://mastra.ai/reference/memory/listThreads)
 
 ---
 
@@ -331,11 +331,11 @@ const results = await memory.recall({
 
 ### Related
 
-- [Memory Class Reference](https://mastra.ai/reference/v1/memory/memory-class)
-- [createThread](https://mastra.ai/reference/v1/memory/createThread)
-- [Clone Utility Methods](https://mastra.ai/reference/v1/memory/clone-utilities)
-- [recall](https://mastra.ai/reference/v1/memory/recall)
-- [Semantic Recall](https://mastra.ai/docs/v1/memory/semantic-recall)
+- [Memory Class Reference](https://mastra.ai/reference/memory/memory-class)
+- [createThread](https://mastra.ai/reference/memory/createThread)
+- [Clone Utility Methods](https://mastra.ai/reference/memory/clone-utilities)
+- [recall](https://mastra.ai/reference/memory/recall)
+- [Semantic Recall](https://mastra.ai/docs/memory/semantic-recall)
 
 ---
 
@@ -384,11 +384,11 @@ console.log(response.text);
 
 ### Related
 
-- [Memory Class Reference](https://mastra.ai/reference/v1/memory/memory-class)
-- [Getting Started with Memory](https://mastra.ai/docs/v1/memory/overview) (Covers threads concept)
-- [getThreadById](https://mastra.ai/reference/v1/memory/getThreadById)
-- [listThreads](https://mastra.ai/reference/v1/memory/listThreads)
-- [recall](https://mastra.ai/reference/v1/memory/recall)
+- [Memory Class Reference](https://mastra.ai/reference/memory/memory-class)
+- [Getting Started with Memory](https://mastra.ai/docs/memory/overview) (Covers threads concept)
+- [getThreadById](https://mastra.ai/reference/memory/getThreadById)
+- [listThreads](https://mastra.ai/reference/memory/listThreads)
+- [recall](https://mastra.ai/reference/memory/recall)
 
 ---
 
@@ -410,10 +410,10 @@ await memory?.getThreadById({ threadId: "thread-123" });
 
 ### Related
 
-- [Memory Class Reference](https://mastra.ai/reference/v1/memory/memory-class)
-- [Getting Started with Memory](https://mastra.ai/docs/v1/memory/overview) (Covers threads concept)
-- [createThread](https://mastra.ai/reference/v1/memory/createThread)
-- [listThreads](https://mastra.ai/reference/v1/memory/listThreads)
+- [Memory Class Reference](https://mastra.ai/reference/memory/memory-class)
+- [Getting Started with Memory](https://mastra.ai/docs/memory/overview) (Covers threads concept)
+- [createThread](https://mastra.ai/reference/memory/createThread)
+- [listThreads](https://mastra.ai/reference/memory/listThreads)
 
 ---
 
@@ -552,10 +552,10 @@ await memory.listThreads({
 
 ## Related
 
-- [Memory Class Reference](https://mastra.ai/reference/v1/memory/memory-class)
-- [Getting Started with Memory](https://mastra.ai/docs/v1/memory/overview) (Covers threads/resources concept)
-- [createThread](https://mastra.ai/reference/v1/memory/createThread)
-- [getThreadById](https://mastra.ai/reference/v1/memory/getThreadById)
+- [Memory Class Reference](https://mastra.ai/reference/memory/memory-class)
+- [Getting Started with Memory](https://mastra.ai/docs/memory/overview)
+- [createThread](https://mastra.ai/reference/memory/createThread)
+- [getThreadById](https://mastra.ai/reference/memory/getThreadById)
 
 ---
 
@@ -674,14 +674,14 @@ export const agent = new Agent({
 
 ### Related
 
-- [Getting Started with Memory](https://mastra.ai/docs/v1/memory/overview)
-- [Semantic Recall](https://mastra.ai/docs/v1/memory/semantic-recall)
-- [Working Memory](https://mastra.ai/docs/v1/memory/working-memory)
-- [Memory Processors](https://mastra.ai/docs/v1/memory/memory-processors)
-- [createThread](https://mastra.ai/reference/v1/memory/createThread)
-- [recall](https://mastra.ai/reference/v1/memory/recall)
-- [getThreadById](https://mastra.ai/reference/v1/memory/getThreadById)
-- [listThreads](https://mastra.ai/reference/v1/memory/listThreads)
-- [deleteMessages](https://mastra.ai/reference/v1/memory/deleteMessages)
-- [cloneThread](https://mastra.ai/reference/v1/memory/cloneThread)
-- [Clone Utility Methods](https://mastra.ai/reference/v1/memory/clone-utilities)
+- [Getting Started with Memory](https://mastra.ai/docs/memory/overview)
+- [Semantic Recall](https://mastra.ai/docs/memory/semantic-recall)
+- [Working Memory](https://mastra.ai/docs/memory/working-memory)
+- [Memory Processors](https://mastra.ai/docs/memory/memory-processors)
+- [createThread](https://mastra.ai/reference/memory/createThread)
+- [recall](https://mastra.ai/reference/memory/recall)
+- [getThreadById](https://mastra.ai/reference/memory/getThreadById)
+- [listThreads](https://mastra.ai/reference/memory/listThreads)
+- [deleteMessages](https://mastra.ai/reference/memory/deleteMessages)
+- [cloneThread](https://mastra.ai/reference/memory/cloneThread)
+- [Clone Utility Methods](https://mastra.ai/reference/memory/clone-utilities)

package/dist/docs/processors/01-reference.md

@@ -97,4 +97,4 @@ export const agent = new Agent({
 
 ## Related
 
-- [Guardrails](https://mastra.ai/docs/v1/agents/guardrails)
+- [Guardrails](https://mastra.ai/docs/agents/guardrails)