@mastra/memory 0.1.7 → 0.2.0-alpha.0

package/.turbo/turbo-build.log

@@ -1,27 +1,27 @@
 
-> @mastra/memory@0.1.7-alpha.0 build /home/runner/work/mastra/mastra/packages/memory
+> @mastra/memory@0.2.0-alpha.0 build /home/runner/work/mastra/mastra/packages/memory
 > pnpm run check && tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake
 
 
-> @mastra/memory@0.1.7-alpha.0 check /home/runner/work/mastra/mastra/packages/memory
+> @mastra/memory@0.2.0-alpha.0 check /home/runner/work/mastra/mastra/packages/memory
 > tsc --noEmit
 
 CLI Building entry: src/index.ts
 CLI Using tsconfig: tsconfig.json
 CLI tsup v8.3.6
 TSC Build start
-TSC ⚡️ Build success in 6919ms
+TSC ⚡️ Build success in 7804ms
 DTS Build start
 CLI Target: es2022
 Analysis will use the bundled TypeScript version 5.7.3
 Writing package typings: /home/runner/work/mastra/mastra/packages/memory/dist/_tsup-dts-rollup.d.ts
 Analysis will use the bundled TypeScript version 5.7.3
 Writing package typings: /home/runner/work/mastra/mastra/packages/memory/dist/_tsup-dts-rollup.d.cts
-DTS ⚡️ Build success in 8895ms
+DTS ⚡️ Build success in 10512ms
 CLI Cleaning output folder
 ESM Build start
 CJS Build start
-CJS dist/index.cjs 9.35 KB
-CJS ⚡️ Build success in 668ms
-ESM dist/index.js 9.33 KB
-ESM ⚡️ Build success in 682ms
+ESM dist/index.js 12.07 KB
+ESM ⚡️ Build success in 709ms
+CJS dist/index.cjs 12.10 KB
+CJS ⚡️ Build success in 711ms

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @mastra/memory
 
+## 0.2.0-alpha.0
+
+### Minor Changes
+
+- 59df7b6: Added a new option to use tool-calls for saving working memory: new Memory({ workingMemory: { enabled: true, use: "tool-call" } }). This is to support response methods like toDataStream where masking working memory chunks would be more resource intensive and complex.
+  To support this `memory` is now passed into tool execute args.
+
+### Patch Changes
+
+- Updated dependencies [59df7b6]
+- Updated dependencies [29f3a82]
+- Updated dependencies [59df7b6]
+- Updated dependencies [c139344]
+  - @mastra/core@0.5.0-alpha.0
+
 ## 0.1.7
 
 ### Patch Changes

package/dist/_tsup-dts-rollup.d.cts

@@ -1,4 +1,5 @@
 import type { CoreMessage } from '@mastra/core';
+import type { CoreTool } from '@mastra/core';
 import { MastraMemory } from '@mastra/core/memory';
 import type { MemoryConfig } from '@mastra/core/memory';
 import type { Message } from 'ai';
@@ -57,6 +58,10 @@ export declare class Memory extends MastraMemory {
     }): Promise<string | null>;
     defaultWorkingMemoryTemplate: string;
     private getWorkingMemoryWithInstruction;
+    private getWorkingMemoryToolInstruction;
+    getTools(config?: MemoryConfig): Record<string, CoreTool>;
 }
 
+export declare const updateWorkingMemoryTool: CoreTool;
+
 export { }

package/dist/_tsup-dts-rollup.d.ts

@@ -1,4 +1,5 @@
 import type { CoreMessage } from '@mastra/core';
+import type { CoreTool } from '@mastra/core';
 import { MastraMemory } from '@mastra/core/memory';
 import type { MemoryConfig } from '@mastra/core/memory';
 import type { Message } from 'ai';
@@ -57,6 +58,10 @@ export declare class Memory extends MastraMemory {
     }): Promise<string | null>;
     defaultWorkingMemoryTemplate: string;
     private getWorkingMemoryWithInstruction;
