@mastra/libsql 1.0.0 → 1.1.0-alpha.0

package/dist/docs/memory/02-storage.md

@@ -2,7 +2,7 @@
 
 # Storage
 
-For Mastra to remember previous interactions, you must configure a storage adapter. Mastra is designed to work with your preferred database provider - choose from the [supported providers](#supported-providers) and pass it to your Mastra instance.
+For agents to remember previous interactions, Mastra needs a database. Use a storage adapter for one of the [supported databases](#supported-providers) and pass it to your Mastra instance. 
 
 ```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
@@ -15,35 +15,37 @@ export const mastra = new Mastra({
   }),
 });
 ```
-On first interaction, Mastra automatically creates the necessary tables following the [core schema](https://mastra.ai/reference/v1/storage/overview#core-schema). This includes tables for messages, threads, resources, workflows, traces, and evaluation datasets.
+This configures instance-level storage, which all agents share by default. You can also configure [agent-level storage](#agent-level-storage) for isolated data boundaries.
+
+Mastra automatically creates the necessary tables on first interaction. See the [core schema](https://mastra.ai/reference/storage/overview#core-schema) for details on what gets created, including tables for messages, threads, resources, workflows, traces, and evaluation datasets.
 
 ## Supported providers
 
 Each provider page includes installation instructions, configuration parameters, and usage examples:
 
-- [libSQL Storage](https://mastra.ai/reference/v1/storage/libsql)
-- [PostgreSQL Storage](https://mastra.ai/reference/v1/storage/postgresql)
-- [MongoDB Storage](https://mastra.ai/reference/v1/storage/mongodb)
-- [Upstash Storage](https://mastra.ai/reference/v1/storage/upstash)
-- [Cloudflare D1](https://mastra.ai/reference/v1/storage/cloudflare-d1)
-- [Cloudflare Durable Objects](https://mastra.ai/reference/v1/storage/cloudflare)
-- [Convex](https://mastra.ai/reference/v1/storage/convex)
-- [DynamoDB](https://mastra.ai/reference/v1/storage/dynamodb)
-- [LanceDB](https://mastra.ai/reference/v1/storage/lance)
-- [Microsoft SQL Server](https://mastra.ai/reference/v1/storage/mssql)
+- [libSQL](https://mastra.ai/reference/storage/libsql)
+- [PostgreSQL](https://mastra.ai/reference/storage/postgresql)
+- [MongoDB](https://mastra.ai/reference/storage/mongodb)
+- [Upstash](https://mastra.ai/reference/storage/upstash)
+- [Cloudflare D1](https://mastra.ai/reference/storage/cloudflare-d1)
+- [Cloudflare Durable Objects](https://mastra.ai/reference/storage/cloudflare)
+- [Convex](https://mastra.ai/reference/storage/convex)
+- [DynamoDB](https://mastra.ai/reference/storage/dynamodb)
+- [LanceDB](https://mastra.ai/reference/storage/lance)
+- [Microsoft SQL Server](https://mastra.ai/reference/storage/mssql)
 
 > **Note:**
-libSQL is the easiest way to get started because it doesn’t require running a separate database server
+libSQL is the easiest way to get started because it doesn’t require running a separate database server.
 
 ## Configuration scope
 
-You can configure storage at two different scopes:
+Storage can be configured at the instance level (shared by all agents) or at the agent level (isolated to a specific agent).
 
 ### Instance-level storage
 
 Add storage to your Mastra instance so all agents, workflows, observability traces and scores share the same memory provider:
 
-```typescript
+```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
 import { PostgresStore } from "@mastra/pg";
 
@@ -54,7 +56,7 @@ export const mastra = new Mastra({
   }),
 });
 
-// All agents automatically use this storage
+// Both agents inherit storage from the Mastra instance above
 const agent1 = new Agent({ id: "agent-1", memory: new Memory() });
 const agent2 = new Agent({ id: "agent-2", memory: new Memory() });
 ```
@@ -63,7 +65,7 @@ This is useful when all primitives share the same storage backend and have simil
 
 #### Composite storage
 
-Add storage to your Mastra instance using `MastraCompositeStore` and configure individual storage domains to use different storage providers.
+[Composite storage](https://mastra.ai/reference/storage/composite) is an alternative way to configure instance-level storage. Use `MastraCompositeStore` to set the `memory` domain (and any other [domains](https://mastra.ai/reference/storage/composite#storage-domains) you need) to different storage providers.
 
 ```typescript title="src/mastra/index.ts"
 import { Mastra } from "@mastra/core";
@@ -76,6 +78,7 @@ export const mastra = new Mastra({
   storage: new MastraCompositeStore({
     id: "composite",
     domains: {
+      // highlight-next-line
       memory: new MemoryLibSQL({ url: "file:./memory.db" }),
       workflows: new WorkflowsPG({ connectionString: process.env.DATABASE_URL }),
       observability: new ObservabilityStorageClickhouse({
@@ -90,14 +93,11 @@ export const mastra = new Mastra({
 
 This is useful when different types of data have different performance or operational requirements, such as low-latency storage for memory, durable storage for workflows, and high-throughput storage for observability.
 
-> **Note:**
-See [Storage Domains](https://mastra.ai/reference/v1/storage/composite#storage-domains) for more information.
-
 ### Agent-level storage
 
-Agent-level storage overrides storage configured at the instance-level. Add storage to a specific agent when you need data boundaries or compliance requirements:
+Agent-level storage overrides storage configured at the instance level. Add storage to a specific agent when you need data boundaries or compliance requirements:
 
-```typescript title="src/mastra/agents/memory-agent.ts"
+```typescript title="src/mastra/agents/your-agent.ts"
 import { Agent } from "@mastra/core/agent";
 import { Memory } from "@mastra/memory";
 import { PostgresStore } from "@mastra/pg";
@@ -113,56 +113,55 @@ export const agent = new Agent({
 });
 ```
 
-This is useful when different agents need to store data in separate databases for security, compliance, or organizational reasons.
-
-> **Mastra Cloud Store limitation**
-Agent-level storage is not supported when using [Mastra Cloud Store](https://mastra.ai/docs/v1/mastra-cloud/deployment#using-mastra-cloud-store). If you use Mastra Cloud Store, configure storage on the Mastra instance instead. This limitation does not apply if you bring your own database.
+> **Note:**
+[Mastra Cloud Store](https://mastra.ai/docs/mastra-cloud/deployment#using-mastra-cloud-store) doesn't support agent-level storage.
 
 ## Threads and resources
 
-Mastra organizes memory into threads using two identifiers:
+Mastra organizes conversations using two identifiers: 
+
+- **Thread** - a conversation session containing a sequence of messages.
+- **Resource** - the entity that owns the thread, such as a user, organization, project, or any other domain entity in your application.
 
-- **Thread**: A conversation session containing a sequence of messages (e.g., `convo_123`)
-- **Resource**: An identifier for the entity the thread belongs to, typically a user (e.g., `user_123`)
+Both identifiers are required for agents to store information:
 
-Both identifiers are required for agents to store and recall information:
+  **generate:**
 
 ```typescript
-const stream = await agent.stream("message for agent", {
+const response = await agent.generate("hello", {
   memory: {
-    thread: "convo_123",
+    thread: "conversation-abc-123",
     resource: "user_123",
   },
 });
 ```
 
-> **Note:**
-[Studio](https://mastra.ai/docs/v1/getting-started/studio) automatically generates a thread and resource ID for you. Remember to  to pass these explicitly when calling `stream` or `generate` yourself.
-
-### Thread and resource relationship
+  
+  **stream:**
 
-Each thread has an owner (its `resourceId`) that is set when the thread is created and cannot be changed. When you query a thread, you must use the correct owner's resource ID. Attempting to query a thread with a different resource ID will result in an error:
-
-```text
-Thread with id <thread_id> is for resource with id <resource_a>
-but resource <resource_b> was queried
+```typescript
+const stream = await agent.stream("hello", {
+  memory: {
+    thread: "conversation-abc-123",
+    resource: "user_123",
+  },
+});
 ```
 
-Note that while each thread has one owner, messages within that thread can have different `resourceId` values. This is used for message attribution and filtering (e.g., distinguishing between different agents in a multi-agent system, or filtering messages for analytics).
-
-**Security:** Memory is a storage layer, not an authorization layer. Your application must implement access control before calling memory APIs. The `resourceId` parameter controls both validation and filtering - provide it to validate ownership and filter messages, or omit it for server-side access without validation.
+  
 
-To avoid accidentally reusing thread IDs across different owners, use UUIDs: `crypto.randomUUID()`
+> **Note:**
+[Studio](https://mastra.ai/docs/getting-started/studio) automatically generates a thread and resource ID for you. When calling `stream()` or `generate()` yourself, remember to provide these identifiers explicitly.
 
 ### Thread title generation
 
-Mastra can automatically generate descriptive thread titles based on the user's first message.
+Mastra can automatically generate descriptive thread titles based on the user's first message when `generateTitle` is enabled.
 
 Use this option when implementing a ChatGPT-style chat interface to render a title alongside each thread in the conversation list (for example, in a sidebar) derived from the thread’s initial user message.
 
-```typescript
-export const testAgent = new Agent({
-  id: "test-agent",
+```typescript title="src/mastra/agents/my-agent.ts"
+export const agent = new Agent({
+  id: "agent",
   memory: new Memory({
     options: {
       generateTitle: true,
@@ -173,16 +172,16 @@ export const testAgent = new Agent({
 
 Title generation runs asynchronously after the agent responds and does not affect response time.
 
-To optimize cost or behavior, provide a smaller `model` and custom `instructions`:
+To optimize cost or behavior, provide a smaller [`model`](/models) and custom `instructions`:
 
-```typescript
-export const testAgent = new Agent({
-  id: "test-agent",
+```typescript title="src/mastra/agents/my-agent.ts"
+export const agent = new Agent({
+  id: "agent",
   memory: new Memory({
     options: {
       generateTitle: {
         model: "openai/gpt-4o-mini",
-        instructions: "Generate a concise title based on the user's first message",
+        instructions: "Generate a 1 word title",
       },
     },
   }),
@@ -191,43 +190,72 @@ export const testAgent = new Agent({
 
 ## Semantic recall
 
-Semantic recall uses vector embeddings to retrieve relevant past messages based on meaning rather than recency. This requires a vector database instance, which can be configured at the instance or agent level.
+Semantic recall has different storage requirements - it needs a vector database in addition to the standard storage adapter. See [Semantic recall](https://mastra.ai/docs/memory/semantic-recall) for setup and supported vector providers.
 
-The vector database doesn't have to be the same as your storage provider. For example, you might use PostgreSQL for storage and Pinecone for vectors:
+## Handling large attachments
 
-```typescript
-import { Mastra } from "@mastra/core";
-import { Agent } from "@mastra/core/agent";
-import { Memory } from "@mastra/memory";
-import { PostgresStore } from "@mastra/pg";
-import { PineconeVector } from "@mastra/pinecone";
+Some storage providers enforce record size limits that base64-encoded file attachments (such as images) can exceed:
 
-// Instance-level vector configuration
-export const mastra = new Mastra({
-  storage: new PostgresStore({
-    id: 'mastra-storage',
-    connectionString: process.env.DATABASE_URL,
-  }),
-});
+| Provider | Record size limit |
+| -------- | ----------------- |
+| [DynamoDB](https://mastra.ai/reference/storage/dynamodb) | 400 KB |
+| [Convex](https://mastra.ai/reference/storage/convex) | 1 MiB |
+| [Cloudflare D1](https://mastra.ai/reference/storage/cloudflare-d1) | 1 MiB |
 
-// Agent-level vector configuration
-export const agent = new Agent({
-  id: "agent",
-  memory: new Memory({
-    vector: new PineconeVector({
-      id: 'agent-vector',
-      apiKey: process.env.PINECONE_API_KEY,
-    }),
-    options: {
-      semanticRecall: {
-        topK: 5,
-        messageRange: 2,
-      },
-    },
-  }),
-});
+PostgreSQL, MongoDB, and libSQL have higher limits and are generally unaffected.
+
+To avoid this, use an input processor to upload attachments to external storage (S3, R2, GCS, [Convex file storage](https://docs.convex.dev/file-storage), etc.) and replace them with URL references before persistence.
+
+```typescript title="src/mastra/processors/attachment-uploader.ts"
+import type { Processor } from "@mastra/core/processors";
+import type { MastraDBMessage } from "@mastra/core/memory";
+
+export class AttachmentUploader implements Processor {
+  id = "attachment-uploader";
+
+  async processInput({ messages }: { messages: MastraDBMessage[] }) {
+    return Promise.all(messages.map((msg) => this.processMessage(msg)));
+  }
+
+  async processMessage(msg: MastraDBMessage) {
+    const attachments = msg.content.experimental_attachments;
+    if (!attachments?.length) return msg;
+
+    const uploaded = await Promise.all(
+      attachments.map(async (att) => {
+        // Skip if already a URL
+        if (!att.url?.startsWith("data:")) return att;
+
+        // Upload base64 data and replace with URL
+        const url = await this.upload(att.url, att.contentType);
+        return { ...att, url };
+      })
+    );
+
+    return { ...msg, content: { ...msg.content, experimental_attachments: uploaded } };
+  }
+
+  async upload(dataUri: string, contentType?: string): Promise<string> {
+    const base64 = dataUri.split(",")[1];
+    const buffer = Buffer.from(base64, "base64");
+
+    // Replace with your storage provider (S3, R2, GCS, Convex, etc.)
+    // return await s3.upload(buffer, contentType);
+    throw new Error("Implement upload() with your storage provider");
+  }
+}
 ```
 
-We support all popular vector providers including [Pinecone](https://mastra.ai/reference/v1/vectors/pinecone), [Chroma](https://mastra.ai/reference/v1/vectors/chroma), [Qdrant](https://mastra.ai/reference/v1/vectors/qdrant), and many more.
+Use the processor with your agent:
 
-For more information on configuring semantic recall, see the [Semantic Recall](./semantic-recall) documentation.
+```typescript
+import { Agent } from "@mastra/core/agent";
+import { Memory } from "@mastra/memory";
+import { AttachmentUploader } from "./processors/attachment-uploader";
+
+const agent = new Agent({
+  id: "my-agent",
+  memory: new Memory({ storage: yourStorage }),
+  inputProcessors: [new AttachmentUploader()],
+});
+```

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)