Make WM server logs path accessible by clients to make it easier to find for users

Author: Aksem

docs/wm-protocol.md

@@ -658,6 +658,29 @@ environment, it is stopped first.
 
 ### `server/` — Server Lifecycle & Notifications
 
+#### `server/getInfo`
+
+Return static information about the running WM Server instance.
+
+- **Type:** request
+- **Clients:** LSP, MCP, CLI
+- **Status:** implemented
+
+**Params:** `{}`
+
+**Result:**
+
+```json
+{
+  "log_file_path": "/abs/path/to/.venvs/dev_workspace/logs/wm_server/wm_server.log"
+}
+```
+
+`log_file_path` is the absolute path to the WM Server's log file for the current process.
+Clients can log or display this path so the user can open the file directly when troubleshooting.
+
+---
+
 #### `server/shutdown`
 
 Explicitly shut down the WM Server.

finecode_extension_runner/src/finecode_extension_runner/logs.py

@@ -43,7 +43,7 @@ def save_logs_to_file(
     rotation: str = "10 MB",
     retention: int = 3,
     stdout: bool = True,
-):
+) -> Path:
     if stdout is True:
         if isinstance(sys.stdout, io.TextIOWrapper):
             # reconfigure to be able to handle special symbols
@@ -101,7 +101,8 @@ def save_logs_to_file(
         encoding="utf8",
         filter=filter_logs,
     )
-    logger.trace(f"Log file: {file_path}")
+    logger.trace(f"Log file: {file_path_with_id}")
+    return file_path_with_id
 
 
 def set_log_level_for_group(group: str, level: LogLevel | None):

src/finecode/cli.py

@@ -491,7 +491,8 @@ def start_wm_server(trace: bool, port_file: str | None, disconnect_timeout: int)
     """Start the FineCode WM Server standalone (TCP JSON-RPC). Auto-stops when all clients disconnect."""
     from finecode.wm_server import wm_server
 
-    logger_utils.init_logger(log_name="wm_server", trace=trace, stdout=False)
+    log_file_path = logger_utils.init_logger(log_name="wm_server", trace=trace, stdout=False)
+    wm_server._log_file_path = log_file_path
     port_file_path = pathlib.Path(port_file) if port_file else None
     asyncio.run(wm_server.start_standalone(port_file=port_file_path, disconnect_timeout=disconnect_timeout))
 

src/finecode/logger_utils.py

@@ -8,7 +8,7 @@
 from finecode_extension_runner import logs
 
 
-def init_logger(log_name: str, trace: bool, stdout: bool = False):
+def init_logger(log_name: str, trace: bool, stdout: bool = False) -> Path:
     venv_dir_path = Path(sys.executable).parent.parent
     logs_dir_path = venv_dir_path / "logs"
 
@@ -23,7 +23,7 @@ def init_logger(log_name: str, trace: bool, stdout: bool = False):
         ]
     )
     logs.set_log_level_for_group(group="finecode_jsonrpc.client", level=logs.LogLevel.INFO)
-    logs.save_logs_to_file(
+    log_file_path = logs.save_logs_to_file(
         file_path=logs_dir_path / log_name / f"{log_name}.log",
         log_level="TRACE" if trace else "INFO",
         stdout=stdout,
@@ -52,3 +52,5 @@ def emit(self, record: logging.LogRecord) -> None:
             )
 
     logging.basicConfig(handlers=[InterceptHandler()], level=0, force=True)
+
+    return log_file_path

src/finecode/lsp_server/lsp_server.py

@@ -217,6 +217,19 @@ async def _on_initialized(ls: LanguageServer, params: types.InitializedParams):
         global_state.wm_client = None
         return
 
+    try:
+        info = await global_state.wm_client.get_info()
+        log_path = info.get("log_file_path")
+        if log_path:
+            ls.window_log_message(
+                types.LogMessageParams(
+                    type=types.MessageType.Info,
+                    message=f"FineCode WM Server log: {log_path}",
+                )
+            )
+    except Exception:
+        pass
+
     # Register notification handlers for server→client push messages.
     async def on_tree_changed(params: dict) -> None:
         # TODO

src/finecode/wm_client.py

@@ -86,6 +86,13 @@ async def connect(self, host: str, port: int) -> None:
         self._reader, self._writer = await asyncio.open_connection(host, port)
         self._reader_task = asyncio.create_task(self._read_loop())
         logger.info(f"Connected to FineCode API at {host}:{port}")
+        try:
+            info = await self.get_info()
+            log_path = info.get("log_file_path")
+            if log_path:
+                logger.info(f"WM Server log file: {log_path}")
+        except Exception:
+            pass  # non-critical, don't block connection
 
     async def close(self) -> None:
         if self._reader_task is not None:
@@ -118,6 +125,12 @@ def on_notification(
         """Register an async callback for a server→client notification."""
         self._notification_handlers[method] = callback
 
+    # -- Server methods -----------------------------------------------------
+
+    async def get_info(self) -> dict:
+        """Return static info about the WM Server (e.g. log file path)."""
+        return await self.request("server/getInfo")
+
     # -- Workspace methods --------------------------------------------------
 
     async def list_projects(self) -> list[dict]:

src/finecode/wm_server/wm_server.py

@@ -27,6 +27,9 @@
 DISCONNECT_TIMEOUT_SECONDS = 30
 NO_CLIENT_TIMEOUT_SECONDS = 30
 
+# save so that server/getInfo can return it
+_log_file_path: pathlib.Path | None = None
+
 
 # ---------------------------------------------------------------------------
 # JSON-RPC helpers
@@ -632,6 +635,19 @@ async def _handle_runners_remove_env(
     return {}
 
 
+async def _handle_server_get_info(
+    params: dict | None, ws_context: context.WorkspaceContext
+) -> dict:
+    """Handle ``server/getInfo``.
+
+    Returns static information about the running WM Server instance,
+    including the path to its log file.
+    """
+    return {
+        "log_file_path": str(_log_file_path) if _log_file_path is not None else None,
+    }
+
+
 async def _handle_server_reset(
     params: dict | None, ws_context: context.WorkspaceContext
 ) -> dict:
@@ -968,6 +984,7 @@ async def _handle_run_with_partial_results_task(
     "runners/checkEnv": _handle_runners_check_env,
     "runners/removeEnv": _handle_runners_remove_env,
     # server/
+    "server/getInfo": _handle_server_get_info,
     "server/reset": _handle_server_reset,
     "server/shutdown": _stub("server/shutdown"),
 }