@codesys/mcp-toolkit 1.1.11 → 1.1.13

package/CHANGELOG.md

@@ -5,6 +5,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.13] - 2025-05-06
+
+### Fixed
+- Fixed remaining f-string formatting in create_pou.py script
+- Restored compatibility with older Python versions in path formatting
+
+## [1.1.12] - 2025-05-06
+
+### Fixed
+- Completely rewrote path handling to avoid excessive backslash escaping
+- Added multiple fallback methods for opening CODESYS projects
+- Removed use of non-existent get_version_info API
+- Made project structure tool more resilient to various CODESYS API patterns
+
 ## [1.1.11] - 2025-05-06
 
 ### Fixed

package/dist/scripts/create_pou.py

@@ -40,22 +40,22 @@ try:
         # Get project name from file path to build the likely full path
         project_name = os.path.splitext(os.path.basename(PROJECT_FILE_PATH))[0]
         potential_paths = [
-            PARENT_PATH_REL,                      # Original "Application"
-            f"{project_name}.{PARENT_PATH_REL}",  # "projectName.Application"
-            f"{project_name}/{PARENT_PATH_REL}",  # "projectName/Application"
-            f"{project_name}"                     # Just the project name itself might work
+            PARENT_PATH_REL,                                      # Original "Application"
+            "%s.%s" % (project_name, PARENT_PATH_REL),           # "projectName.Application"
+            "%s/%s" % (project_name, PARENT_PATH_REL),           # "projectName/Application"
+            project_name                                         # Just the project name itself might work
         ]
         
-        print(f"DEBUG: Parent path is simply 'Application', trying several variants to find it")
+        print("DEBUG: Parent path is simply 'Application', trying several variants to find it")
         
         # Try each potential path until one works
         parent_object = None
         for path in potential_paths:
-            print(f"DEBUG: Attempting to find parent with path: '{path}'")
+            print("DEBUG: Attempting to find parent with path: '%s'" % path)
             parent_candidate = find_object_by_path_robust(primary_project, path, "parent container")
             if parent_candidate:
                 parent_object = parent_candidate
-                print(f"DEBUG: Successfully found parent using path: '{path}'")
+                print("DEBUG: Successfully found parent using path: '%s'" % path)
                 break
                 
         if not parent_object:
@@ -66,14 +66,14 @@ try:
                     app = primary_project.active_application
                     if app:
                         parent_object = app
-                        print(f"DEBUG: Found application object directly: {app.get_name()}")
+                        print("DEBUG: Found application object directly: %s" % app.get_name())
                 if not parent_object and hasattr(primary_project, 'find'):
                     apps = primary_project.find("Application", True)
                     if apps:
                         parent_object = apps[0]
-                        print(f"DEBUG: Found application via search: {parent_object.get_name()}")
+                        print("DEBUG: Found application via search: %s" % parent_object.get_name())
             except Exception as e:
-                print(f"ERROR: Direct application access also failed: {e}")
+                print("ERROR: Direct application access also failed: %s" % e)
     else:
         # Use the provided path normally
         parent_object = find_object_by_path_robust(primary_project, PARENT_PATH_REL, "parent container")

package/dist/scripts/ensure_project_open.py

@@ -8,31 +8,22 @@ import traceback
 MAX_RETRIES = 3
 RETRY_DELAY = 2.0 # seconds (use float for time.sleep)
 
-# Special handling for Windows paths
-def sanitize_windows_path(path_str):
-    """Properly sanitize Windows paths for CODESYS scripting"""
-    # If it's already a Python raw string literal, return it as is
-    if path_str.startswith('r"') or path_str.startswith("r'"):
-        return path_str
-        
-    # Make Windows paths with backslashes work correctly when passed to CODESYS
-    # We use actual backslashes (which will be doubled by Python raw string)
-    sanitized = path_str.replace('\\', '\\\\')
-    
-    # Clean up any extraneous quotes
-    sanitized = sanitized.strip('"\'')
-    
-    print("DEBUG: Sanitized path from '%s' to '%s'" % (path_str, sanitized))
-    return sanitized
+# Basic path cleanup without excessive escaping
+def clean_path(path_str):
+    """Clean up a path for CODESYS scripting without excessive escaping"""
+    # Simply remove any extraneous quotes
+    cleaned = path_str.strip('"\'')
+    print("DEBUG: Cleaned path: '%s'" % cleaned)
+    return cleaned
 
 def ensure_project_open(target_project_path):
     print("DEBUG: Ensuring project is open: %s" % target_project_path)
     
