@codesys/mcp-toolkit 1.1.4 → 1.2.1

package/dist/scripts/set_pou_code.py

@@ -0,0 +1,104 @@
+import sys, scriptengine as script_engine, os, traceback
+
+# Import ensure_project_open function from the template
+# This will be prepended by the script loader
+def ensure_project_open(target_project_path):
+    # Function implementation will be included from ensure_project_open.py
+    pass
+
+# Import find_object_by_path function from the template
+# This will be prepended by the script loader
+def find_object_by_path_robust(start_node, full_path, target_type_name="object"):
+    # Function implementation will be included from find_object_by_path.py
+    pass
+
+POU_FULL_PATH = "{POU_FULL_PATH}" # Expecting format like "Application/MyPOU" or "Folder/SubFolder/MyPOU"
+DECLARATION_CONTENT = """{DECLARATION_CONTENT}"""
+IMPLEMENTATION_CONTENT = """{IMPLEMENTATION_CONTENT}"""
+
+try:
+    print("DEBUG: set_pou_code script: POU_FULL_PATH='%s', Project='%s'" % (POU_FULL_PATH, PROJECT_FILE_PATH))
+    primary_project = ensure_project_open(PROJECT_FILE_PATH)
+    if not POU_FULL_PATH: raise ValueError("POU full path empty.")
+
+    # Find the target POU/Method/Property object
+    target_object = find_object_by_path_robust(primary_project, POU_FULL_PATH, "target object")
+    if not target_object: raise ValueError("Target object not found using path: %s" % POU_FULL_PATH)
+
+    target_name = getattr(target_object, 'get_name', lambda: POU_FULL_PATH)()
+    print("DEBUG: Found target object: %s" % target_name)
+
+    # --- Set Declaration Part ---
+    declaration_updated = False
+    # Check if the content is actually provided (might be None/empty if only impl is set)
+    has_declaration_content = 'DECLARATION_CONTENT' in locals() or 'DECLARATION_CONTENT' in globals()
+    if has_declaration_content and DECLARATION_CONTENT is not None: # Check not None
+        if hasattr(target_object, 'textual_declaration'):
+            decl_obj = target_object.textual_declaration
+            if decl_obj and hasattr(decl_obj, 'replace'):
+                try:
+                    print("DEBUG: Accessing textual_declaration...")
+                    decl_obj.replace(DECLARATION_CONTENT)
+                    print("DEBUG: Set declaration text using replace().")
+                    declaration_updated = True
+                except Exception as decl_err:
+                    print("ERROR: Failed to set declaration text: %s" % decl_err)
+                    traceback.print_exc() # Print stack trace for detailed error
+            else:
+                 print("WARN: Target '%s' textual_declaration attribute is None or does not have replace(). Skipping declaration update." % target_name)
+        else:
+            print("WARN: Target '%s' does not have textual_declaration attribute. Skipping declaration update." % target_name)
+    else:
+         print("DEBUG: Declaration content not provided or is None. Skipping declaration update.")
+
+
+    # --- Set Implementation Part ---
+    implementation_updated = False
+    has_implementation_content = 'IMPLEMENTATION_CONTENT' in locals() or 'IMPLEMENTATION_CONTENT' in globals()
+    if has_implementation_content and IMPLEMENTATION_CONTENT is not None: # Check not None
+        if hasattr(target_object, 'textual_implementation'):
+            impl_obj = target_object.textual_implementation
+            if impl_obj and hasattr(impl_obj, 'replace'):
+                try:
+                    print("DEBUG: Accessing textual_implementation...")
+                    impl_obj.replace(IMPLEMENTATION_CONTENT)
+                    print("DEBUG: Set implementation text using replace().")
+                    implementation_updated = True
+                except Exception as impl_err:
+                     print("ERROR: Failed to set implementation text: %s" % impl_err)
+                     traceback.print_exc() # Print stack trace for detailed error
+            else:
+                 print("WARN: Target '%s' textual_implementation attribute is None or does not have replace(). Skipping implementation update." % target_name)
+        else:
+            print("WARN: Target '%s' does not have textual_implementation attribute. Skipping implementation update." % target_name)
+    else:
+        print("DEBUG: Implementation content not provided or is None. Skipping implementation update.")
+
+
+    # --- SAVE THE PROJECT TO PERSIST THE CODE CHANGE ---
+    # Only save if something was actually updated to avoid unnecessary saves
+    if declaration_updated or implementation_updated:
+        try:
+            print("DEBUG: Saving Project (after code change)...")
+            primary_project.save() # Save the overall project file
+            print("DEBUG: Project saved successfully after code change.")
+        except Exception as save_err:
+            print("ERROR: Failed to save Project after setting code: %s" % save_err)
+            detailed_error = traceback.format_exc()
+            error_message = "Error saving Project after code change for '%s': %s\\n%s" % (target_name, save_err, detailed_error)
+            print(error_message); print("SCRIPT_ERROR: %s" % error_message); sys.exit(1)
+    else:
+         print("DEBUG: No code parts were updated, skipping project save.")
+    # --- END SAVING ---
+
+    print("Code Set For: %s" % target_name)
+    print("Path: %s" % POU_FULL_PATH)
+    print("SCRIPT_SUCCESS: Declaration and/or implementation set successfully.")
+    sys.exit(0)
+
+except Exception as e:
+    detailed_error = traceback.format_exc()
+    error_message = "Error setting code for object '%s' in project '%s': %s\\n%s" % (POU_FULL_PATH, PROJECT_FILE_PATH, e, detailed_error)
+    print(error_message)
+    print("SCRIPT_ERROR: %s" % error_message)
+    sys.exit(1)

