Merge pull request #1827 from oraios/memory-cleanup

src/serena/agent.py

@@ -956,17 +956,36 @@ class SerenaAgent:
             result[tool_class.get_name_from_cls()] = new_tool_class.get_name_from_cls()
         return result
 
-    def _format_prompt_tag(self, text: str, tag: str, tag_name_attr: str | None = None) -> str:
+    @staticmethod
+    def _format_prompt_tag(text: str, tag: str, tag_name_attr: str | None = None) -> str:
         open_tag = f"<{tag}" + (f' name="{tag_name_attr}"' if tag_name_attr is not None else "") + ">"
         close_tag = f"</{tag}>"
         return f"{open_tag}\n{text.strip()}\n{close_tag}"
 
-    def _format_prompt(self, prompt_template: str, tag: str | None = None, tag_name_attr: str | None = None) -> str:
+    def _render_prompt(self, prompt_template: str, tag: str | None = None, tag_name_attr: str | None = None) -> str:
+        """
+        Renders the given prompt template, providing the necessary variables and functions
+
+        :param prompt_template: the template text (jinja2) to render
+        :param tag: if not None, wraps the rendered prompt text in a tag
+        :param tag_name_attr: for the case where tag is not None, specifies the value of the "name" attribute of the tag
+        :return: the rendered prompt
+        """
+
+        def embed_memory(memory_name: str) -> str:
+            try:
+                memory_manager = self._get_memory_manager()
+                return self._format_prompt_tag(memory_manager.load_memory(memory_name), tag="memory", tag_name_attr=memory_name)
+            except Exception as e:
+                log.error("Tried to embed memory '%s' but failed to load it: %s", memory_name, e)
+                return ""
+
         template = JinjaTemplate(prompt_template)
         text = template.render(
             available_tools=self._exposed_tools.tool_names,
             available_markers=self._exposed_tools.tool_marker_names,
             tool_names=self._prompt_tool_names_mapping,
+            embed_memory=embed_memory,
         )
 
         if tag is not None:
@@ -982,6 +1001,21 @@ class SerenaAgent:
         """
         return self.prompt_factory.create_connection_prompt()
 
+    def _create_global_memory_manager(self) -> MemoryManager:
+        """
+        :return: a memory manager for global memories only (no project memories)
+        """
+        return MemoryManager(serena_data_folder=None, read_only_memory_patterns=self.serena_config.read_only_memory_patterns)
+
+    def _get_memory_manager(self) -> MemoryManager:
+        """
+        :return: the memory manager for the active project (if any) or a global memory manager if no project is active
+        """
+        if self._active_project is not None:
+            return self._active_project.memory_manager
+        else:
+            return self._create_global_memory_manager()
+
     def create_system_prompt(self, session_id: str = "global") -> str:
         """
         Returns the 'Serena Instructions Manual', i.e. Serena's system prompt.
