Serena

Instructions

Implementation Reference

• src/serena/tools/symbol_tools.py:238-260 (handler)

  MCP tool handler: InsertAfterSymbolTool.apply() delegates to CodeEditor.insert_after_symbol after creating the editor instance.

  class InsertAfterSymbolTool(Tool, ToolMarkerSymbolicEdit):
      """
      Inserts content after the end of the definition of a given symbol.
      """
  
      def apply(
          self,
          name_path: str,
          relative_path: str,
          body: str,
      ) -> str:
          """
          Inserts the given body/content after the end of the definition of the given symbol (via the symbol's location).
          A typical use case is to insert a new class, function, method, field or variable assignment.
  
          :param name_path: name path of the symbol after which to insert content (definitions in the `find_symbol` tool apply)
          :param relative_path: the relative path to the file containing the symbol
          :param body: the body/content to be inserted. The inserted code shall begin with the next line after
              the symbol.
          """
          code_editor = self.create_code_editor()
          code_editor.insert_after_symbol(name_path, relative_file_path=relative_path, body=body)
          return SUCCESS_RESULT

• src/serena/code_editor.py:134-167 (helper)

  Core logic for inserting content after a symbol's body end position, handling newlines and positioning correctly using symbol location from language server.

  def insert_after_symbol(self, name_path: str, relative_file_path: str, body: str) -> None:
      """
      Inserts content after the symbol with the given name in the given file.
      """
      symbol = self._find_unique_symbol(name_path, relative_file_path)
  
      # make sure body always ends with at least one newline
      if not body.endswith("\n"):
          body += "\n"
  
      pos = symbol.get_body_end_position_or_raise()
  
      # start at the beginning of the next line
      col = 0
      line = pos.line + 1
  
      # make sure a suitable number of leading empty lines is used (at least 0/1 depending on the symbol type,
      # otherwise as many as the caller wanted to insert)
      original_leading_newlines = self._count_leading_newlines(body)
      body = body.lstrip("\r\n")
      min_empty_lines = 0
      if symbol.is_neighbouring_definition_separated_by_empty_line():
          min_empty_lines = 1
      num_leading_empty_lines = max(min_empty_lines, original_leading_newlines)
      if num_leading_empty_lines:
          body = ("\n" * num_leading_empty_lines) + body
  
      # make sure the one line break succeeding the original symbol, which we repurposed as prefix via
      # `line += 1`, is replaced
      body = body.rstrip("\r\n") + "\n"
  
      with self.edited_file_context(relative_file_path) as edited_file:
          edited_file.insert_text_at_position(PositionInFile(line, col), body)

• src/serena/tools/symbol_tools.py:243-257 (schema)

  Input schema and documentation for the insert_after_symbol tool parameters.

  def apply(
      self,
      name_path: str,
      relative_path: str,
      body: str,
  ) -> str:
      """
      Inserts the given body/content after the end of the definition of the given symbol (via the symbol's location).
      A typical use case is to insert a new class, function, method, field or variable assignment.
  
      :param name_path: name path of the symbol after which to insert content (definitions in the `find_symbol` tool apply)
      :param relative_path: the relative path to the file containing the symbol
      :param body: the body/content to be inserted. The inserted code shall begin with the next line after
          the symbol.
      """