-    # First sanitize the path for proper Windows path handling
-    sanitized_path = sanitize_windows_path(target_project_path)
+    # Just clean the path without adding escapes
+    path_to_use = clean_path(target_project_path)
     
     # Normalize target path once
-    normalized_target_path = os.path.normcase(os.path.abspath(sanitized_path))
+    normalized_target_path = path_to_use
 
     for attempt in range(MAX_RETRIES):
         print("DEBUG: Ensure project attempt %d/%d for %s" % (attempt + 1, MAX_RETRIES, normalized_target_path))

package/dist/scripts/get_project_structure.py

@@ -6,6 +6,72 @@ def ensure_project_open(target_project_path):
     # Function implementation will be included from ensure_project_open.py
     pass
 
+# Simpler version that directly uses script_engine.projects.open
+def direct_project_open(project_path):
+    print("DEBUG: Attempting to open project directly: %s" % project_path)
+    try:
+        # Clean up any double backslashes
+        clean_path = project_path.replace('\\\\', '\\').strip('"\'')
+        print("DEBUG: Using path: %s" % clean_path)
+        
+        # First check if the project is already open
+        try:
+            current = script_engine.get_current_project()
+            if current and hasattr(current, 'get_path'):
+                current_path = current.get_path()
+                if current_path == clean_path:
+                    print("DEBUG: Project already open: %s" % clean_path)
+                    return current
+                else:
+                    print("DEBUG: Different project open. Closing: %s" % current_path)
+                    script_engine.close_project()
+        except Exception as e:
+            print("DEBUG: Error checking current project: %s" % e)
+        
+        # Try to open the project
+        try:
+            # Try different ways of opening the project
+            print("DEBUG: Trying script_engine.open_project")
+            project = script_engine.open_project(clean_path)
+            if project:
+                print("DEBUG: Project opened successfully with open_project")
+                return project
+        except Exception as e:
+            print("DEBUG: Error with open_project: %s" % e)
+            
+        # Try alternative method
+        try:
+            print("DEBUG: Trying script_engine.projects.open")
+            project = script_engine.projects.open(clean_path)
+            if project:
+                print("DEBUG: Project opened successfully with projects.open")
+                return project
+        except Exception as e:
+            print("DEBUG: Error with projects.open: %s" % e)
+            
+        # One more attempt if available
+        try:
+            print("DEBUG: Trying primary project access")
+            project = script_engine.projects.primary
+            if project:
+                print("DEBUG: Got primary project")
+                if hasattr(project, 'get_path'):
+                    path = project.get_path()
+                    print("DEBUG: Primary project path: %s" % path)
+                    if path == clean_path:
+                        return project
+                return project  # Return anyway as fallback
+        except Exception as e:
+            print("DEBUG: Error getting primary project: %s" % e)
+            
+        print("DEBUG: All attempts to open project failed")
+        return None
+            
+    except Exception as e:
+        print("DEBUG: Unexpected error in direct_project_open: %s" % e)
+        traceback.print_exc()
+        return None
+
 def get_object_structure(obj, indent=0, max_depth=10): # Add max_depth
     lines = []; indent_str = "  " * indent
     if obj is None:
@@ -55,37 +121,33 @@ def get_object_structure(obj, indent=0, max_depth=10): # Add max_depth
         traceback.print_exc() # Print detailed error for this node
     return lines
 
