diff --git a/api/app/clients/tools/util/handleTools.js b/api/app/clients/tools/util/handleTools.js index adeb9f7ca9..e4e4726610 100644 --- a/api/app/clients/tools/util/handleTools.js +++ b/api/app/clients/tools/util/handleTools.js @@ -6,9 +6,12 @@ const { createSafeUser, mcpToolPattern, loadWebSearchAuth, + buildInlineMemoryTool, getCodeApiAuthHeaders, buildImageToolContext, + SET_MEMORY_TOOL_NAME, buildWebSearchContext, + DELETE_MEMORY_TOOL_NAME, buildWebSearchDynamicContext, } = require('@librechat/api'); const { @@ -48,7 +51,7 @@ const { getUserPluginAuthValue } = require('~/server/services/PluginService'); const { loadAuthValues } = require('~/server/services/Tools/credentials'); const { getMCPServerTools } = require('~/server/services/Config'); const { getMCPServersRegistry } = require('~/config'); -const { getRoleByName } = require('~/models'); +const { getRoleByName, setMemory, deleteMemory, getFormattedMemories } = require('~/models'); /** * Validates the availability and authentication of tools for a user based on environment variables or user-specific plugin authentication values. @@ -357,6 +360,17 @@ const loadTools = async ({ }); }; continue; + } else if (tool === SET_MEMORY_TOOL_NAME || tool === DELETE_MEMORY_TOOL_NAME) { + requestedTools[tool] = () => + buildInlineMemoryTool({ + toolName: tool, + req: options.req, + agent, + userId: user, + memoryMethods: { setMemory, deleteMemory, getFormattedMemories }, + getRoleByName, + }); + continue; } else if (tool && mcpToolPattern.test(tool)) { if (!canUseMCP) { if (!loggedMCPDenied) { diff --git a/api/server/controllers/agents/callbacks.js b/api/server/controllers/agents/callbacks.js index d0b2ea4aaa..8b00ac36d6 100644 --- a/api/server/controllers/agents/callbacks.js +++ b/api/server/controllers/agents/callbacks.js @@ -728,6 +728,28 @@ function createToolEndCallback({ req, res, artifactPromises, streamId = null }) ); } + if (output.artifact[Tools.memory]) { + artifactPromises.push( + (async () => { + const attachment = { + type: Tools.memory, + messageId: metadata.run_id, + toolCallId: output.tool_call_id, + conversationId: metadata.thread_id, + [Tools.memory]: output.artifact[Tools.memory], + }; + if (!streamId && !res.headersSent) { + return attachment; + } + writeAttachment(res, streamId, attachment); + return attachment; + })().catch((error) => { + logger.error('Error processing memory artifact content:', error); + return null; + }), + ); + } + if (output.artifact.content) { /** @type {FormattedContent[]} */ const content = output.artifact.content; diff --git a/api/server/controllers/agents/client.js b/api/server/controllers/agents/client.js index e073c964d7..df2515c2ab 100644 --- a/api/server/controllers/agents/client.js +++ b/api/server/controllers/agents/client.js @@ -33,7 +33,9 @@ const { GenerationJobManager, getTransactionsConfig, resolveRecursionLimit, + getRequestMemories, createMemoryProcessor, + agentHasInlineMemoryTools, loadAgent: loadAgentFn, createMultiAgentMapper, filterMalformedContentParts, @@ -516,11 +518,14 @@ class AgentClient extends BaseClient { } } - /** Memory context (user preferences/memories) */ - const withoutKeys = await this.useMemory(); - const memoryContext = withoutKeys - ? `${memoryInstructions}\n\n# Existing memory about the user:\n${withoutKeys}` - : undefined; + /** Memory context (user preferences/memories). Keyed context (with memory + * keys + token metadata) is reserved for agents that can call + * `delete_memory`; everyone else gets the unkeyed values only. */ + const memories = await this.useMemory(); + const buildMemoryContext = (text) => + text ? `${memoryInstructions}\n\n# Existing memory about the user:\n${text}` : undefined; + const memoryContext = buildMemoryContext(memories?.withoutKeys); + const keyedMemoryContext = buildMemoryContext(memories?.withKeys); const sharedRunContext = sharedRunContextParts.join('\n\n'); const memoryAgentEnabled = isMemoryAgentEnabled(this.options.req.config?.memory); @@ -571,8 +576,13 @@ class AgentClient extends BaseClient { await Promise.all( allAgents.map(({ agent, agentId }) => { const agentRunContextParts = [sharedRunContext]; - if (memoryContext && (agentId === this.options.agent.id || memoryAgentEnabled)) { - agentRunContextParts.push(memoryContext); + const agentHasMemory = agentHasInlineMemoryTools(agent); + const agentMemoryContext = agentHasMemory ? keyedMemoryContext : memoryContext; + if ( + agentMemoryContext && + (agentId === this.options.agent.id || memoryAgentEnabled || agentHasMemory) + ) { + agentRunContextParts.push(agentMemoryContext); } const scopedContext = agentScopedContext.get(agentId); if (scopedContext) { @@ -623,7 +633,7 @@ class AgentClient extends BaseClient { } /** - * @returns {Promise} + * @returns {Promise<{ withKeys?: string; withoutKeys?: string } | undefined>} */ async useMemory() { const user = this.options.req.user; @@ -654,8 +664,12 @@ class AgentClient extends BaseClient { if (!isMemoryAgentEnabled(memoryConfig)) { try { - const { withoutKeys } = await db.getFormattedMemories({ userId }); - return withoutKeys; + const { withKeys, withoutKeys } = await getRequestMemories({ + req: this.options.req, + userId, + getFormattedMemories: db.getFormattedMemories, + }); + return { withKeys, withoutKeys }; } catch (error) { logger.error( '[api/server/controllers/agents/client.js #useMemory] Error loading memories', @@ -772,7 +786,20 @@ class AgentClient extends BaseClient { }); this.processMemory = processMemory; - return withoutKeys; + let withKeys = withoutKeys; + try { + ({ withKeys } = await getRequestMemories({ + req: this.options.req, + userId, + getFormattedMemories: db.getFormattedMemories, + })); + } catch (error) { + logger.error( + '[api/server/controllers/agents/client.js #useMemory] Error loading keyed memories', + error, + ); + } + return { withKeys, withoutKeys }; } /** diff --git a/api/server/controllers/agents/client.test.js b/api/server/controllers/agents/client.test.js index c71ede7b23..1320e362c1 100644 --- a/api/server/controllers/agents/client.test.js +++ b/api/server/controllers/agents/client.test.js @@ -2361,7 +2361,9 @@ describe('AgentClient - titleConvo', () => { it('should only pass memory context to the primary agent by default', async () => { const memoryContent = 'User prefers dark mode. User is a software developer.'; - client.useMemory = jest.fn().mockResolvedValue(memoryContent); + client.useMemory = jest + .fn() + .mockResolvedValue({ withKeys: memoryContent, withoutKeys: memoryContent }); const parallelAgent1 = { id: 'parallel-agent-1', @@ -2414,7 +2416,9 @@ describe('AgentClient - titleConvo', () => { it('should pass memory context to parallel agents when automatic memory updates are enabled', async () => { const memoryContent = 'User prefers dark mode. User is a software developer.'; - client.useMemory = jest.fn().mockResolvedValue(memoryContent); + client.useMemory = jest + .fn() + .mockResolvedValue({ withKeys: memoryContent, withoutKeys: memoryContent }); mockReq.config.memory.agent = { enabled: true, id: 'memory-agent', @@ -2485,7 +2489,9 @@ describe('AgentClient - titleConvo', () => { it('should handle parallel agents without existing instructions when memory stays primary-only', async () => { const memoryContent = 'User is a data scientist.'; - client.useMemory = jest.fn().mockResolvedValue(memoryContent); + client.useMemory = jest + .fn() + .mockResolvedValue({ withKeys: memoryContent, withoutKeys: memoryContent }); const parallelAgentNoInstructions = { id: 'parallel-agent-no-instructions', @@ -2521,7 +2527,9 @@ describe('AgentClient - titleConvo', () => { it('should not modify agentConfigs when none exist', async () => { const memoryContent = 'User prefers concise responses.'; - client.useMemory = jest.fn().mockResolvedValue(memoryContent); + client.useMemory = jest + .fn() + .mockResolvedValue({ withKeys: memoryContent, withoutKeys: memoryContent }); client.agentConfigs = null; @@ -2547,7 +2555,9 @@ describe('AgentClient - titleConvo', () => { it('should handle empty agentConfigs map', async () => { const memoryContent = 'User likes detailed explanations.'; - client.useMemory = jest.fn().mockResolvedValue(memoryContent); + client.useMemory = jest + .fn() + .mockResolvedValue({ withKeys: memoryContent, withoutKeys: memoryContent }); client.agentConfigs = new Map(); @@ -2720,7 +2730,7 @@ describe('AgentClient - titleConvo', () => { const result = await client.useMemory(); - expect(result).toBe('likes pasta'); + expect(result).toEqual({ withKeys: 'food: likes pasta', withoutKeys: 'likes pasta' }); expect(mockGetFormattedMemories).toHaveBeenCalledWith({ userId: 'user-123' }); expect(mockInitializeAgent).not.toHaveBeenCalled(); expect(mockCreateMemoryProcessor).not.toHaveBeenCalled(); @@ -2745,7 +2755,7 @@ describe('AgentClient - titleConvo', () => { const result = await client.useMemory(); - expect(result).toBe(''); + expect(result).toEqual({ withKeys: '', withoutKeys: '' }); expect(mockGetFormattedMemories).toHaveBeenCalledWith({ userId: 'user-123' }); expect(mockInitializeAgent).not.toHaveBeenCalled(); expect(mockCreateMemoryProcessor).not.toHaveBeenCalled(); @@ -2770,7 +2780,7 @@ describe('AgentClient - titleConvo', () => { const result = await client.useMemory(); - expect(result).toBe('prefers concise answers'); + expect(result).toEqual({ withKeys: 'tone: concise', withoutKeys: 'prefers concise answers' }); expect(mockLoadAgent).not.toHaveBeenCalled(); expect(mockInitializeAgent).not.toHaveBeenCalled(); expect(mockCreateMemoryProcessor).not.toHaveBeenCalled(); diff --git a/api/server/controllers/agents/filterAuthorizedTools.spec.js b/api/server/controllers/agents/filterAuthorizedTools.spec.js index 89835fac06..677bccdfe0 100644 --- a/api/server/controllers/agents/filterAuthorizedTools.spec.js +++ b/api/server/controllers/agents/filterAuthorizedTools.spec.js @@ -183,12 +183,12 @@ describe('MCP Tool Authorization', () => { test('should keep system tools without querying MCP registry', async () => { const result = await filterAuthorizedTools({ - tools: ['execute_code', 'file_search', 'web_search'], + tools: ['execute_code', 'file_search', 'web_search', 'memory'], userId, availableTools: {}, }); - expect(result).toEqual(['execute_code', 'file_search', 'web_search']); + expect(result).toEqual(['execute_code', 'file_search', 'web_search', 'memory']); expect(mockGetAllServerConfigs).not.toHaveBeenCalled(); }); diff --git a/api/server/controllers/agents/v1.js b/api/server/controllers/agents/v1.js index ec1c6e62f2..5742a3ad7e 100644 --- a/api/server/controllers/agents/v1.js +++ b/api/server/controllers/agents/v1.js @@ -56,6 +56,7 @@ const systemTools = { [Tools.execute_code]: true, [Tools.file_search]: true, [Tools.web_search]: true, + [Tools.memory]: true, }; const MAX_SEARCH_LEN = 100; diff --git a/api/server/services/Endpoints/agents/addedConvo.js b/api/server/services/Endpoints/agents/addedConvo.js index 847c6c01af..37c703124d 100644 --- a/api/server/services/Endpoints/agents/addedConvo.js +++ b/api/server/services/Endpoints/agents/addedConvo.js @@ -79,6 +79,7 @@ const processAddedConvo = async ({ skillStates, defaultActiveOnShare, codeEnvAvailable, + memoryAvailable, }) => { const addedConvo = endpointOption.addedConvo; if (addedConvo == null) { @@ -173,6 +174,7 @@ const processAddedConvo = async ({ ephemeralSkillsToggle, }), codeEnvAvailable, + memoryAvailable, skillStates, defaultActiveOnShare, }, diff --git a/api/server/services/Endpoints/agents/initialize.js b/api/server/services/Endpoints/agents/initialize.js index 9caee651c4..530901e691 100644 --- a/api/server/services/Endpoints/agents/initialize.js +++ b/api/server/services/Endpoints/agents/initialize.js @@ -1,8 +1,10 @@ const { logger } = require('@librechat/data-schemas'); const { createContentAggregator } = require('@librechat/agents'); const { + checkAccess, loadSkillStates, initializeAgent, + isMemoryEnabled, primeInvokedSkills, validateAgentModel, extractManualSkills, @@ -15,9 +17,11 @@ const { buildAgentContextAttachmentsByAgentId, } = require('@librechat/api'); const { + Permissions, ResourceType, EModelEndpoint, PermissionBits, + PermissionTypes, MAX_SUBAGENT_DEPTH, isAgentsEndpoint, getResponseSender, @@ -148,6 +152,24 @@ const initializeClient = async ({ req, res, signal, endpointOption }) => { const ephemeralSkillsToggle = req.body?.ephemeralAgent?.skills === true; const skillDbMethods = getSkillDbMethods(); + /** Run-level gate for inline memory tools: the `memory` capability must be + * enabled, memory must be configured, and the user must not have opted out. + * Requires the memory WRITE permissions (CREATE + UPDATE) — both inline tools + * mutate memory — so the tools aren't registered (and shown to the model) for + * read-only-memory roles that the runtime loader would then refuse to build. + * Agents (or the ephemeral memory badge) opt in per-agent via the `memory` + * marker on `tools`. */ + const memoryAvailable = + enabledCapabilities.has(AgentCapabilities.memory) && + isMemoryEnabled(appConfig?.memory) && + req.user?.personalization?.memories !== false && + (await checkAccess({ + user: req.user, + permissionType: PermissionTypes.MEMORIES, + permissions: [Permissions.USE, Permissions.CREATE, Permissions.UPDATE], + getRoleByName: db.getRoleByName, + })); + const accessibleSkillIds = skillsCapabilityEnabled ? withDeploymentSkillIds( await findAccessibleResources({ @@ -383,6 +405,7 @@ const initializeClient = async ({ req, res, signal, endpointOption }) => { accessibleSkillIds: primaryScopedSkillIds, skillAuthoringAvailable: primarySkillAuthoringAvailable, codeEnvAvailable, + memoryAvailable, skillStates, defaultActiveOnShare, manualSkills, @@ -458,6 +481,7 @@ const initializeClient = async ({ req, res, signal, endpointOption }) => { skillStates, defaultActiveOnShare, codeEnvAvailable, + memoryAvailable, }, { getAgent: db.getAgent, @@ -529,6 +553,7 @@ const initializeClient = async ({ req, res, signal, endpointOption }) => { skillStates, defaultActiveOnShare, codeEnvAvailable, + memoryAvailable, }); if (updatedMCPAuthMap) { @@ -667,6 +692,7 @@ const initializeClient = async ({ req, res, signal, endpointOption }) => { * false`, so `bash_tool` / `read_file` sandbox fallback are * silently gated off even though the seed walk found it. */ codeEnvAvailable, + memoryAvailable, skillStates, defaultActiveOnShare, }, diff --git a/api/server/services/ToolService.js b/api/server/services/ToolService.js index b11529205b..082217e783 100644 --- a/api/server/services/ToolService.js +++ b/api/server/services/ToolService.js @@ -507,7 +507,12 @@ async function processRequiredActions(client, requiredActions) { * }>} The agent tools and registry. */ /** Native LibreChat tools that are not in the manifest */ -const nativeTools = new Set([Tools.execute_code, Tools.file_search, Tools.web_search]); +const nativeTools = new Set([ + Tools.execute_code, + Tools.file_search, + Tools.web_search, + Tools.memory, +]); /** Checks if a tool name is a known built-in tool */ const isBuiltInTool = (toolName) => @@ -571,6 +576,9 @@ async function loadToolDefinitionsWrapper({ req, res, agent, streamId = null, to if (tool === Tools.web_search) { return checkCapability(AgentCapabilities.web_search); } + if (tool === Tools.memory) { + return checkCapability(AgentCapabilities.memory); + } if (isActionTool(tool)) { return actionsEnabled; } @@ -1123,6 +1131,8 @@ async function loadAgentTools({ } else if (tool === Tools.web_search) { includesWebSearch = checkCapability(AgentCapabilities.web_search); return includesWebSearch; + } else if (tool === Tools.memory) { + return checkCapability(AgentCapabilities.memory); } else if (isActionTool(tool)) { return actionsEnabled; } else if (tool?.includes(Constants.mcp_delimiter)) { diff --git a/client/src/Providers/BadgeRowContext.tsx b/client/src/Providers/BadgeRowContext.tsx index 448af4339f..17e8f3b6e8 100644 --- a/client/src/Providers/BadgeRowContext.tsx +++ b/client/src/Providers/BadgeRowContext.tsx @@ -17,6 +17,7 @@ interface BadgeRowContextType { storageContextKey?: string; agentsConfig?: TAgentsEndpoint | null; skills: ReturnType; + memory: ReturnType; webSearch: ReturnType; artifacts: ReturnType; fileSearch: ReturnType; @@ -100,12 +101,14 @@ export default function BadgeRowProvider({ const fileSearchToggleKey = `${LocalStorageKeys.LAST_FILE_SEARCH_TOGGLE_}${storageSuffix}`; const artifactsToggleKey = `${LocalStorageKeys.LAST_ARTIFACTS_TOGGLE_}${storageSuffix}`; const skillsToggleKey = `${LocalStorageKeys.LAST_SKILLS_TOGGLE_}${storageSuffix}`; + const memoryToggleKey = `${LocalStorageKeys.LAST_MEMORY_TOGGLE_}${storageSuffix}`; const codeToggleValue = getTimestampedValue(codeToggleKey); const webSearchToggleValue = getTimestampedValue(webSearchToggleKey); const fileSearchToggleValue = getTimestampedValue(fileSearchToggleKey); const artifactsToggleValue = getTimestampedValue(artifactsToggleKey); const skillsToggleValue = getTimestampedValue(skillsToggleKey); + const memoryToggleValue = getTimestampedValue(memoryToggleKey); const initialValues: Record = {}; @@ -149,6 +152,14 @@ export default function BadgeRowProvider({ } } + if (memoryToggleValue !== null) { + try { + initialValues[Tools.memory] = JSON.parse(memoryToggleValue); + } catch (e) { + console.error('Failed to parse memory toggle value:', e); + } + } + const hasOverrides = Object.keys(initialValues).length > 0; /** Read persisted MCP values from localStorage */ @@ -250,10 +261,20 @@ export default function BadgeRowProvider({ isAuthenticated: true, }); + /** Memory hook - per-conversation toggle for the inline memory tools */ + const memory = useToolToggle({ + conversationId, + storageContextKey, + toolKey: Tools.memory, + localStorageKey: LocalStorageKeys.LAST_MEMORY_TOGGLE_, + isAuthenticated: true, + }); + const mcpServerManager = useMCPServerManager({ conversationId, storageContextKey }); const value: BadgeRowContextType = { skills, + memory, webSearch, artifacts, fileSearch, diff --git a/client/src/common/agents-types.ts b/client/src/common/agents-types.ts index 7313812ec5..91692efab3 100644 --- a/client/src/common/agents-types.ts +++ b/client/src/common/agents-types.ts @@ -24,6 +24,7 @@ export type TAgentCapabilities = { [AgentCapabilities.web_search]: boolean; [AgentCapabilities.file_search]: boolean; [AgentCapabilities.execute_code]: boolean; + [AgentCapabilities.memory]?: boolean; [AgentCapabilities.end_after_tools]?: boolean; [AgentCapabilities.hide_sequential_outputs]?: boolean; }; diff --git a/client/src/components/Chat/Input/BadgeRow.tsx b/client/src/components/Chat/Input/BadgeRow.tsx index 7b7140c9fb..0964926a23 100644 --- a/client/src/components/Chat/Input/BadgeRow.tsx +++ b/client/src/components/Chat/Input/BadgeRow.tsx @@ -11,16 +11,17 @@ import React, { import { Badge } from '@librechat/client'; import { useRecoilValue, useRecoilCallback } from 'recoil'; import type { LucideIcon } from 'lucide-react'; +import type { BadgeItem } from '~/common'; import CodeInterpreter from './CodeInterpreter'; import { BadgeRowProvider } from '~/Providers'; import ToolsDropdown from './ToolsDropdown'; -import type { BadgeItem } from '~/common'; import { useChatBadges } from '~/hooks'; import ToolDialogs from './ToolDialogs'; import FileSearch from './FileSearch'; import Artifacts from './Artifacts'; import MCPSelect from './MCPSelect'; import WebSearch from './WebSearch'; +import Memory from './Memory'; import Skills from './Skills'; import store from '~/store'; @@ -375,6 +376,7 @@ function BadgeRow({ + diff --git a/client/src/components/Chat/Input/Memory.tsx b/client/src/components/Chat/Input/Memory.tsx new file mode 100644 index 0000000000..d43610599b --- /dev/null +++ b/client/src/components/Chat/Input/Memory.tsx @@ -0,0 +1,40 @@ +import React, { memo } from 'react'; +import { Brain } from 'lucide-react'; +import { CheckboxButton } from '@librechat/client'; +import { defaultAgentCapabilities } from 'librechat-data-provider'; +import { useLocalize, useHasMemoryAccess, useAgentCapabilities, useAuthContext } from '~/hooks'; +import { useBadgeRowContext } from '~/Providers'; + +function Memory() { + const localize = useLocalize(); + const { user } = useAuthContext(); + const context = useBadgeRowContext(); + const { toggleState: memoryActive, debouncedChange, isPinned } = context?.memory ?? {}; + + const canUseMemory = useHasMemoryAccess(); + + const { memoryEnabled } = useAgentCapabilities( + context?.agentsConfig?.capabilities ?? defaultAgentCapabilities, + ); + + const hasOptedOut = user?.personalization?.memories === false; + + if (!canUseMemory || !memoryEnabled || hasOptedOut) { + return null; + } + + return ( + (memoryActive || isPinned) && ( +