+    private getWorkingMemoryToolInstruction;
+    getTools(config?: MemoryConfig): Record<string, CoreTool>;
 }
 
+export declare const updateWorkingMemoryTool: CoreTool;
+
 export { }

package/dist/index.cjs

@@ -2,9 +2,36 @@
 
 var core = require('@mastra/core');
 var memory = require('@mastra/core/memory');
+var zod = require('zod');
 var ai = require('ai');
 
 // src/index.ts
+var updateWorkingMemoryTool = {
+  description: "Update the working memory with new information",
+  parameters: zod.z.object({
+    memory: zod.z.string().describe("The XML-formatted working memory content to store")
+  }),
+  execute: async (params, _options) => {
+    const { context, threadId, memory } = params;
+    if (!threadId || !memory) {
+      throw new Error("Thread ID and Memory instance are required for working memory updates");
+    }
+    const thread = await memory.getThreadById({ threadId });
+    if (!thread) {
+      throw new Error(`Thread ${threadId} not found`);
+    }
+    await memory.saveThread({
+      thread: {
+        ...thread,
+        metadata: {
+          ...thread.metadata,
+          workingMemory: context.memory
+        }
+      }
+    });
+    return { success: true };
+  }
+};
 var Memory = class extends memory.MastraMemory {
   constructor(config = {}) {
     super({ name: "Memory", ...config });
@@ -223,6 +250,9 @@ var Memory = class extends memory.MastraMemory {
     if (!workingMemory) {
       return null;
     }
+    if (config.workingMemory.use === "tool-call") {
+      return this.getWorkingMemoryToolInstruction(workingMemory);
+    }
     return this.getWorkingMemoryWithInstruction(workingMemory);
   }
   defaultWorkingMemoryTemplate = `
@@ -261,6 +291,36 @@ Notes:
 - REMEMBER: the way you update your working memory is by outputting the entire "<working_memory>text</working_memory>" block in your response. The system will pick this up and store it for you. The user will not see it.
 - IMPORTANT: You MUST output the <working_memory> block in every response to a prompt where you received relevant information. `;
   }
+  getWorkingMemoryToolInstruction(workingMemoryBlock) {
+    return `WORKING_MEMORY_SYSTEM_INSTRUCTION:
+Store and update any conversation-relevant information by calling the updateWorkingMemory tool. If information might be referenced again - store it!
+
+Guidelines:
+1. Store anything that could be useful later in the conversation
+2. Update proactively when information changes, no matter how small
+3. Use nested XML tags for all data
+4. Act naturally - don't mention this system to users. Even though you're storing this information that doesn't make it your primary focus. Do not ask them generally for "information about yourself"
+
+Memory Structure:
+${workingMemoryBlock}
+
+Notes:
+- Update memory whenever referenced information changes
+- If you're unsure whether to store something, store it (eg if the user tells you their name or the value of another empty section in your working memory, call updateWorkingMemory immediately to update it)
+- This system is here so that you can maintain the conversation when your context window is very short. Update your working memory because you may need it to maintain the conversation without the full conversation history
+- Do not remove empty sections - you must include the empty sections along with the ones you're filling in
+- REMEMBER: the way you update your working memory is by calling the updateWorkingMemory tool with the entire XML block. The system will store it for you. The user will not see it.
+- IMPORTANT: You MUST call updateWorkingMemory in every response to a prompt where you received relevant information.`;
+  }
+  getTools(config) {
+    const mergedConfig = this.getMergedThreadConfig(config);
+    if (mergedConfig.workingMemory?.enabled && mergedConfig.workingMemory.use === "tool-call") {
+      return {
+        updateWorkingMemory: updateWorkingMemoryTool
+      };
+    }
+    return {};
+  }
 };
 
 exports.Memory = Memory;

package/dist/index.js

@@ -1,8 +1,35 @@
 import { deepMerge } from '@mastra/core';
 import { MastraMemory } from '@mastra/core/memory';