-# Normalize Windows paths for CODESYS scripting
-def normalize_path(path_str):
-    # Replace backslashes with double backslashes for Python string in CODESYS
-    normalized = path_str.replace('\\', '\\\\')
-    # Remove any quotes that might be present
-    normalized = normalized.strip('"\'')
-    print("DEBUG: Normalized path from '%s' to '%s'" % (path_str, normalized))
-    return normalized
+# Simple path cleanup function - CODESYS doesn't need double-escaped paths
+def clean_path(path_str):
+    # Just remove any quotes that might be present
+    cleaned = path_str.strip('"\'')
+    print("DEBUG: Cleaned path: '%s'" % cleaned)
+    return cleaned
     
 try:
-    # Normalize the project path for CODESYS
-    normalized_path = normalize_path(PROJECT_FILE_PATH)
-    print("DEBUG: Getting structure for project path: '%s'" % normalized_path)
+    # Just use the path directly without escaping
+    project_path = PROJECT_FILE_PATH.strip('"\'')
+    print("DEBUG: Getting structure for project: '%s'" % project_path)
     
-    # First confirm that CODESYS is running properly
-    print("DEBUG: CODESYS version info:")
-    try:
-        version_info = script_engine.get_version_info()
-        print("DEBUG: CODESYS Version: %s" % version_info)
-    except Exception as v_err:
-        print("DEBUG: Error getting CODESYS version: %s" % v_err)
+    print("DEBUG: Opening project directly...")
+    # Try our direct method first
+    primary_project = direct_project_open(project_path)
     
-    print("DEBUG: Opening project...")
-    primary_project = ensure_project_open(normalized_path)
+    # If that fails, try the standard method
+    if not primary_project:
+        print("DEBUG: Direct open failed, trying ensure_project_open...")
+        primary_project = ensure_project_open(project_path)
     
     if primary_project is None:
         print("DEBUG: ERROR - Project object is None after ensure_project_open")
-        raise ValueError("Failed to open project: %s - project object is None" % normalized_path)
+        raise ValueError("Failed to open project: %s - project object is None" % project_path)
         
     print("DEBUG: Project object type: %s" % type(primary_project).__name__)
