@mastra/memory 1.0.0-beta.9 → 1.0.0

package/dist/docs/README.md

@@ -0,0 +1,36 @@
+# @mastra/memory Documentation
+
+> Embedded documentation for coding agents
+
+## Quick Start
+
+```bash
+# Read the skill overview
+cat docs/SKILL.md
+
+# Get the source map
+cat docs/SOURCE_MAP.json
+
+# Read topic documentation
+cat docs/<topic>/01-overview.md
+```
+
+## Structure
+
+```
+docs/
+├── SKILL.md           # Entry point
+├── README.md          # This file
+├── SOURCE_MAP.json    # Export index
+├── agents/ (4 files)
+├── core/ (2 files)
+├── memory/ (11 files)
+├── processors/ (1 files)
+├── storage/ (5 files)
+├── vectors/ (4 files)
+```
+
+## Version
+
+Package: @mastra/memory
+Version: 1.0.0

package/dist/docs/SKILL.md

@@ -0,0 +1,42 @@
+---
+name: mastra-memory-docs
+description: Documentation for @mastra/memory. Includes links to type definitions and readable implementation code in dist/.
+---
+
+# @mastra/memory Documentation
+
+> **Version**: 1.0.0
+> **Package**: @mastra/memory
+
+## Quick Navigation
+
+Use SOURCE_MAP.json to find any export:
+
+```bash
+cat docs/SOURCE_MAP.json
+```
+
+Each export maps to:
+- **types**: `.d.ts` file with JSDoc and API signatures
+- **implementation**: `.js` chunk file with readable source
+- **docs**: Conceptual documentation in `docs/`
+
+## Top Exports
+
+  - extractWorkingMemoryContent: dist/index.d.ts
+  - extractWorkingMemoryTags: dist/index.d.ts
+  - removeWorkingMemoryTags: dist/index.d.ts
+  - MessageHistory: dist/index.d.ts
+  - SemanticRecall: dist/index.d.ts
+  - WorkingMemory: dist/index.d.ts
+
+See SOURCE_MAP.json for the complete list.
+
+## Available Topics
+
+- [Agents](agents/) - 4 file(s)
+- [Core](core/) - 2 file(s)
+- [Memory](memory/) - 11 file(s)
+- [Processors](processors/) - 1 file(s)
+- [Storage](storage/) - 5 file(s)
+- [Vectors](vectors/) - 4 file(s)

package/dist/docs/SOURCE_MAP.json

@@ -0,0 +1,31 @@
+{
+  "version": "1.0.0",
+  "package": "@mastra/memory",
+  "exports": {
+    "extractWorkingMemoryContent": {
+      "types": "dist/index.d.ts",
+      "implementation": "dist/memory"
+    },
+    "extractWorkingMemoryTags": {
+      "types": "dist/index.d.ts",
+      "implementation": "dist/memory"
+    },
+    "removeWorkingMemoryTags": {
+      "types": "dist/index.d.ts",
+      "implementation": "dist/memory"
+    },
+    "MessageHistory": {
+      "types": "dist/index.d.ts",
+      "implementation": "dist/processors"
+    },
+    "SemanticRecall": {
+      "types": "dist/index.d.ts",
+      "implementation": "dist/processors"
+    },
+    "WorkingMemory": {
+      "types": "dist/index.d.ts",
+      "implementation": "dist/processors"
+    }
+  },
+  "modules": {}
+}

package/dist/docs/agents/01-agent-memory.md

