From 26d1e753c63dc3dedbda7ad3ba8f4d9134e71909 Mon Sep 17 00:00:00 2001
From: Dominik Jain <dominik.jain@outlook.com>
Date: Sat, 29 Mar 2025 21:06:51 +0100
Subject: [PATCH] Configure GUI log window in project file; disable on macOS

---
 myproject.demo.yml |  2 ++
 src/serena/mcp.py  | 27 ++++++++++++++++-----------
 2 files changed, 18 insertions(+), 11 deletions(-)

diff --git a/myproject.demo.yml b/myproject.demo.yml
index 1ef3bfac..7774e1f6 100644
--- a/myproject.demo.yml
+++ b/myproject.demo.yml
@@ -4,3 +4,5 @@ project_root: /path/to/project
 language: python
 # list of directories to ignore: either names (e.g. "temp") or relative paths (e.g. "build/foo")
 ignored_dirs: [".git", "temp"]
+# whether to open a graphical window with Serena's logs (not supported on MacOS)
+gui_log_window: True
diff --git a/src/serena/mcp.py b/src/serena/mcp.py
index d16d2ec0..1e9ba038 100644
--- a/src/serena/mcp.py
+++ b/src/serena/mcp.py
@@ -35,19 +35,13 @@ from serena.util.file_system import scan_directory
 from serena.util.shell import execute_shell_command
 
 log = logging.getLogger(__name__)
+LOG_FORMAT = "%(levelname)-5s %(asctime)-15s %(name)s:%(funcName)s:%(lineno)d - %(message)s"
+LOG_LEVEL = logging.INFO
 
 
 def configure_logging(*args, **kwargs) -> None:  # type: ignore
-    log_format = "%(levelname)-5s %(asctime)-15s %(name)s:%(funcName)s:%(lineno)d - %(message)s"
-    level = logging.INFO
-
     # configure logging to stderr (will be captured by Claude Desktop); stdio is the MCP communication stream and cannot be used!
-    logging.basicConfig(level=level, stream=sys.stderr, format=log_format)
-
-    # configure logging to GUI window
-    # Enable this if you want to see logs in the GUI window. It doesn't work on MacOS
-    # log_handler = GuiLogViewerHandler(GuiLogViewer(title="Serena Logs"), level=level)
-    # Logger.root.addHandler(log_handler)
+    logging.basicConfig(level=LOG_LEVEL, stream=sys.stderr, format=LOG_FORMAT)
 
 
 # patch the logging configuration function in fastmcp, because it's hard-coded and broken
@@ -78,14 +72,25 @@ async def server_lifespan(mcp_server: FastMCP) -> AsyncIterator[SerenaMCPRequest
         print(f"Project file not found: {project_file}", file=sys.stderr)
         sys.exit(1)
 
-    log.info(f"Starting serena server for project {project_file}; process id={os.getpid()}, parent process id={os.getppid()}")
-
     # read project configuration
     with open(project_file, encoding="utf-8") as f:
         project_config = yaml.safe_load(f)
     language = Language(project_config["language"])
     project_root = str(Path(project_config["project_root"]).resolve())
 
+    # enable GUI log window
+    enable_gui_log = project_config.get("gui_log_window", True)
+    if enable_gui_log:
+        if platform.system() == "Darwin":
+            log.warning("GUI log window is not supported on macOS")
+        else:
+            log_handler = GuiLogViewerHandler(GuiLogViewer(title="Serena Logs"), level=LOG_LEVEL, format_string=LOG_FORMAT)
+            Logger.root.addHandler(log_handler)
+
+    log.info(
+        f"Starting serena server for project {project_file} (language={language}, root={project_root}); process id={os.getpid()}, parent process id={os.getppid()}"
+    )
+
     # create and start the language server instance
     config = MultilspyConfig(code_language=language)
     logger = MultilspyLogger()