-    project_name = os.path.basename(normalized_path)
+    project_name = os.path.basename(project_path)
     
     if hasattr(primary_project, 'get_name'):
         print("DEBUG: Project name from object: %s" % primary_project.get_name())

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codesys/mcp-toolkit",
-  "version": "1.1.11",
+  "version": "1.1.13",
   "description": "Model Context Protocol (MCP) server for CODESYS automation platform",
   "main": "dist/server.js",
   "bin": {

package/src/scripts/create_pou.py

@@ -40,22 +40,22 @@ try:
         # Get project name from file path to build the likely full path
         project_name = os.path.splitext(os.path.basename(PROJECT_FILE_PATH))[0]
         potential_paths = [
-            PARENT_PATH_REL,                      # Original "Application"
-            f"{project_name}.{PARENT_PATH_REL}",  # "projectName.Application"
-            f"{project_name}/{PARENT_PATH_REL}",  # "projectName/Application"
-            f"{project_name}"                     # Just the project name itself might work
+            PARENT_PATH_REL,                                      # Original "Application"
+            "%s.%s" % (project_name, PARENT_PATH_REL),           # "projectName.Application"
+            "%s/%s" % (project_name, PARENT_PATH_REL),           # "projectName/Application"
+            project_name                                         # Just the project name itself might work
         ]
         
-        print(f"DEBUG: Parent path is simply 'Application', trying several variants to find it")
+        print("DEBUG: Parent path is simply 'Application', trying several variants to find it")
         
         # Try each potential path until one works
         parent_object = None
         for path in potential_paths:
-            print(f"DEBUG: Attempting to find parent with path: '{path}'")
+            print("DEBUG: Attempting to find parent with path: '%s'" % path)
             parent_candidate = find_object_by_path_robust(primary_project, path, "parent container")
             if parent_candidate:
                 parent_object = parent_candidate
-                print(f"DEBUG: Successfully found parent using path: '{path}'")
+                print("DEBUG: Successfully found parent using path: '%s'" % path)
                 break
                 
         if not parent_object:
@@ -66,14 +66,14 @@ try:
                     app = primary_project.active_application
                     if app:
                         parent_object = app
-                        print(f"DEBUG: Found application object directly: {app.get_name()}")
+                        print("DEBUG: Found application object directly: %s" % app.get_name())
                 if not parent_object and hasattr(primary_project, 'find'):
                     apps = primary_project.find("Application", True)
                     if apps:
                         parent_object = apps[0]
-                        print(f"DEBUG: Found application via search: {parent_object.get_name()}")
+                        print("DEBUG: Found application via search: %s" % parent_object.get_name())
             except Exception as e:
-                print(f"ERROR: Direct application access also failed: {e}")
+                print("ERROR: Direct application access also failed: %s" % e)
     else:
         # Use the provided path normally
         parent_object = find_object_by_path_robust(primary_project, PARENT_PATH_REL, "parent container")

package/src/scripts/ensure_project_open.py

@@ -8,31 +8,22 @@ import traceback
 MAX_RETRIES = 3
 RETRY_DELAY = 2.0 # seconds (use float for time.sleep)
 
-# Special handling for Windows paths
-def sanitize_windows_path(path_str):
-    """Properly sanitize Windows paths for CODESYS scripting"""
-    # If it's already a Python raw string literal, return it as is
-    if path_str.startswith('r"') or path_str.startswith("r'"):
-        return path_str
-        
-    # Make Windows paths with backslashes work correctly when passed to CODESYS
-    # We use actual backslashes (which will be doubled by Python raw string)
-    sanitized = path_str.replace('\\', '\\\\')
-    
-    # Clean up any extraneous quotes
-    sanitized = sanitized.strip('"\'')
-    
-    print("DEBUG: Sanitized path from '%s' to '%s'" % (path_str, sanitized))
-    return sanitized
+# Basic path cleanup without excessive escaping
+def clean_path(path_str):
+    """Clean up a path for CODESYS scripting without excessive escaping"""
+    # Simply remove any extraneous quotes
+    cleaned = path_str.strip('"\'')
+    print("DEBUG: Cleaned path: '%s'" % cleaned)
+    return cleaned
 
 def ensure_project_open(target_project_path):
     print("DEBUG: Ensuring project is open: %s" % target_project_path)
     
-    # First sanitize the path for proper Windows path handling
-    sanitized_path = sanitize_windows_path(target_project_path)
+    # Just clean the path without adding escapes
+    path_to_use = clean_path(target_project_path)
     
     # Normalize target path once
-    normalized_target_path = os.path.normcase(os.path.abspath(sanitized_path))
+    normalized_target_path = path_to_use
 
     for attempt in range(MAX_RETRIES):
         print("DEBUG: Ensure project attempt %d/%d for %s" % (attempt + 1, MAX_RETRIES, normalized_target_path))

package/src/scripts/get_project_structure.py

@@ -6,6 +6,72 @@ def ensure_project_open(target_project_path):
     # Function implementation will be included from ensure_project_open.py
     pass
 
+# Simpler version that directly uses script_engine.projects.open
+def direct_project_open(project_path):
+    print("DEBUG: Attempting to open project directly: %s" % project_path)
+    try:
+        # Clean up any double backslashes
+        clean_path = project_path.replace('\\\\', '\\').strip('"\'')
+        print("DEBUG: Using path: %s" % clean_path)
+        
+        # First check if the project is already open
+        try:
+            current = script_engine.get_current_project()
+            if current and hasattr(current, 'get_path'):
+                current_path = current.get_path()
+                if current_path == clean_path:
+                    print("DEBUG: Project already open: %s" % clean_path)
+                    return current
+                else:
+                    print("DEBUG: Different project open. Closing: %s" % current_path)
+                    script_engine.close_project()
+        except Exception as e:
+            print("DEBUG: Error checking current project: %s" % e)
+        
+        # Try to open the project
+        try:
+            # Try different ways of opening the project
+            print("DEBUG: Trying script_engine.open_project")
+            project = script_engine.open_project(clean_path)
+            if project:
+                print("DEBUG: Project opened successfully with open_project")
+                return project
+        except Exception as e:
+            print("DEBUG: Error with open_project: %s" % e)
+            
+        # Try alternative method
+        try:
+            print("DEBUG: Trying script_engine.projects.open")
+            project = script_engine.projects.open(clean_path)
+            if project:
+                print("DEBUG: Project opened successfully with projects.open")
+                return project
+        except Exception as e:
+            print("DEBUG: Error with projects.open: %s" % e)
+            
+        # One more attempt if available
+        try:
+            print("DEBUG: Trying primary project access")
+            project = script_engine.projects.primary
+            if project:
+                print("DEBUG: Got primary project")
+                if hasattr(project, 'get_path'):
+                    path = project.get_path()
+                    print("DEBUG: Primary project path: %s" % path)
+                    if path == clean_path:
+                        return project
+                return project  # Return anyway as fallback
+        except Exception as e:
+            print("DEBUG: Error getting primary project: %s" % e)
+            
+        print("DEBUG: All attempts to open project failed")
+        return None
+            
+    except Exception as e:
+        print("DEBUG: Unexpected error in direct_project_open: %s" % e)
+        traceback.print_exc()
+        return None
+
 def get_object_structure(obj, indent=0, max_depth=10): # Add max_depth
     lines = []; indent_str = "  " * indent
     if obj is None:
@@ -55,37 +121,33 @@ def get_object_structure(obj, indent=0, max_depth=10): # Add max_depth
         traceback.print_exc() # Print detailed error for this node
     return lines
 
-# Normalize Windows paths for CODESYS scripting
-def normalize_path(path_str):
-    # Replace backslashes with double backslashes for Python string in CODESYS
-    normalized = path_str.replace('\\', '\\\\')
-    # Remove any quotes that might be present
-    normalized = normalized.strip('"\'')
-    print("DEBUG: Normalized path from '%s' to '%s'" % (path_str, normalized))
-    return normalized
+# Simple path cleanup function - CODESYS doesn't need double-escaped paths
+def clean_path(path_str):
+    # Just remove any quotes that might be present
+    cleaned = path_str.strip('"\'')
+    print("DEBUG: Cleaned path: '%s'" % cleaned)
+    return cleaned
     
 try:
-    # Normalize the project path for CODESYS
-    normalized_path = normalize_path(PROJECT_FILE_PATH)
-    print("DEBUG: Getting structure for project path: '%s'" % normalized_path)
+    # Just use the path directly without escaping
+    project_path = PROJECT_FILE_PATH.strip('"\'')
+    print("DEBUG: Getting structure for project: '%s'" % project_path)
     
-    # First confirm that CODESYS is running properly
-    print("DEBUG: CODESYS version info:")
-    try:
-        version_info = script_engine.get_version_info()
-        print("DEBUG: CODESYS Version: %s" % version_info)
-    except Exception as v_err:
-        print("DEBUG: Error getting CODESYS version: %s" % v_err)
+    print("DEBUG: Opening project directly...")
+    # Try our direct method first
+    primary_project = direct_project_open(project_path)
     
-    print("DEBUG: Opening project...")
-    primary_project = ensure_project_open(normalized_path)
+    # If that fails, try the standard method
+    if not primary_project:
+        print("DEBUG: Direct open failed, trying ensure_project_open...")
+        primary_project = ensure_project_open(project_path)
     
     if primary_project is None:
         print("DEBUG: ERROR - Project object is None after ensure_project_open")
-        raise ValueError("Failed to open project: %s - project object is None" % normalized_path)
+        raise ValueError("Failed to open project: %s - project object is None" % project_path)
         
     print("DEBUG: Project object type: %s" % type(primary_project).__name__)
-    project_name = os.path.basename(normalized_path)
+    project_name = os.path.basename(project_path)
     
     if hasattr(primary_project, 'get_name'):
         print("DEBUG: Project name from object: %s" % primary_project.get_name())