@codesys/mcp-toolkit 1.1.0 → 1.1.3

package/README.md

@@ -132,20 +132,14 @@ When running `codesys-mcp-tool` directly or configuring it, you can use these ar
 *   **Check Logs:**
     *   Claude Desktop logs: `C:\Users\<YourUsername>\AppData\Roaming\Claude\logs\` (Windows)
 
-## 📖 Detailed OOP Workflow Guide
-*(This section seems good, keep as is)*
-... (Paste your existing OOP Workflow Guide here) ...
-
 ## 🤝 Contributing
-*(Keep as is or add details)*
-Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+Contributions, issues, and feature requests are welcome! Feel free to check the issues page. (Optionally add a CONTRIBUTING.md file with more details).
 
 ## 📝 License
-*(Keep as is)*
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License - see the LICENSE file for details.
 
 ## 🙏 Acknowledgements
-*(Keep as is)*
-- The [CODESYS](https://www.codesys.com/) team for their scripting engine
-- [Model Context Protocol](https://github.com/m-ld/model-context-protocol) project
-- All contributors who have helped improve this toolkit
+- The CODESYS GmbH team for the powerful CODESYS platform and its scripting engine.
+- The Model Context Protocol project for defining the interaction standard.
+- All contributors and users who help improve this toolkit.
+

package/dist/codesys_interop.js

@@ -55,7 +55,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executeCodesysScript = executeCodesysScript;
-const child_process_1 = require("child_process"); // Use spawn directly
+const child_process_1 = require("child_process");
 const promises_1 = require("fs/promises");
 const path = __importStar(require("path"));
 const os = __importStar(require("os"));
@@ -71,8 +71,8 @@ const SCRIPT_ERROR_MARKER = 'SCRIPT_ERROR';
  * @param codesysProfileName The name of the CODESYS profile to use for scripting.
  * @returns A promise resolving to an object containing the success status and the script's output.
  *
- * NOTE: This function uses spawn WITHOUT shell:true for robustness with Windows paths containing spaces.
- * The approach uses modified environment variables and working directory to ensure proper execution.
+ * NOTE: Using shell: true with careful command string quoting to handle
+ * CODESYS argument parsing quirks when launched non-interactively.
  */
 function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -86,37 +86,42 @@ function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName)
         // --- End Pre-checks ---
         const tempDir = os.tmpdir();
         const tempFileName = `codesys_script_${Date.now()}_${Math.random().toString(36).substring(2, 9)}.py`;
-        const tempFilePath = path.join(tempDir, tempFileName);
+        const tempFilePath = path.join(tempDir, tempFileName); // Path module uses OS-specific separators ('\' on Windows)
         let output = '';
         let stderrOutput = '';
         let success = false;
         let exitCode = null;
         const codesysDir = path.dirname(codesysExePath); // Directory containing CODESYS.exe
         try {
-            const normalizedScriptContent = scriptContent.replace(/\r\n/g, '\n');
-            yield (0, promises_1.writeFile)(tempFilePath, normalizedScriptContent, 'latin1');
+            const normalizedScriptContent = scriptContent.replace(/\r\n/g, '\n'); // Normalize line endings
+            // <<< --- ADDED SCRIPT CONTENT LOGGING --- >>>
+            process.stderr.write(`INTEROP: Script content to be written (first 500 chars):\n`);
+            process.stderr.write(`------ START SCRIPT (TEMP FILE) -----\n`);
+            process.stderr.write(`${normalizedScriptContent.substring(0, 500)}\n`); // Log the first 500 chars
+            process.stderr.write(`------ END SCRIPT SNIPPET (TEMP FILE) -----\n`);
+            // <<< --- END SCRIPT CONTENT LOGGING --- >>>
+            yield (0, promises_1.writeFile)(tempFilePath, normalizedScriptContent, 'latin1'); // Write the normalized content
             process.stderr.write(`INTEROP: Temp script written: ${tempFilePath}\n`);
-            // --- Use spawn arguments array ---
-            const command = codesysExePath;
-            const args = [
-                `--profile=${codesysProfileName}`, // Format expected by CODESYS.exe
-                // Use = for profile? Or quotes? Check CODESYS docs. Assume '=' for now.
-                // If CODESYS needs quotes around the value *itself*: `--profile="${codesysProfileName}"`
-                '--noUI',
-                `--runscript=${tempFilePath}`
-                // If CODESYS needs quotes around the value *itself*: `--runscript="${tempFilePath}"`
-            ];
-            // --- End spawn arguments ---
-            process.stderr.write(`INTEROP: Spawning command: ${command}\n`);
-            process.stderr.write(`INTEROP: Spawning args: ${JSON.stringify(args)}\n`);
+            // --- Construct command string for shell: true ---
+            // Quote the executable path itself
+            const quotedExePath = `"${codesysExePath}"`;
+            // Format arguments exactly as CODESYS seems to want: --option="Value With Spaces"
+            // The outer quotes are for the shell parser.
+            const profileArg = `--profile="${codesysProfileName}"`;
+            const scriptArg = `--runscript="${tempFilePath}"`; // tempFilePath from path.join has correct backslashes for Win
+            // Combine into a single string for the shell
+            const fullCommandString = `${quotedExePath} ${profileArg} --noUI ${scriptArg}`;
+            // Example result: "\"C:\\Program Files\\...\\CODESYS.exe\" --profile=\"CODESYS V3.5 SP21\" --noUI --runscript=\"C:\\Users\\...\\script.py\""
+            // --- End command string construction ---
+            process.stderr.write(`INTEROP: Spawning command (shell:true): ${fullCommandString}\n`);
             process.stderr.write(`INTEROP ENV: CWD before spawn: ${process.cwd()}\n`);
-            process.stderr.write(`INTEROP ENV: Forcing CWD for spawn: ${codesysDir}\n`);
-            // --- Create modified environment ---
+            process.stderr.write(`INTEROP ENV: Forcing CWD for spawn: ${codesysDir}\n`); // Re-enabled CWD change
+            // --- Create modified environment (Re-enabled) ---
             const spawnEnv = Object.assign({}, process.env);
             const pathSeparator = ';'; // Windows
             const originalPath = spawnEnv.PATH || '';
-            spawnEnv.PATH = `${codesysDir}${pathSeparator}${originalPath}`;
-            process.stderr.write(`INTEROP ENV: MODIFIED PATH for spawn (prepended): ${spawnEnv.PATH.substring(0, 100)}...\n`);
+            spawnEnv.PATH = `${codesysDir}${pathSeparator}${originalPath}`; // Prepend CODESYS dir to PATH
+            process.stderr.write(`INTEROP ENV: MODIFIED PATH for spawn (prepended): ${spawnEnv.PATH.substring(0, 100)}...\n`); // Re-enabled ENV change
             // --- End modified environment ---
             const spawnResult = yield new Promise((resolve) => {
                 let stdoutData = '';
@@ -124,16 +129,19 @@ function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName)
                 const controller = new AbortController();
                 const timeoutSignal = controller.signal;
                 const timeoutDuration = 60000; // 60 seconds
-                const childProcess = (0, child_process_1.spawn)(command, args, {
+                // Pass the single command string, empty args array, and shell: true
+                const childProcess = (0, child_process_1.spawn)(fullCommandString, [], {
                     windowsHide: true,
                     signal: timeoutSignal,
-                    cwd: codesysDir, // Force CWD
-                    env: spawnEnv, // Pass modified environment
-                    shell: false // <<< Ensure shell is false or omitted (default)
+                    cwd: codesysDir, // Re-enabled CWD change
+                    env: spawnEnv, // Re-enabled ENV change
+                    shell: true // USE shell: true
                 });
-                const timeoutId = setTimeout(() => { }, timeoutDuration);
+                const timeoutId = setTimeout(() => {
+                    process.stderr.write('INTEROP: Process timeout reached.\n');
+                    controller.abort();
+                }, timeoutDuration);
                 // --- Event Listeners (stdout, stderr, error, close, abort) ---
-                // (Keep the event listener logic the same as the previous version)
                 childProcess.stdout.on('data', (data) => {
                     const chunk = data.toString();
                     stdoutData += chunk;
@@ -142,9 +150,16 @@ function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName)
                 childProcess.stderr.on('data', (data) => {
                     const chunk = data.toString();
                     stderrData += chunk;
-                    if (chunk.includes('C:\\Program')) {
-                        process.stderr.write(`>>>> INTEROP STDERR DETECTED 'C:\\Program': ${chunk}\n`);
+                    // Check for specific error patterns
+                    if (chunk.includes('--profile="profile name"')) {
+                        process.stderr.write(`>>>> INTEROP STDERR DETECTED Profile Error Message: ${chunk}\n`);
                     }
+                    else if (chunk.includes('is not recognized')) {
+                        process.stderr.write(`>>>> INTEROP STDERR DETECTED 'not recognized' (shell issue?): ${chunk}\n`);
+                    }
+                    else if (chunk.includes('SyntaxErrorException')) {
+                        process.stderr.write(`>>>> INTEROP STDERR DETECTED Syntax Error: ${chunk}\n`);
+                    } // More specific check
                     else {
                         process.stderr.write(`INTEROP stderr chunk: ${chunk}\n`);
                     }
@@ -152,7 +167,7 @@ function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName)
                 childProcess.on('error', (spawnError) => {
                     var _a;
                     clearTimeout(timeoutId);
-                    process.stderr.write(`INTEROP SPAWN ERROR (shell:false): ${spawnError.message}\n`);
+                    process.stderr.write(`INTEROP SPAWN ERROR (shell:true): ${spawnError.message}\n`);
                     resolve({ code: (_a = spawnError.errno) !== null && _a !== void 0 ? _a : 1, stdout: stdoutData, stderr: stderrData, error: spawnError });
                 });
                 childProcess.on('close', (code) => {
@@ -161,11 +176,17 @@ function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName)
                     resolve({ code: code, stdout: stdoutData, stderr: stderrData });
                 });
                 timeoutSignal.addEventListener('abort', () => {
-                    process.stderr.write('INTEROP: Abort signal received, killing process.\n');
-                    if (!childProcess.killed)
-                        childProcess.kill('SIGTERM');
-                    setTimeout(() => { if (!childProcess.killed)
-                        childProcess.kill('SIGKILL'); }, 2000);
+                    process.stderr.write('INTEROP: Abort signal received, attempting to kill process.\n');
+                    if (!childProcess.killed) {
+                        if (!childProcess.kill('SIGTERM')) { // Try graceful termination first
+                            process.stderr.write('INTEROP: SIGTERM failed, attempting SIGKILL in 2s.\n');
+                            setTimeout(() => { if (!childProcess.killed)
+                                childProcess.kill('SIGKILL'); }, 2000);
+                        }
+                        else {
+                            process.stderr.write('INTEROP: SIGTERM sent.\n');
+                        }
+                    }
                     resolve({ code: null, stdout: stdoutData, stderr: stderrData + "\nTIMEOUT: Process aborted due to timeout." });
                 }, { once: true });
                 // --- End Event Listeners ---
@@ -173,35 +194,48 @@ function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName)
             output = spawnResult.stdout;
             stderrOutput = spawnResult.stderr;
             exitCode = spawnResult.code;
-            // success determination logic
-            if (stderrOutput.includes("'C:\\Program' is not recognized")) {
-                success = false;
-                process.stderr.write("INTEROP: Failure determined by 'C:\\Program' error in stderr.\n");
+            // --- Success Determination Logic ---
+            success = false; // Assume failure unless proven otherwise
+            if (spawnResult.error) {
+                process.stderr.write(`INTEROP: Failure determined by spawn error: ${spawnResult.error.message}\n`);
+                if (!stderrOutput.includes(SCRIPT_ERROR_MARKER))
+                    stderrOutput = `SCRIPT_ERROR: Spawn failed: ${spawnResult.error.message}\n${stderrOutput}`;
+            }
+            else if (stderrOutput.includes('is not recognized as an internal or external command')) {
+                process.stderr.write("INTEROP: Failure determined by 'not recognized' error in stderr (shell:true quoting issue likely).\n");
+                if (!stderrOutput.includes(SCRIPT_ERROR_MARKER))
+                    stderrOutput = `SCRIPT_ERROR: Shell execution failed: ${stderrOutput}`;
+            }
+            else if (stderrOutput.includes('--profile="profile name"')) {
+                process.stderr.write("INTEROP: Failure determined by CODESYS profile error message in stderr.\n");
                 if (!stderrOutput.includes(SCRIPT_ERROR_MARKER))
                     stderrOutput = `SCRIPT_ERROR: ${stderrOutput}`;
             }
-            else if (spawnResult.error) {
-                success = false;
-                process.stderr.write(`INTEROP: Failure determined by spawn error: ${spawnResult.error.message}\n`);
+            else if (stderrOutput.includes('SyntaxErrorException')) { // Check for syntax error specifically
+                process.stderr.write("INTEROP: Failure determined by CODESYS Script Syntax Error.\n");
                 if (!stderrOutput.includes(SCRIPT_ERROR_MARKER))
-                    stderrOutput = `SCRIPT_ERROR: Spawn failed: ${spawnResult.error.message}\n${stderrOutput}`;
+                    stderrOutput = `SCRIPT_ERROR: ${stderrOutput}`; // Include the syntax error details
             }
             else {
+                // No spawn error, no shell error, no profile error, no syntax error -> check markers/exit code
                 process.stderr.write(`INTEROP: Checking markers/exit code (Code: ${exitCode})...\n`);
                 if (output.includes(SCRIPT_SUCCESS_MARKER) || stderrOutput.includes(SCRIPT_SUCCESS_MARKER)) {
                     success = true;
                     process.stderr.write("INTEROP: Success determined by SUCCESS marker.\n");
                 }
                 else if (output.includes(SCRIPT_ERROR_MARKER) || stderrOutput.includes(SCRIPT_ERROR_MARKER)) {
-                    success = false;
+                    success = false; // Explicit error marker found
                     process.stderr.write("INTEROP: Failure determined by ERROR marker.\n");
                 }
                 else {
+                    // No markers found, rely solely on exit code
                     success = exitCode === 0;
-                    if (success)
+                    if (success) {
                         process.stderr.write(`INTEROP: Success determined by exit code 0 (no markers found).\n`);
+                    }
                     else {
                         process.stderr.write(`INTEROP: Failure determined by non-zero exit code ${exitCode} (no markers found).\n`);
+                        // Add generic failure message if stderr doesn't already contain SCRIPT_ERROR
                         if (!stderrOutput.includes(SCRIPT_ERROR_MARKER))
                             stderrOutput = `SCRIPT_ERROR: Process failed with exit code ${exitCode} (no markers found).\n${stderrOutput}`;
                     }
@@ -227,6 +261,7 @@ function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName)
             }
         }
         // Final output processing
+        // Combine stderr and stdout only on failure to preserve clean success output
         const finalOutput = success ? output : `${stderrOutput}\n${output}`.trim();
         process.stderr.write(`INTEROP: Final Success: ${success}\n`);
         process.stderr.write(`INTEROP: Final Output Length: ${finalOutput.length}\n---\n`);