package/dist/server.js

@@ -67,6 +67,7 @@ const codesys_interop_1 = require("./codesys_interop");
 const path = __importStar(require("path"));
 const promises_1 = require("fs/promises");
 const scriptLoader_1 = require("./scriptLoader");
+const sessionManager_1 = require("./sessionManager");
 // --- Wrap server logic in an exported function ---
 function startMcpServer(config) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -113,6 +114,10 @@ function startMcpServer(config) {
             });
         }
         // --- End Helper Function ---
+        // --- Initialize Session Manager ---
+        const sessionManager = new sessionManager_1.CodesysSessionManager(codesysExePath, codesysProfileName);
+        console.error('SERVER.TS: Session manager initialized');
+        // --- End Session Manager Initialization ---
         // --- Preload script templates ---
         try {
             yield (0, scriptLoader_1.preloadAllScriptTemplates)();
@@ -145,7 +150,7 @@ function startMcpServer(config) {
             console.error(`SERVER.TS Resource request: ${uri.href}`);
             try {
                 const scriptContent = yield (0, scriptLoader_1.loadScriptTemplate)('check_status');
-                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName);
+                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName, sessionManager);
                 const outputLines = result.output.split(/[\r\n]+/).filter(line => line.trim());
                 const statusData = {};
                 outputLines.forEach(line => {
@@ -191,7 +196,7 @@ function startMcpServer(config) {
                 const scriptContent = (0, scriptLoader_1.interpolateScript)(combinedScript, {
                     'PROJECT_FILE_PATH': absoluteProjPath.replace(/\\/g, '\\\\')
                 });
-                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName);
+                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName, sessionManager);
                 let structureText = `Error retrieving structure for ${absoluteProjPath}.\n\n${result.output}`;
                 let isError = !result.success;
                 if (result.success && result.output.includes("SCRIPT_SUCCESS")) {
@@ -248,7 +253,7 @@ function startMcpServer(config) {
                     'PROJECT_FILE_PATH': absoluteProjPath.replace(/\\/g, '\\\\'),
                     'POU_FULL_PATH': sanitizedPouPath
                 });
-                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName);
+                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName, sessionManager);
                 let codeText = `Error retrieving code for object '${sanitizedPouPath}' in project '${absoluteProjPath}'.\n\n${result.output}`;
                 let isError = !result.success;
                 if (result.success && result.output.includes("SCRIPT_SUCCESS")) {
@@ -303,7 +308,7 @@ function startMcpServer(config) {
                 const scriptContent = (0, scriptLoader_1.interpolateScript)(combinedScript, {
                     'PROJECT_FILE_PATH': absPath.replace(/\\/g, '\\\\')
                 });
-                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName);
+                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName, sessionManager);
                 const success = result.success && result.output.includes("SCRIPT_SUCCESS");
                 return {
                     content: [{
@@ -372,7 +377,7 @@ function startMcpServer(config) {
                     'TEMPLATE_PROJECT_PATH': templatePath.replace(/\\/g, '\\\\')
                 });
                 console.error(">>> create_project (copy-then-open): PREPARED SCRIPT:", scriptContent.substring(0, 500) + "...");
-                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName);
+                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName, sessionManager);
                 console.error(">>> create_project (copy-then-open): EXECUTION RESULT:", JSON.stringify(result));
                 const success = result.success && result.output.includes("SCRIPT_SUCCESS");
                 return {
@@ -405,7 +410,7 @@ function startMcpServer(config) {
                 const scriptContent = (0, scriptLoader_1.interpolateScript)(combinedScript, {
                     'PROJECT_FILE_PATH': absPath.replace(/\\/g, '\\\\')
                 });
-                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName);
+                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName, sessionManager);
                 const success = result.success && result.output.includes("SCRIPT_SUCCESS");
                 return {
                     content: [{
@@ -449,7 +454,7 @@ function startMcpServer(config) {
                     'PARENT_PATH': sanParentPath
                 });
                 console.error(">>> create_pou: PREPARED SCRIPT:", scriptContent.substring(0, 500) + "...");
-                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName);
+                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName, sessionManager);
                 console.error(">>> create_pou: EXECUTION RESULT:", JSON.stringify(result));
                 const success = result.success && result.output.includes("SCRIPT_SUCCESS");
                 return {
@@ -500,7 +505,7 @@ function startMcpServer(config) {
                     'IMPLEMENTATION_CONTENT': sanImplCode
                 });
                 console.error(">>> set_pou_code: PREPARED SCRIPT:", scriptContent.substring(0, 500) + "...");
