memory - add detailed warnings and info for config (#137)

Author: a-s-g93

servers/mcp-neo4j-memory/CHANGELOG.md

@@ -13,6 +13,7 @@
 * Add error handling to catch Neo4j specific errors and improve error responses
 * Implement `ToolError` class from FastMCP
 * Add tool annotations
+* Add clear warnings for config declaration via cli and env variables
 
 ## v0.2.0
 

servers/mcp-neo4j-memory/src/mcp_neo4j_memory/__init__.py

@@ -1,8 +1,12 @@
 from . import server
 import asyncio
 import argparse
-import os
+import logging
 
+from .utils import process_config
+
+logger = logging.getLogger("mcp_neo4j_memory")
+logger.setLevel(logging.INFO)
 
 def main():
     """Main entry point for the package."""
@@ -17,16 +21,8 @@ def main():
     parser.add_argument("--server-path", default=None, help="HTTP path (default: /mcp/)")
 
     args = parser.parse_args()
-    asyncio.run(server.main(
-        args.db_url or os.getenv("NEO4J_URL") or os.getenv("NEO4J_URI", "bolt://localhost:7687"),
-        args.username or os.getenv("NEO4J_USERNAME", "neo4j"),
-        args.password or os.getenv("NEO4J_PASSWORD", "password"),
-        args.database or os.getenv("NEO4J_DATABASE", "neo4j"),
-        args.transport or os.getenv("NEO4J_TRANSPORT", "stdio"),
-        args.server_host or os.getenv("NEO4J_MCP_SERVER_HOST", "127.0.0.1"),
-        args.server_port or int(os.getenv("NEO4J_MCP_SERVER_PORT", "8000")),
-        args.server_path or os.getenv("NEO4J_MCP_SERVER_PATH", "/mcp/"),
-    ))
+    config = process_config(args)
+    asyncio.run(server.main(**config))
 
 
 # Optionally expose other important items at package level

servers/mcp-neo4j-memory/src/mcp_neo4j_memory/utils.py

@@ -0,0 +1,132 @@
+import argparse
+import os
+import logging
+from typing import Union
+
+logger = logging.getLogger("mcp_neo4j_memory")
+logger.setLevel(logging.INFO)
+
+def process_config(args: argparse.Namespace) -> dict[str, Union[str, int, None]]:
+    """
+    Process the command line arguments and environment variables to create a config dictionary. 
+    This may then be used as input to the main server function.
+    If any value is not provided, then a warning is logged and a default value is used, if appropriate.
+
+    Parameters
+    ----------
+    args : argparse.Namespace
+        The command line arguments.
+
+    Returns
+    -------
+    config : dict[str, str]
+        The configuration dictionary.
+    """
+
+    config = dict()
+
+    # parse uri
+    if args.db_url is not None:
+        config["neo4j_uri"] = args.db_url
+    else:
+        if os.getenv("NEO4J_URL") is not None:
+            config["neo4j_uri"] = os.getenv("NEO4J_URL")
+        else:
+            if os.getenv("NEO4J_URI") is not None:
+                config["neo4j_uri"] = os.getenv("NEO4J_URI")
+            else:
+                logger.warning("Warning: No Neo4j connection URL provided. Using default: bolt://localhost:7687")
+                config["neo4j_uri"] = "bolt://localhost:7687"
+    
+    # parse username
+    if args.username is not None:
+        config["neo4j_user"] = args.username
+    else:
+        if os.getenv("NEO4J_USERNAME") is not None:
+            config["neo4j_user"] = os.getenv("NEO4J_USERNAME")
+        else:
+            logger.warning("Warning: No Neo4j username provided. Using default: neo4j")
+            config["neo4j_user"] = "neo4j"
+    
+    # parse password
+    if args.password is not None:
+        config["neo4j_password"] = args.password
+    else:
+        if os.getenv("NEO4J_PASSWORD") is not None:
+            config["neo4j_password"] = os.getenv("NEO4J_PASSWORD")
+        else:
+            logger.warning("Warning: No Neo4j password provided. Using default: password")
+            config["neo4j_password"] = "password"
+    
+    # parse database
+    if args.database is not None:
+        config["neo4j_database"] = args.database
+    else:
+        if os.getenv("NEO4J_DATABASE") is not None:
+            config["neo4j_database"] = os.getenv("NEO4J_DATABASE")
+        else:
+            logger.warning("Warning: No Neo4j database provided. Using default: neo4j")
+            config["neo4j_database"] = "neo4j"
+    
+    # parse transport
+    if args.transport is not None:
+        config["transport"] = args.transport
+    else:
+        if os.getenv("NEO4J_TRANSPORT") is not None:
+            config["transport"] = os.getenv("NEO4J_TRANSPORT")
+        else:
+            logger.warning("Warning: No transport type provided. Using default: stdio")
+            config["transport"] = "stdio"
+    
+    # parse server host
+    if args.server_host is not None:
+        if config["transport"] == "stdio":
+            logger.warning("Warning: Server host provided, but transport is `stdio`. The `server_host` argument will be set, but ignored.")
+        config["host"] = args.server_host
+    else:
+        if os.getenv("NEO4J_MCP_SERVER_HOST") is not None:
+            if config["transport"] == "stdio":
+                logger.warning("Warning: Server host provided, but transport is `stdio`. The `NEO4J_MCP_SERVER_HOST` environment variable will be set, but ignored.")
+            config["host"] = os.getenv("NEO4J_MCP_SERVER_HOST")
+        elif config["transport"] != "stdio":
+            logger.warning("Warning: No server host provided and transport is not `stdio`. Using default server host: 127.0.0.1")
+            config["host"] = "127.0.0.1"
+        else:
+            logger.info("Info: No server host provided and transport is `stdio`. `server_host` will be None.")
+            config["host"] = None
+     
+    # parse server port
+    if args.server_port is not None:
+        if config["transport"] == "stdio":
+            logger.warning("Warning: Server port provided, but transport is `stdio`. The `server_port` argument will be set, but ignored.")
+        config["port"] = args.server_port
+    else:
+        if os.getenv("NEO4J_MCP_SERVER_PORT") is not None:
+            if config["transport"] == "stdio":
+                logger.warning("Warning: Server port provided, but transport is `stdio`. The `NEO4J_MCP_SERVER_PORT` environment variable will be set, but ignored.")
+            config["port"] = int(os.getenv("NEO4J_MCP_SERVER_PORT"))
+        elif config["transport"] != "stdio":
+            logger.warning("Warning: No server port provided and transport is not `stdio`. Using default server port: 8000")
+            config["port"] = 8000
+        else:
+            logger.info("Info: No server port provided and transport is `stdio`. `server_port` will be None.")
+            config["port"] = None
+    
+    # parse server path
+    if args.server_path is not None:
+        if config["transport"] == "stdio":
+            logger.warning("Warning: Server path provided, but transport is `stdio`. The `server_path` argument will be set, but ignored.")
+        config["path"] = args.server_path
+    else:
+        if os.getenv("NEO4J_MCP_SERVER_PATH") is not None:
+            if config["transport"] == "stdio":
+                logger.warning("Warning: Server path provided, but transport is `stdio`. The `NEO4J_MCP_SERVER_PATH` environment variable will be set, but ignored.")
+            config["path"] = os.getenv("NEO4J_MCP_SERVER_PATH")
+        elif config["transport"] != "stdio":
+            logger.warning("Warning: No server path provided and transport is not `stdio`. Using default server path: /mcp/")
+            config["path"] = "/mcp/"
+        else:
+            logger.info("Info: No server path provided and transport is `stdio`. `server_path` will be None.")
+            config["path"] = None
+    
+    return config