Adding details to README

Author: aniket-s-kulkarni

README.md

@@ -12,6 +12,10 @@ Table of Contents
        - [Format](#format)
        - [Modes](#modes)
     - [The LLM (Claude) config file](#the-llm-claude-config-file)
+- [Logging](#logging)
+  - [Log File Locations](#log-file-locations)
+  - [Log Features](#log-features)
+  - [Enabling File Logging](#enabling-file-logging)
 - [Further Documentation](#further-documentation)
 - [Additional Information](#additional-information)
 
@@ -227,6 +231,47 @@ And then add this section
 
 This will pickup the default location of MCP server config file. It can also be passed in the `args` section above as `"--config-file", "<custom config file>"` after `run`
 
+# Logging
+
+The Dremio MCP server automatically writes log files to platform-specific directories following operating system conventions. This helps with troubleshooting and monitoring the server's operation.
+
+## Log File Locations
+
+The log files are stored in the following locations based on your operating system:
+
+### Linux
+- **Directory**: `~/.local/share/dremioai/logs/`
+- **Full path**: `~/.local/share/dremioai/logs/dremioai.log`
+- **XDG compliance**: Respects `$XDG_DATA_HOME` environment variable if set
+
+### macOS
+- **Directory**: `~/Library/Logs/dremioai/`
+- **Full path**: `~/Library/Logs/dremioai/dremioai.log`
+
+### Windows
+- **Directory**: `%LOCALAPPDATA%\dremioai\logs\`
+- **Full path**: `%LOCALAPPDATA%\dremioai\logs\dremioai.log`
+- **Typical location**: `C:\Users\<username>\AppData\Local\dremioai\logs\dremioai.log`
+
+
+## Controlling File Logging
+
+By default, the MCP server logs to the logfile mentioned above. To control it further, you can use the following environment variables and command line options:
+
+1. **Use JSON format**: `JSON_LOGGING=1` or pass `--enable-json-logging` for structured JSON logs 
+2. **Disable file logging**: pass `--no-log-to-file` to disable writing logs to file
+
+Example:
+```shell
+$ uv run dremio-mcp-server run --no-log-to-file --enable-json-logging
+
+# OR 
+
+$ uv run dremio-mcp-server run --enable-json-logging
+```
+
+The log directory is automatically created if it doesn't exist, so no manual setup is required.
+
 # Further Documentation
 
 1. [Architecture](docs/architecture.md): Detailed overview of the Dremio MCP server architecture, including component interactions and data flows.

src/dremioai/log.py

@@ -46,6 +46,10 @@ def get_log_directory(app_name: str = "dremioai") -> Path:
     return base_dir
 
 
+def get_log_file() -> Path:
+    return get_log_directory() / "dremioai.log"
+
+
 def logger(name=None):
     if not structlog.is_configured():
         configure()
@@ -82,8 +86,7 @@ def configure(enable_json_logging=None, to_file=False):
 
     # Set up file logging if requested
     if to_file:
-        log_dir = get_log_directory()
-        log_file_path = log_dir / "dremioai.log"
+        log_file_path = get_log_file()
 
         # Configure rotating file handler
         file_handler = RotatingFileHandler(

src/dremioai/servers/mcp.py

@@ -105,13 +105,13 @@ def main(
     list_tools: Annotated[
         bool, Option(help="List available tools for this mode and exit")
     ] = False,
-    log_to_file: Annotated[Optional[bool], Option(help="Log to file")] = False,
+    log_to_file: Annotated[Optional[bool], Option(help="Log to file")] = True,
+    enable_json_logging: Annotated[
+        Optional[bool], Option(help="Enable JSON logs")
+    ] = False,
 ):
-    if not list_tools:
-        log.configure(enable_json_logging=True, to_file=True)
-    else:
-        log.configure(enable_json_logging=True, to_file=log_to_file)
-        log.set_level("DEBUG")
+    log.configure(enable_json_logging=enable_json_logging, to_file=log_to_file)
+    log.set_level("DEBUG")
 
     if mode is not None:
         mode = [tools.ToolType[m.upper()] for m in mode]
@@ -205,6 +205,7 @@ def show_default_config(
                         )
                     )
                 )
+            pp(f"Default log file: {log.get_log_file()!s}")
         case ConfigTypes.claude:
             cc = get_claude_config_path()
             pp(f"Default config file: '{cc!s}' (exists = {cc.exists()!s})")