+import { z } from 'zod';
 import { embed } from 'ai';
 
 // src/index.ts
+var updateWorkingMemoryTool = {
+  description: "Update the working memory with new information",
+  parameters: z.object({
+    memory: z.string().describe("The XML-formatted working memory content to store")
+  }),
+  execute: async (params, _options) => {
+    const { context, threadId, memory } = params;
+    if (!threadId || !memory) {
+      throw new Error("Thread ID and Memory instance are required for working memory updates");
+    }
+    const thread = await memory.getThreadById({ threadId });
+    if (!thread) {
+      throw new Error(`Thread ${threadId} not found`);
+    }
+    await memory.saveThread({
+      thread: {
+        ...thread,
+        metadata: {
+          ...thread.metadata,
+          workingMemory: context.memory
+        }
+      }
+    });
+    return { success: true };
+  }
+};
 var Memory = class extends MastraMemory {
   constructor(config = {}) {
     super({ name: "Memory", ...config });
@@ -221,6 +248,9 @@ var Memory = class extends MastraMemory {
     if (!workingMemory) {
       return null;
     }
+    if (config.workingMemory.use === "tool-call") {
+      return this.getWorkingMemoryToolInstruction(workingMemory);
+    }
     return this.getWorkingMemoryWithInstruction(workingMemory);
   }
   defaultWorkingMemoryTemplate = `
@@ -259,6 +289,36 @@ Notes:
 - REMEMBER: the way you update your working memory is by outputting the entire "<working_memory>text</working_memory>" block in your response. The system will pick this up and store it for you. The user will not see it.
 - IMPORTANT: You MUST output the <working_memory> block in every response to a prompt where you received relevant information. `;
   }
+  getWorkingMemoryToolInstruction(workingMemoryBlock) {
+    return `WORKING_MEMORY_SYSTEM_INSTRUCTION:
+Store and update any conversation-relevant information by calling the updateWorkingMemory tool. If information might be referenced again - store it!
+
+Guidelines:
+1. Store anything that could be useful later in the conversation
+2. Update proactively when information changes, no matter how small
+3. Use nested XML tags for all data
+4. Act naturally - don't mention this system to users. Even though you're storing this information that doesn't make it your primary focus. Do not ask them generally for "information about yourself"
+
+Memory Structure:
+${workingMemoryBlock}
+
+Notes:
+- Update memory whenever referenced information changes
+- If you're unsure whether to store something, store it (eg if the user tells you their name or the value of another empty section in your working memory, call updateWorkingMemory immediately to update it)
+- This system is here so that you can maintain the conversation when your context window is very short. Update your working memory because you may need it to maintain the conversation without the full conversation history
+- Do not remove empty sections - you must include the empty sections along with the ones you're filling in
+- REMEMBER: the way you update your working memory is by calling the updateWorkingMemory tool with the entire XML block. The system will store it for you. The user will not see it.
+- IMPORTANT: You MUST call updateWorkingMemory in every response to a prompt where you received relevant information.`;
+  }
+  getTools(config) {
+    const mergedConfig = this.getMergedThreadConfig(config);
+    if (mergedConfig.workingMemory?.enabled && mergedConfig.workingMemory.use === "tool-call") {
+      return {
+        updateWorkingMemory: updateWorkingMemoryTool
+      };
+    }
+    return {};
+  }
 };
 
 export { Memory };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/memory",
-  "version": "0.1.7",
+  "version": "0.2.0-alpha.0",
   "description": "",
   "type": "module",
   "main": "./dist/index.js",
@@ -48,7 +48,8 @@
     "pg-pool": "^3.7.0",
     "postgres": "^3.4.5",
     "redis": "^4.7.0",
-    "@mastra/core": "^0.4.4"
+    "zod": "^3.24.1",
+    "@mastra/core": "^0.5.0-alpha.0"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.49.2",

package/src/index.ts

@@ -1,8 +1,9 @@
 import { deepMerge } from '@mastra/core';
