add a debug setting and rename to tools for clarity

Author: garrmark

README.md

@@ -6,10 +6,12 @@ An [MCP Server](https://modelcontextprotocol.io/introduction) to utilize Codelog
 
 ### Tools
 
-The server implements one tool:
+The server implements two tools:
 
-- get-impact: Pulls an impact assessment from the codelogic server's API's for your code
-  - Takes the given "method" that you're working on and it's associated "class"
+- **codelogic-method-impact**: Pulls an impact assessment from the CodeLogic server's APIs for your code.
+  - Takes the given "method" that you're working on and its associated "class".
+- **codelogic-database-impact**: Analyzes impacts between code and database entities.
+  - Takes the database entity type (column, table, or view) and its name.
 
 ### Install
 
@@ -67,16 +69,38 @@ Add the following configuration to your file:
 }
 ```
 
-Add a **global rule** to help windsurf call the tool, create or modify the `~/.codeium/windsurf/memories/global_rules.md` markdown file.
+Add a **global rule** to help Windsurf call the tools, create or modify the `~/.codeium/windsurf/memories/global_rules.md` markdown file.
 
 Add the following or something similar:
 
 ```markdown
-When I ask you to modify existing code, try running the get-impact mcp tool against the code I've provided and any methods or functions that you are changing.  Make sure the results sent back from the tool are highlighted as impacts for the given method or function.
+When I ask you to modify existing code, try running the codelogic-method-impact and codelogic-database-impact MCP tools against the code I've provided and any methods or functions that you are changing. Make sure the results sent back from the tool are highlighted as impacts for the given method or function.
 ```
 
 After adding the configuration, restart Windsurf IDE or refresh the tools to apply the changes.
 
+### Environment Variables
+
+The following environment variables can be configured to customize the behavior of the server:
+
+- `CODELOGIC_SERVER_HOST`: The URL of the CodeLogic server.
+- `CODELOGIC_USERNAME`: Your CodeLogic username.
+- `CODELOGIC_PASSWORD`: Your CodeLogic password.
+- `CODELOGIC_MV_NAME`: The name of the materialized view to use.
+- `CODELOGIC_DEBUG_MODE`: Set to `true` to enable debug mode. When enabled, additional debug files such as `timing_log.txt` and `impact_data*.json` will be generated. Defaults to `false`.
+
+#### Example Configuration
+
+```json
+"env": {
+  "CODELOGIC_SERVER_HOST": "<url to the server e.g. https://myco.app.codelogic.com>",
+  "CODELOGIC_USERNAME": "<my username>",
+  "CODELOGIC_PASSWORD": "<my password>",
+  "CODELOGIC_MV_NAME": "<my materialized view>",
+  "CODELOGIC_DEBUG_MODE": "true"
+}
+```
+
 #### Pinning the version
 
 instead of using the **latest** version of the server, you can pin to a specific version by changing the **args** field to match the version in [pypi](https://pypi.org/project/codelogic-mcp-server/) e.g.

src/codelogic_mcp_server/handlers.py

@@ -21,6 +21,8 @@
 import time
 from datetime import datetime
 
+DEBUG_MODE = os.getenv("CODELOGIC_DEBUG_MODE", "false").lower() == "true"
+
 
 @server.list_tools()
 async def handle_list_tools() -> list[types.Tool]:
@@ -30,7 +32,7 @@ async def handle_list_tools() -> list[types.Tool]:
     """
     return [
         types.Tool(
-            name="get-impact",
+            name="codelogic-method-impact",
             description="Analyze impacts of modifying a specific method within a given class or type.\n"
                         "Recommended workflow:\n"
                         "1. Use this tool before implementing code changes\n"
@@ -47,7 +49,7 @@ async def handle_list_tools() -> list[types.Tool]:
             },
         ),
         types.Tool(
-            name="database-impact",
+            name="codelogic-database-impact",
             description="Analyze impacts between code and database entities.\n"
                         "Recommended workflow:\n"
                         "1. Use this tool before implementing code or database changes\n"
@@ -80,9 +82,9 @@ async def handle_call_tool(
     Tools can modify server state and notify clients of changes.
     """
     try:
-        if name == "get-impact":
+        if name == "codelogic-method-impact":
             return await handle_method_impact(arguments)
-        elif name == "database-impact":
+        elif name == "codelogic-database-impact":
             return await handle_database_impact(arguments)
         else:
             sys.stderr.write(f"Unknown tool: {name}\n")
@@ -127,8 +129,9 @@ async def handle_method_impact(arguments: dict | None) -> list[types.TextContent
     end_time = time.time()
     duration = end_time - start_time
     timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
-    with open("timing_log.txt", "a") as log_file:
-        log_file.write(f"{timestamp} - get_method_nodes for method '{method_name}' in class '{class_name}' took {duration:.4f} seconds\n")
+    if DEBUG_MODE:
+        with open("timing_log.txt", "a") as log_file:
+            log_file.write(f"{timestamp} - get_method_nodes for method '{method_name}' in class '{class_name}' took {duration:.4f} seconds\n")
 
     # Check if nodes is empty due to timeout or server error
     if not nodes:
@@ -167,10 +170,11 @@ async def handle_method_impact(arguments: dict | None) -> list[types.TextContent
     end_time = time.time()
     duration = end_time - start_time
     timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
-    with open("timing_log.txt", "a") as log_file:
-        log_file.write(f"{timestamp} - get_impact for node '{node['name']}' took {duration:.4f} seconds\n")
-    with open("impact_data.json", "w") as impact_file:
-        json.dump(impact, impact_file, indent=4)
+    if DEBUG_MODE:
+        with open("timing_log.txt", "a") as log_file:
+            log_file.write(f"{timestamp} - get_impact for node '{node['name']}' took {duration:.4f} seconds\n")
+        with open("impact_data.json", "w") as impact_file:
+            json.dump(impact, impact_file, indent=4)
     impact_data = json.loads(impact)
     nodes = extract_nodes(impact_data)
     relationships = extract_relationships(impact_data)
@@ -527,9 +531,9 @@ async def handle_database_impact(arguments: dict | None) -> list[types.TextConte
     end_time = time.time()
     duration = end_time - start_time
     timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
-
-    with open("timing_log.txt", "a") as log_file:
-        log_file.write(f"{timestamp} - search_database_entity for {entity_type} '{name}' took {duration:.4f} seconds\n")
+    if DEBUG_MODE:
+        with open("timing_log.txt", "a") as log_file:
+            log_file.write(f"{timestamp} - search_database_entity for {entity_type} '{name}' took {duration:.4f} seconds\n")
 
     if not search_results:
         table_view_text = f" in {table_or_view}" if table_or_view else ""
@@ -555,11 +559,11 @@ async def handle_database_impact(arguments: dict | None) -> list[types.TextConte
             duration = end_time - start_time
             timestamp = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
 
-            with open("timing_log.txt", "a") as log_file:
-                log_file.write(f"{timestamp} - get_impact for {entity_type} '{entity_name}' took {duration:.4f} seconds\n")
-
-            with open(f"impact_data_{entity_type}_{entity_name}.json", "w") as impact_file:
-                json.dump(json.loads(impact), impact_file, indent=4)
+            if DEBUG_MODE:
+                with open("timing_log.txt", "a") as log_file:
+                    log_file.write(f"{timestamp} - get_impact for {entity_type} '{entity_name}' took {duration:.4f} seconds\n")
+                with open(f"impact_data_{entity_type}_{entity_name}.json", "w") as impact_file:
+                    json.dump(json.loads(impact), impact_file, indent=4)
             impact_data = json.loads(impact)
             impact_summary = process_database_entity_impact(
                 impact_data, entity_type, entity_name, entity_schema

src/codelogic_mcp_server/server.py

@@ -56,9 +56,9 @@ async def main():
                         notification_options=NotificationOptions(),
                         experimental_capabilities={},
                     ),
-                    instructions=("When asked to modify an existing code method, invoke one or both of get-impact and database-impact mcp tools against "
-                                  "the code provided and any methods that you are proposing changes to.  Make sure the results sent back from the tool are "
-                                  "highlighted as impacts for the given method."
+                    instructions=("When asked to modify an existing code method, invoke one or both of codelogic-method-impact and codelogic-database-impact "
+                                  "mcp tools against the code provided and any methods that you are proposing changes to.  Make sure the results sent back "
+                                  "from the tool are highlighted as impacts for the given method."
                                   ),
                 ),
             )

src/codelogic_mcp_server/utils.py

@@ -613,53 +613,53 @@ def extract_dependent_applications(dependent_code, impact_data):
 def find_database_applications(node_id, impact_data):
     """
     Find applications that directly or indirectly group the database entity.
-    
+
     This function traverses both direct grouping relationships and indirect
     relationships through containment chains to identify all applications
     that might be affected by changes to the database entity.
-    
+
     Args:
         node_id (str): ID of the database entity node
         impact_data (dict): Impact analysis data from the API
-        
+
     Returns:
         list: Names of applications that group this database entity
     """
     applications = []
     processed_nodes = set()  # Track processed nodes to avoid infinite recursion
-    
+
     # Find all application nodes and create lookup map
     app_nodes = {}
     for node in impact_data.get('data', {}).get('nodes', []):
         if node.get('primaryLabel') == 'Application':
             app_nodes[node.get('id')] = node.get('name')
-    
+
     # Recursive function to traverse containment and grouping relationships
     def traverse_relationships(current_id):
         if current_id in processed_nodes:
             return  # Avoid cycles
-        
+
         processed_nodes.add(current_id)
-        
+
         # Check direct grouping by applications
         for rel in impact_data.get('data', {}).get('relationships', []):
             # If an application directly groups this node
             if rel.get('type') == 'GROUPS' and rel.get('endId') == current_id and rel.get('startId') in app_nodes:
                 app_name = app_nodes[rel.get('startId')]
                 if app_name not in applications:
                     applications.append(app_name)
-            
+
             # Check relationships that refer to or contain this node
             # These can lead us to components that might be grouped by applications
             if rel.get('endId') == current_id:
                 # Follow containment and reference relationships up the chain
                 if rel.get('type').startswith('CONTAINS_') or rel.get('type') in ['REFERENCES', 'REFERENCES_TABLE']:
                     # Recursively check the parent node
                     traverse_relationships(rel.get('startId'))
-    
+
     # Start traversal from the target node
     traverse_relationships(node_id)
-    
+
     # Additional check for database-specific structures
     # Some applications might group the database or schema containing our entity
     current_node = find_node_by_id(impact_data.get('data', {}).get('nodes', []), node_id)
@@ -670,11 +670,11 @@ def traverse_relationships(current_id):
                 # This might be a schema containing our table or a table containing our column
                 container_id = rel.get('startId')
                 container_node = find_node_by_id(impact_data.get('data', {}).get('nodes', []), container_id)
-                
+
                 if container_node and container_node.get('primaryLabel') in ['Table', 'Schema', 'Database']:
                     # Recursively process this container to find applications
                     traverse_relationships(container_id)
-    
+
     return applications
 
 
@@ -706,15 +706,15 @@ def generate_combined_database_report(entity_type, search_name, table_or_view, s
     for i, impact in enumerate(all_impacts):
         entity_name = impact.get("name", "Unknown")
         entity_schema = impact.get("schema", "Unknown")
-        
+
         # Format the entity identifier differently based on entity type
         if entity_type == "column":
             parent_table = impact.get("parent_table", {})
             table_name = parent_table.get("name", "Unknown") if parent_table else "Unknown"
             entity_id = f"`{entity_schema}.{table_name}.{entity_name}`"
         else:
             entity_id = f"`{entity_schema}.{entity_name}`"
-            
+
         report += f"### {i + 1}. {entity_type.capitalize()}: {entity_id}\n\n"
 
         # For columns, show the parent table information