@@ -991,9 +1025,7 @@ class SerenaAgent:
         """
         available_tools = self._active_tools
         available_markers = available_tools.tool_marker_names
-        global_memories = MemoryManager(
-            serena_data_folder=None, read_only_memory_patterns=self.serena_config.read_only_memory_patterns
-        ).list_global_memories()
+        global_memories = self._create_global_memory_manager().list_global_memories()
         global_memories_str = dict_string(global_memories.to_dict()) if len(global_memories) > 0 else ""
         log.info("Generating system prompt with available_tools=(see active tools), available_markers=%s", available_markers)
 
@@ -1007,8 +1039,8 @@ class SerenaAgent:
         self._project_prompt_status.mark_mode_prompts_as_provided(session_id)
 
         system_prompt = self.prompt_factory.create_system_prompt(
-            context_system_prompt=self._format_prompt(self._context.prompt, tag="context"),
-            mode_system_prompts=[self._format_prompt(mode.prompt, tag="mode", tag_name_attr=mode.name) for mode in relevant_modes],
+            context_system_prompt=self._render_prompt(self._context.prompt, tag="context"),
+            mode_system_prompts=[self._render_prompt(mode.prompt, tag="mode", tag_name_attr=mode.name) for mode in relevant_modes],
             available_tools=available_tools.tool_names,
             available_markers=available_markers,
             global_memories_list=global_memories_str,
@@ -1065,12 +1097,12 @@ class SerenaAgent:
         modes_with_prompts = self._project_prompt_status.get_modes_with_prompts_to_be_provided_for_project_activation(session_id)
         if modes_with_prompts:
             for mode in modes_with_prompts:
-                msg += self._format_prompt(mode.prompt, tag="mode", tag_name_attr=mode.name) + "\n"
+                msg += self._render_prompt(mode.prompt, tag="mode", tag_name_attr=mode.name) + "\n"
         self._project_prompt_status.mark_mode_prompts_as_provided(session_id)
 
         # add project-specific prompt
         if proj.project_config.initial_prompt:
-            msg += "\n" + self._format_prompt(proj.project_config.initial_prompt, tag="project-instructions")
+            msg += "\n" + self._render_prompt(proj.project_config.initial_prompt, tag="project-instructions")
 
         self._project_prompt_status.mark_project_activation_message_as_provided(session_id)
 

src/serena/resources/config/contexts/context.template.yml

@@ -1,11 +1,28 @@
-# See Serena's documentation for more details on concept of contexts.
-description: Description of the context, not used in the code.
-prompt: Prompt that will form part of the system prompt/initial instructions for agents started in this context.
+# See Serena's documentation for more details on concept of contexts:
+# https://oraios.github.io/serena/02-usage/050_configuration.html#contexts
+description: Description of the context (meta-information only)
+
+# define a prompt which will be included in the system prompt when agents are started in this context.
+# See:  https://oraios.github.io/serena/02-usage/050_configuration.html#prompt-templates
+prompt: |
+  This prompt will form part of the system prompt/initial instructions for agents started in this context.
+  Add as much content as needed.
+  Leave it undefined if no prompt is needed, i.e.
+     prompt: null
+
+# tools to be excluded in this context.
+# Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
 excluded_tools: []
 
-# several tools are excluded by default and have to be explicitly included by the user
+# included tools that would otherwise be excluded (particularly optional tools that are disabled by default).
+# Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
 included_optional_tools: []
 
+# fixed set of tools to use as the base tool set (if non-empty), replacing Serena's default set of tools.
+# This cannot be combined with non-empty excluded_tools or included_optional_tools.
+# Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
+fixed_tools: []
+
 # mapping of tool names to an override of their descriptions (the default description is the docstring of the Tool's apply method).
 # Sometimes, tool descriptions are too long (e.g., for ChatGPT), or users may want to override them for another reason.
 tool_description_overrides: {}

src/serena/resources/config/modes/mode.template.yml

@@ -1,8 +1,25 @@
-# See Serena's documentation for more details on concept of modes.
+# See Serena's documentation for more details on concept of modes:
+# https://oraios.github.io/serena/02-usage/050_configuration.html#modes
 description: Description of the mode (meta-information only)
+
+# define a prompt which will be included in the system prompt when this mode is activated
+# (or will be provided in the project activation message if the mode is activated dynamically).
+# See:  https://oraios.github.io/serena/02-usage/050_configuration.html#prompt-templates
 prompt: |
-  Provide a prompt that will form part of the instructions sent to the model when this mode is activated.
-# tools that are to be excluded by this mode
+  This prompt will form part of the system prompt/initial instructions for agents started in this context.
+  Add as much content as needed.
+  Leave it undefined if no prompt is needed, i.e.
+     prompt: null
+
+# tools to be excluded in this context.
+# Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
 excluded_tools: []
-# several tools are excluded by default and have to be explicitly included by the user
-included_optional_tools: []
+
+# included tools that would otherwise be excluded (particularly optional tools that are disabled by default).
+# Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
+included_optional_tools: []
+
+# fixed set of tools to use as the base tool set (if non-empty), replacing Serena's default set of tools.
+# This cannot be combined with non-empty excluded_tools or included_optional_tools.
+# Find the list of tools here: https://oraios.github.io/serena/01-about/035_tools.html
+fixed_tools: []