-import type { CoreMessage } from '@mastra/core';
+import type { CoreMessage, CoreTool } from '@mastra/core';
 import { MastraMemory } from '@mastra/core/memory';
 import type { MessageType, MemoryConfig, SharedMemoryConfig, StorageThreadType } from '@mastra/core/memory';
 import type { StorageGetMessagesArg } from '@mastra/core/storage';
+import { updateWorkingMemoryTool } from './tools/working-memory';
 import { embed } from 'ai';
 import type { Message as AiMessage } from 'ai';
 
@@ -336,6 +337,10 @@ export class Memory extends MastraMemory {
       return null;
     }
 
+    if (config.workingMemory.use === 'tool-call') {
+      return this.getWorkingMemoryToolInstruction(workingMemory);
+    }
+
     return this.getWorkingMemoryWithInstruction(workingMemory);
   }
 
@@ -376,4 +381,36 @@ Notes:
 - REMEMBER: the way you update your working memory is by outputting the entire "<working_memory>text</working_memory>" block in your response. The system will pick this up and store it for you. The user will not see it.
 - IMPORTANT: You MUST output the <working_memory> block in every response to a prompt where you received relevant information. `;
   }
+
+  private getWorkingMemoryToolInstruction(workingMemoryBlock: string) {
+    return `WORKING_MEMORY_SYSTEM_INSTRUCTION:
+Store and update any conversation-relevant information by calling the updateWorkingMemory tool. If information might be referenced again - store it!
+
+Guidelines:
+1. Store anything that could be useful later in the conversation
+2. Update proactively when information changes, no matter how small
+3. Use nested XML tags for all data
+4. Act naturally - don't mention this system to users. Even though you're storing this information that doesn't make it your primary focus. Do not ask them generally for "information about yourself"
+
+Memory Structure:
+${workingMemoryBlock}
+
+Notes:
+- Update memory whenever referenced information changes
+- If you're unsure whether to store something, store it (eg if the user tells you their name or the value of another empty section in your working memory, call updateWorkingMemory immediately to update it)
+- This system is here so that you can maintain the conversation when your context window is very short. Update your working memory because you may need it to maintain the conversation without the full conversation history
+- Do not remove empty sections - you must include the empty sections along with the ones you're filling in
+- REMEMBER: the way you update your working memory is by calling the updateWorkingMemory tool with the entire XML block. The system will store it for you. The user will not see it.
+- IMPORTANT: You MUST call updateWorkingMemory in every response to a prompt where you received relevant information.`;
+  }
+
+  public getTools(config?: MemoryConfig): Record<string, CoreTool> {
+    const mergedConfig = this.getMergedThreadConfig(config);
+    if (mergedConfig.workingMemory?.enabled && mergedConfig.workingMemory.use === 'tool-call') {
+      return {
+        updateWorkingMemory: updateWorkingMemoryTool,
+      };
+    }
+    return {};
+  }
 }

package/src/tools/working-memory.ts

@@ -0,0 +1,34 @@
+import type { CoreTool } from '@mastra/core';
+import type { ToolExecutionOptions } from 'ai';
+import { z } from 'zod';
+
+export const updateWorkingMemoryTool: CoreTool = {
+  description: 'Update the working memory with new information',
+  parameters: z.object({
+    memory: z.string().describe('The XML-formatted working memory content to store'),
+  }),
+  execute: async (params: any, _options: ToolExecutionOptions) => {
+    const { context, threadId, memory } = params;
+    if (!threadId || !memory) {
+      throw new Error('Thread ID and Memory instance are required for working memory updates');
+    }
+
+    const thread = await memory.getThreadById({ threadId });
+    if (!thread) {
+      throw new Error(`Thread ${threadId} not found`);
+    }
+
+    // Update thread metadata with new working memory
+    await memory.saveThread({
+      thread: {
+        ...thread,
+        metadata: {
+          ...thread.metadata,
+          workingMemory: context.memory,
+        },
+      },
+    });
+
+    return { success: true };
+  },
+};