Merge pull request #485 from supermemoryai/10-10-fix_add_memory_code_params_and_documentation_in_readme

fix: add memory code params and documentation in readme

packages/tools/README.md

@@ -170,10 +170,37 @@ const result = await generateText({
 })
 ```
 
-**Combined Options** - Use verbose logging with specific modes:
+#### Automatic Memory Capture
+
+The middleware can automatically save user messages as memories:
+
+**Always Save Memories** - Automatically stores every user message as a memory:
+```typescript
+import { generateText } from "ai"
+import { withSupermemory } from "@supermemory/tools/ai-sdk"
+import { openai } from "@ai-sdk/openai"
+
+const modelWithAutoSave = withSupermemory(openai("gpt-4"), "user-123", {
+  addMemory: "always"
+})
+
+const result = await generateText({
+  model: modelWithAutoSave,
+  messages: [{ role: "user", content: "I prefer React with TypeScript for my projects" }],
+})
+// This message will be automatically saved as a memory
+```
+
+**Never Save Memories (Default)** - Only retrieves memories without storing new ones:
+```typescript
+const modelWithNoSave = withSupermemory(openai("gpt-4"), "user-123")
+```
+
+**Combined Options** - Use verbose logging with specific modes and memory storage:
 ```typescript
 const modelWithOptions = withSupermemory(openai("gpt-4"), "user-123", {
   mode: "profile",
+  addMemory: "always",
   verbose: true
 })
 ```
@@ -247,6 +274,22 @@ interface SupermemoryToolsConfig {
 - **containerTags**: Array of custom container tags (mutually exclusive with projectId)
 - **projectId**: Project ID which gets converted to container tag format (mutually exclusive with containerTags)
 
+### withSupermemory Middleware Options
+
+The `withSupermemory` middleware accepts additional configuration options:
+
+```typescript
+interface WithSupermemoryOptions {
+  verbose?: boolean
+  mode?: "profile" | "query" | "full"
+  addMemory?: "always" | "never"
+}
+```
+
+- **verbose**: Enable detailed logging of memory search and injection process (default: false)
+- **mode**: Memory search mode - "profile" (default), "query", or "full"
+- **addMemory**: Automatic memory storage mode - "always" or "never" (default: "never")
+
 ## Available Tools
 
 ### Search Memories

packages/tools/src/vercel/index.ts

@@ -15,6 +15,7 @@ import { createSupermemoryMiddleware } from "./middleware"
  * @param options - Optional configuration options for the middleware
  * @param options.verbose - Optional flag to enable detailed logging of memory search and injection process (default: false)
  * @param options.mode - Optional mode for memory search: "profile" (default), "query", or "full"
+ * @param options.addMemory - Optional mode for memory search: "always" (default), "never"
  *
  * @returns A wrapped language model that automatically includes relevant memories in prompts
  *

packages/tools/src/vercel/middleware.ts

@@ -22,12 +22,6 @@ const supermemoryprofilesearch = async (
 	containerTag: string,
 	queryText: string,
 ): Promise<ProfileStructure> => {
-	const SUPERMEMORY_API_KEY = process.env.SUPERMEMORY_API_KEY
-
-	if (!SUPERMEMORY_API_KEY) {
-		throw new Error("SUPERMEMORY_API_KEY is not set")
-	}
-
 	const payload = queryText
 		? JSON.stringify({
 				q: queryText,
@@ -42,7 +36,7 @@ const supermemoryprofilesearch = async (
 			method: "POST",
 			headers: {
 				"Content-Type": "application/json",
-				Authorization: `Bearer ${SUPERMEMORY_API_KEY}`,
+				Authorization: `Bearer ${process.env.SUPERMEMORY_API_KEY}`,
 			},
 			body: payload,
 		})
@@ -118,7 +112,7 @@ const addSystemPrompt = async (
 	}
 
 	if (systemPromptExists) {
-		logger.debug("Appending memories to existing system prompt")
+		logger.debug("Added memories to existing system prompt")
 		return {
 			...params,
 			prompt: params.prompt.map((prompt) =>
@@ -130,7 +124,7 @@ const addSystemPrompt = async (
 	}
 
 	logger.debug(
-		"System prompt does not exist, creating system prompt with memories",
+		"System prompt does not exist, created system prompt with memories",
 	)
 	return {
 		...params,
@@ -169,25 +163,17 @@ export const createSupermemoryMiddleware = (
 	addMemory: "always" | "never" = "never"
 ): LanguageModelV2Middleware => {
 	const logger = createLogger(verbose)
-	
-	const SUPERMEMORY_API_KEY = process.env.SUPERMEMORY_API_KEY
-	if (!SUPERMEMORY_API_KEY) {
-		throw new Error("SUPERMEMORY_API_KEY is not set")
-	}
-	
+
 	const client = new Supermemory({
-		apiKey: SUPERMEMORY_API_KEY,
+		apiKey: process.env.SUPERMEMORY_API_KEY,
 	})
 
 	return {
 		transformParams: async ({ params }) => {
 			const userMessage = getLastUserMessage(params)
 
-			// Add userMessage to memories based on addMemory setting
 			if (addMemory === "always" && userMessage && userMessage.trim()) {
-				addMemoryTool(client, containerTag, userMessage, logger).catch((error) => {
-					logger.error("Failed to create memories", { error })
-				})
+				addMemoryTool(client, containerTag, userMessage, logger)
 			}
 
 			if (mode !== "profile") {

packages/tools/test/ai-sdk-test.ts

@@ -4,7 +4,8 @@ import { openai } from "@ai-sdk/openai"
 
 const modelWithMemory = withSupermemory(openai("gpt-5"), "user_id_life", {
 	verbose: true,
-	mode: "query", // options are profile, query, full
+	mode: "query", // options are profile, query, full (default is profile)
+	addMemory: "always", // options are always, never (default is never)
 })
 
 const result = await generateText({