-                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName);
+                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName, sessionManager);
                 console.error(">>> set_pou_code: EXECUTION RESULT:", JSON.stringify(result));
                 const success = result.success && result.output.includes("SCRIPT_SUCCESS");
                 return {
@@ -550,7 +555,7 @@ function startMcpServer(config) {
                     'PROPERTY_TYPE': sanPropType
                 });
                 console.error(">>> create_property: PREPARED SCRIPT:", scriptContent.substring(0, 500) + "...");
-                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName);
+                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName, sessionManager);
                 console.error(">>> create_property: EXECUTION RESULT:", JSON.stringify(result));
                 const success = result.success && result.output.includes("SCRIPT_SUCCESS");
                 return {
@@ -600,7 +605,7 @@ function startMcpServer(config) {
                     'RETURN_TYPE': sanReturnType
                 });
                 console.error(">>> create_method: PREPARED SCRIPT:", scriptContent.substring(0, 500) + "...");
-                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName);
+                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName, sessionManager);
                 console.error(">>> create_method: EXECUTION RESULT:", JSON.stringify(result));
                 const success = result.success && result.output.includes("SCRIPT_SUCCESS");
                 return {
@@ -633,7 +638,7 @@ function startMcpServer(config) {
                 const scriptContent = (0, scriptLoader_1.interpolateScript)(combinedScript, {
                     'PROJECT_FILE_PATH': absPath.replace(/\\/g, '\\\\')
                 });
-                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName);
+                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName, sessionManager);
                 const success = result.success && result.output.includes("SCRIPT_SUCCESS");
                 // Check for actual compile errors in the output log
                 const hasCompileErrors = result.output.includes("Compile complete --") && !/ 0 error\(s\),/.test(result.output);
@@ -658,6 +663,114 @@ function startMcpServer(config) {
                 };
             }
         }));
+        // --- Session Management Tools ---
+        server.tool("start_session", "Starts a persistent CODESYS session for improved performance with multiple operations", {}, () => __awaiter(this, void 0, void 0, function* () {
+            console.error("Tool call: start_session");
+            try {
+                const currentState = sessionManager.getState();
+                if (currentState === sessionManager_1.SessionState.RUNNING || currentState === sessionManager_1.SessionState.BUSY) {
+                    return {
+                        content: [{
+                                type: "text",
+                                text: "CODESYS session is already running"
+                            }],
+                        isError: false
+                    };
+                }
+                if (currentState === sessionManager_1.SessionState.STARTING) {
+                    return {
+                        content: [{
+                                type: "text",
+                                text: "CODESYS session is already starting"
+                            }],
+                        isError: false
+                    };
+                }
+                yield sessionManager.startSession();
+                return {
+                    content: [{
+                            type: "text",
+                            text: "CODESYS session started successfully"
+                        }],
+                    isError: false
+                };
+            }
+            catch (error) {
+                console.error(`Error starting session: ${error.message}`);
+                return {
+                    content: [{
+                            type: "text",
+                            text: `Failed to start CODESYS session: ${error.message}`
+                        }],
+                    isError: true
+                };
+            }
+        }));
+        server.tool("stop_session", "Stops the persistent CODESYS session", {}, () => __awaiter(this, void 0, void 0, function* () {
+            console.error("Tool call: stop_session");
+            try {
+                const currentState = sessionManager.getState();
+                if (currentState === sessionManager_1.SessionState.STOPPED) {
+                    return {
+                        content: [{
+                                type: "text",
+                                text: "CODESYS session is already stopped"
+                            }],
+                        isError: false
+                    };
+                }
+                if (currentState === sessionManager_1.SessionState.STOPPING) {
+                    return {
+                        content: [{
+                                type: "text",
+                                text: "CODESYS session is already stopping"
+                            }],
+                        isError: false
+                    };
+                }
+                yield sessionManager.stopSession();
+                return {
+                    content: [{
+                            type: "text",
+                            text: "CODESYS session stopped successfully"
+                        }],
+                    isError: false
+                };
+            }
+            catch (error) {
+                console.error(`Error stopping session: ${error.message}`);
+                return {
+                    content: [{
+                            type: "text",
+                            text: `Failed to stop CODESYS session: ${error.message}`
+                        }],
+                    isError: true
+                };
+            }
+        }));
+        server.tool("session_status", "Returns the status of the CODESYS session", {}, () => __awaiter(this, void 0, void 0, function* () {
+            console.error("Tool call: session_status");
+            try {
+                const state = sessionManager.getState();
+                return {
+                    content: [{
+                            type: "text",
+                            text: `CODESYS session status: ${state}`
+                        }],
+                    isError: false
+                };
+            }
+            catch (error) {
+                console.error(`Error getting session status: ${error.message}`);
+                return {
+                    content: [{
+                            type: "text",
+                            text: `Failed to get CODESYS session status: ${error.message}`
+                        }],
+                    isError: true
+                };
+            }
+        }));
         // --- End Tools ---
         console.error("SERVER.TS: Resources and Tools defined.");
         // --- End MCP Resources / Tools Definitions ---