@@ -0,0 +1,166 @@
+> Learn how to add memory to agents to store message history and maintain context across interactions.
+
+# Agent memory
+
+Agents use memory to maintain context across interactions. LLMs are stateless and don't retain information between calls, so agents need memory to track message history and recall relevant information.
+
+Mastra agents can be configured to store message history, with optional [working memory](../memory/working-memory) to maintain recent context or [semantic recall](../memory/semantic-recall) to retrieve past messages based on meaning.
+
+## When to use memory
+
+Use memory when your agent needs to maintain multi-turn conversations that reference prior exchanges, recall user preferences or facts from earlier in a session, or build context over time within a conversation thread. Skip memory for single-turn requests where each interaction is independent.
+
+## Setting up memory
+
+To enable memory in Mastra, install the `@mastra/memory` package along with a storage provider.
+
+```bash npm2yarn
+npm install @mastra/memory@beta @mastra/libsql@beta
+```
+
+## Storage providers
+
+Memory requires a storage provider to persist message history, including user messages and agent responses. For more details on available providers and how storage works in Mastra, see the [Storage](https://mastra.ai/docs/v1/memory/storage) documentation.
+
+## Configuring memory
+
+  ### Step
+
+Enable memory by creating a `Memory` instance and passing it to the agent’s `memory` option.
+
+```typescript {7-11} title="src/mastra/agents/memory-agent.ts"
+import { Agent } from "@mastra/core/agent";
+import { Memory } from "@mastra/memory";
+
+export const memoryAgent = new Agent({
+  id: 'memory-agent',
+  name: 'Memory Agent',
+  memory: new Memory({
+    options: {
+      lastMessages: 20,
+    },
+  }),
+});
+```
+
+> **Note:**
+
+Visit [Memory Class](https://mastra.ai/reference/v1/memory/memory-class) for a full list of configuration options.
+
+  
+
+  ### Step
+
+Add a storage provider to your main Mastra instance to enable memory across all configured agents.
+
+```typescript {5-8} 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: ":memory:",
+  }),
+});
+```
+
+> **Note:**
+
+Visit [libSQL Storage](https://mastra.ai/reference/v1/storage/libsql) for a full list of configuration options.
+
+  
+
+Alternatively, add storage directly to an agent’s memory to keep data separate or use different providers per agent.
+
+```typescript {9-12} title="src/mastra/agents/memory-agent.ts"
+import { Agent } from "@mastra/core/agent";
+import { Memory } from "@mastra/memory";
+import { LibSQLStore } from "@mastra/libsql";
+
+export const memoryAgent = new Agent({
+  id: 'memory-agent',
+  name: 'Memory Agent',
+  memory: new Memory({
+    storage: new LibSQLStore({
+      id: 'mastra-storage',
+      url: ":memory:",
+    }),
+  }),
+});
+```
+
+> **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.
+
+## Message history
+
+Include a `memory` object with both `resource` and `thread` to track message history during agent calls.
+
+- `resource`: A stable identifier for the user or entity.
+- `thread`: An ID that isolates a specific conversation or session.
+
+These fields tell the agent where to store and retrieve context, enabling persistent, thread-aware memory across a conversation.
+
+```typescript {4-7}
+const response = await memoryAgent.generate(
+  "Remember my favorite color is blue.",
+  {
+    memory: {
+      resource: "user-123",
+      thread: "conversation-123",
+    },
+  },
+);
+```
+
+To recall information stored in memory, call the agent with the same `resource` and `thread` values used in the original conversation.
+
+```typescript {2-5}
+const response = await memoryAgent.generate("What's my favorite color?", {
+  memory: {
+    resource: "user-123",
+    thread: "conversation-123",
+  },
+});
+```
+
+> **Note:**
+Each thread has an owner (`resourceId`) that cannot be changed after creation. Avoid reusing the same thread ID for threads with different owners, as this will cause errors when querying.
+
+To learn more about memory see the [Memory](../memory/overview) documentation.
+
+## Using `RequestContext`
+
+Use [RequestContext](https://mastra.ai/docs/v1/server/request-context) to access request-specific values. This lets you conditionally select different memory or storage configurations based on the context of the request.
+
+```typescript title="src/mastra/agents/memory-agent.ts"
+export type UserTier = {
+  "user-tier": "enterprise" | "pro";
+};
+
+const premiumMemory = new Memory();
+
+const standardMemory = new Memory();
+
+export const memoryAgent = new Agent({
+  id: 'memory-agent',
+  name: 'Memory Agent',
+  memory: ({ requestContext }) => {
+    const userTier = requestContext.get("user-tier") as UserTier["user-tier"];
+
+    return userTier === "enterprise" ? premiumMemory : standardMemory;
+  },
+});
+```
+
+> **Note:**
+
+Visit [Request Context](https://mastra.ai/docs/v1/server/request-context) for more information.
+
+## Related
+
+- [Working Memory](../memory/working-memory)
+- [Semantic Recall](../memory/semantic-recall)
+- [Storage](../memory/storage)
+- [Request Context](https://mastra.ai/docs/v1/server/request-context)

package/dist/docs/agents/02-networks.md

@@ -0,0 +1,292 @@
+> Learn how to coordinate multiple agents, workflows, and tools using agent networks for complex, non-deterministic task execution.
+
+# Agent Networks
+
+Agent networks in Mastra coordinate multiple agents, workflows, and tools to handle tasks that aren't clearly defined upfront but can be inferred from the user's message or context. A top-level **routing agent** (a Mastra agent with other agents, workflows, and tools configured) uses an LLM to interpret the request and decide which primitives (sub-agents, workflows, or tools) to call, in what order, and with what data.
+
+## When to use networks
+
+Use networks for complex tasks that require coordination across multiple primitives. Unlike workflows, which follow a predefined sequence, networks rely on LLM reasoning to interpret the request and decide what to run.
+
+## Core principles
+
+Mastra agent networks operate using these principles:
+
+- Memory is required when using `.network()` and is used to store task history and determine when a task is complete.
+- Primitives are selected based on their descriptions. Clear, specific descriptions improve routing. For workflows and tools, the input schema helps determine the right inputs at runtime.
+- If multiple primitives have overlapping functionality, the agent favors the more specific one, using a combination of schema and descriptions to decide which to run.
+
+## Creating an agent network
+
+An agent network is built around a top-level routing agent that delegates tasks to agents, workflows, and tools defined in its configuration. Memory is configured on the routing agent using the `memory` option, and `instructions` define the agent's routing behavior.
+
+```typescript {22-23,26,29} title="src/mastra/agents/routing-agent.ts"
+import { Agent } from "@mastra/core/agent";
+import { Memory } from "@mastra/memory";
+import { LibSQLStore } from "@mastra/libsql";
+
+import { researchAgent } from "./research-agent";
+import { writingAgent } from "./writing-agent";
+
+import { cityWorkflow } from "../workflows/city-workflow";
+import { weatherTool } from "../tools/weather-tool";
+
+export const routingAgent = new Agent({
+  id: "routing-agent",
+  name: "Routing Agent",
+  instructions: `
+      You are a network of writers and researchers.
+      The user will ask you to research a topic.
+      Always respond with a complete report—no bullet points.
+      Write in full paragraphs, like a blog post.
+      Do not answer with incomplete or uncertain information.`,
+  model: "openai/gpt-5.1",
+  agents: {
+    researchAgent,
+    writingAgent,
+  },
+  workflows: {
+    cityWorkflow,
+  },
+  tools: {
+    weatherTool,
+  },
+  memory: new Memory({
+    storage: new LibSQLStore({
+      id: 'mastra-storage',
+      url: "file:../mastra.db",
+    }),
+  }),
+});
+```
+
+### Writing descriptions for network primitives
+
+When configuring a Mastra agent network, each primitive (agent, workflow, or tool) needs a clear description to help the routing agent decide which to use. The routing agent uses each primitive's description and schema to determine what it does and how to use it. Clear descriptions and well-defined input and output schemas improve routing accuracy.
+
+#### Agent descriptions
+
+Each agent in a network should include a clear `description` that explains what the agent does.
+
+```typescript title="src/mastra/agents/research-agent.ts"
+export const researchAgent = new Agent({
+  id: "research-agent",
+  name: "Research Agent",
+  description: `This agent gathers concise research insights in bullet-point form.
+    It's designed to extract key facts without generating full
+    responses or narrative content.`,
+});
+```
+
+```typescript title="src/mastra/agents/writing-agent.ts"
+export const writingAgent = new Agent({
+  id: "writing-agent",
+  name: "Writing Agent",
+  description: `This agent turns researched material into well-structured
+    written content. It produces full-paragraph reports with no bullet points,
+    suitable for use in articles, summaries, or blog posts.`,
+});
+```
+
+#### Workflow descriptions
+
+Workflows in a network should include a `description` to explain their purpose, along with `inputSchema` and `outputSchema` to describe the expected data.
+
+```typescript title="src/mastra/workflows/city-workflow.ts"
+export const cityWorkflow = createWorkflow({
+  id: "city-workflow",
+  description: `This workflow handles city-specific research tasks.
+    It first gathers factual information about the city, then synthesizes
+    that research into a full written report. Use it when the user input
+    includes a city to be researched.`,
+  inputSchema: z.object({
+    city: z.string(),
+  }),
+  outputSchema: z.object({
+    text: z.string(),
+  }),
+});
+```
+
+#### Tool descriptions
+
+Tools in a network should include a `description` to explain their purpose, along with `inputSchema` and `outputSchema` to describe the expected data.
+
+```typescript title="src/mastra/tools/weather-tool.ts"
+export const weatherTool = createTool({
+  id: "weather-tool",
+  description: ` Retrieves current weather information using the wttr.in API.
+    Accepts a city or location name as input and returns a short weather summary.
+    Use this tool whenever up-to-date weather data is requested.
+  `,
+  inputSchema: z.object({
+    location: z.string(),
+  }),
+  outputSchema: z.object({
+    weather: z.string(),
+  }),
+});
+```
+
+## Calling agent networks
+
+Call a Mastra agent network using `.network()` with a user message. The method returns a stream of events that you can iterate over to track execution progress and retrieve the final result.
+
+### Agent example
+
+In this example, the network interprets the message and would route the request to both the `researchAgent` and `writingAgent` to generate a complete response.
+
+```typescript
+const result = await routingAgent.network(
+  "Tell me three cool ways to use Mastra",
+);
+
+for await (const chunk of result) {
+  console.log(chunk.type);
+  if (chunk.type === "network-execution-event-step-finish") {
+    console.log(chunk.payload.result);
+  }
+}
+```
+
+#### Agent output
+
+The following `chunk.type` events are emitted during this request:
+
+```text
+routing-agent-start
+routing-agent-end
+agent-execution-start
+agent-execution-event-start
+agent-execution-event-step-start
+agent-execution-event-text-start
+agent-execution-event-text-delta
+agent-execution-event-text-end
+agent-execution-event-step-finish
+agent-execution-event-finish
+agent-execution-end
+network-execution-event-step-finish
+```
+
+## Workflow example
+
+In this example, the routing agent recognizes the city name in the message and runs the `cityWorkflow`. The workflow defines steps that call the `researchAgent` to gather facts, then the `writingAgent` to generate the final text.
+
+```typescript
+const result = await routingAgent.network(
+  "Tell me some historical facts about London",
+);
+
+for await (const chunk of result) {
+  console.log(chunk.type);
+  if (chunk.type === "network-execution-event-step-finish") {
+    console.log(chunk.payload.result);
+  }
+}
+```
+
+#### Workflow output
+
+The following `chunk.type` events are emitted during this request:
+
+```text
+routing-agent-end
+workflow-execution-start
+workflow-execution-event-workflow-start
+workflow-execution-event-workflow-step-start
+workflow-execution-event-workflow-step-result
+workflow-execution-event-workflow-finish
+workflow-execution-end
+routing-agent-start
+network-execution-event-step-finish
+```
+
+### Tool example
+
+In this example, the routing agent skips the `researchAgent`, `writingAgent`, and `cityWorkflow`, and calls the `weatherTool` directly to complete the task.
+
+```typescript
+const result = await routingAgent.network("What's the weather in London?");
+
+for await (const chunk of result) {
+  console.log(chunk.type);
+  if (chunk.type === "network-execution-event-step-finish") {
+    console.log(chunk.payload.result);
+  }
+}
+```
+
+#### Tool output
+
+The following `chunk.type` events are emitted during this request:
+
+```text
+routing-agent-start
+routing-agent-end
+tool-execution-start
+tool-execution-end
+network-execution-event-step-finish
+```
+
+## Structured output
+
+When you need typed, validated results from a network, use the `structuredOutput` option. After the network completes its task, it generates a structured response matching your schema.
+
+```typescript
+import { z } from "zod";
+
+const resultSchema = z.object({
+  summary: z.string().describe("A brief summary of the findings"),
+  recommendations: z.array(z.string()).describe("List of recommendations"),
+  confidence: z.number().min(0).max(1).describe("Confidence score"),
+});
+
+const stream = await routingAgent.network("Research AI trends", {
+  structuredOutput: {
+    schema: resultSchema,
+  },
+});
+
+// Consume the stream
+for await (const chunk of stream) {
+  if (chunk.type === "network-object") {
+    // Partial object during generation
+    console.log("Partial:", chunk.payload.object);
+  }
+  if (chunk.type === "network-object-result") {
+    // Final structured object
+    console.log("Final:", chunk.payload.object);
+  }
+}
+
+// Get the typed result
+const result = await stream.object;
+console.log(result?.summary);
+console.log(result?.recommendations);
+console.log(result?.confidence);
+```
+
+### Streaming partial objects
+
+For real-time updates during structured output generation, use `objectStream`:
+
+```typescript
+const stream = await routingAgent.network("Analyze market data", {
+  structuredOutput: { schema: resultSchema },
+});
+
+// Stream partial objects as they're generated
+for await (const partial of stream.objectStream) {
+  console.log("Building result:", partial);
+}
+
+// Get the final typed result
+const final = await stream.object;
+```
+
+## Related
+
+- [Agent Memory](./agent-memory)
+- [Workflows Overview](../workflows/overview)
+- [Request Context](https://mastra.ai/docs/v1/server/request-context)
+- [Supervisor example](https://github.com/mastra-ai/mastra/tree/main/examples/supervisor-agent)