@codesys/mcp-toolkit 1.0.3 → 1.0.4

package/examples/sample_config.json

@@ -1,33 +1,32 @@
-{
-  "mcpServers": {
-    "codesys_local": {
-      "command": "npx",
-      "args": [
-        "-y",
-        "@codesys/mcp-toolkit",
-        "--codesys-path", "C:\\Program Files\\CODESYS 3.5.21.0\\CODESYS\\Common\\CODESYS.exe",
-        "--codesys-profile", "CODESYS V3.5 SP21"
-      ]
-      // Note: Path with spaces is handled by the toolkit now. No need for additional quotes.
-    },
-    "filesystem": {
-      "command": "npx",
-      "args": [
-        "-y",
-        "@modelcontextprotocol/server-filesystem",
-        "C:/MyProjects"
-      ]
-    },
-    "memory": {
-      "command": "npx",
-      "args": [
-        "-y",
-        "@modelcontextprotocol/server-memory"
-      ]
-    },
-    "puppeteer": {
-      "command": "npx",
-      "args": ["-y", "@modelcontextprotocol/server-puppeteer"]
-    }
-  }
-}
+{
+  "mcpServers": {
+    "codesys_local": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "@codesys/mcp-toolkit",
+        "--codesys-path", "C:\\Program Files\\CODESYS 3.5.21.0\\CODESYS\\Common\\CODESYS.exe",
+        "--codesys-profile", "CODESYS V3.5 SP21"
+      ]
+    },
+    "filesystem": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "@modelcontextprotocol/server-filesystem",
+        "C:/MyProjects"
+      ]
+    },
+    "memory": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "@modelcontextprotocol/server-memory"
+      ]
+    },
+    "puppeteer": {
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-puppeteer"]
+    }
+  }
+}

package/package.json

@@ -1,47 +1,47 @@
-{
-  "name": "@codesys/mcp-toolkit",
-  "version": "1.0.3",
-  "main": "dist/server.js",
-  "bin": {
-    "codesys-mcp-toolkit": "./dist/bin.js"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc",
-    "prepare": "npm run build"
-  },
-  "keywords": [
-    "codesys",
-    "mcp",
-    "modelcontextprotocol",
-    "plc",
-    "automation",
-    "programming"
-  ],
-  "author": "Your Name <your.email@example.com>",
-  "license": "MIT",
-  "type": "commonjs",
-  "description": "Model Context Protocol (MCP) server for CODESYS automation platform",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/johannesPettersson80/codesys-mcp-toolkit.git"
-  },
-  "homepage": "https://github.com/johannesPettersson80/codesys-mcp-toolkit#readme",
-  "bugs": {
-    "url": "https://github.com/johannesPettersson80/codesys-mcp-toolkit/issues"
-  },
-  "engines": {
-    "node": ">=14.0.0"
-  },
-  "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.9.0",
-    "axios": "^1.6.8",
-    "commander": "^11.1.0",
-    "zod": "^3.24.2"
-  },
-  "devDependencies": {
-    "@types/commander": "^2.12.5",
-    "@types/node": "^22.14.1",
-    "typescript": "^5.8.3"
-  }
-}
+{
+  "name": "@codesys/mcp-toolkit",
+  "version": "1.0.4",
+  "main": "dist/server.js",
+  "bin": {
+    "codesys-mcp-toolkit": "./dist/bin.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "codesys",
+    "mcp",
+    "modelcontextprotocol",
+    "plc",
+    "automation",
+    "programming"
+  ],
+  "author": "Your Name <your.email@example.com>",
+  "license": "MIT",
+  "type": "commonjs",
+  "description": "Model Context Protocol (MCP) server for CODESYS automation platform",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/johannesPettersson80/codesys-mcp-toolkit.git"
+  },
+  "homepage": "https://github.com/johannesPettersson80/codesys-mcp-toolkit#readme",
+  "bugs": {
+    "url": "https://github.com/johannesPettersson80/codesys-mcp-toolkit/issues"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.10.2",
+    "axios": "^1.6.8",
+    "commander": "^11.1.0",
+    "zod": "^3.24.3"
+  },
+  "devDependencies": {
+    "@types/commander": "^2.12.5",
+    "@types/node": "^22.14.1",
+    "typescript": "^5.8.3"
+  }
+}

package/dist/codesys_interop - Copy.js

@@ -1,180 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.executeCodesysScript = executeCodesysScript;
-const child_process_1 = require("child_process");
-const promises_1 = require("fs/promises");
-const path = __importStar(require("path"));
-const os = __importStar(require("os"));
-// Define expected success/error markers from the Python scripts
-const SCRIPT_SUCCESS_MARKER = 'SCRIPT_SUCCESS';
-const SCRIPT_ERROR_MARKER = 'SCRIPT_ERROR';
-/**
- * Executes a CODESYS Python script using the command line interface.
- *
- * @param scriptContent The Python script code to execute.
- * @param codesysExePath The full path to the CODESYS.exe executable.
- * @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.
- */
-function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // Validate arguments passed to the function
-        if (!codesysExePath) {
-            throw new Error('CODESYS executable path was not provided to executeCodesysScript.');
-        }
-        if (!codesysProfileName) {
-            throw new Error('CODESYS profile name was not provided to executeCodesysScript.');
-        }
-        // Create a temporary file for the script
-        const tempDir = os.tmpdir();
-        const tempFileName = `codesys_script_${Date.now()}_${Math.random().toString(36).substring(7)}.py`;
-        const tempFilePath = path.join(tempDir, tempFileName);
-        let output = '';
-        let success = false;
-        try {
-            // Normalize line endings to LF (\n)
-            const normalizedScriptContent = scriptContent.replace(/\r\n/g, '\n');
-            // Write the script content to the temporary file using latin1 encoding
-            yield (0, promises_1.writeFile)(tempFilePath, normalizedScriptContent, 'latin1'); // Explicitly use latin1
-            process.stderr.write(`Temporary script written to: ${tempFilePath} with latin1 encoding and LF line endings\n`); // Use process.stderr
-            // Add --additionalfolder argument
-            const additionalFolderPath = "C:\\Program Files\\CODESYS 3.5.21.0\\CODESYS\\AdditionalFolders\\Default"; // Assuming Default instance
-            // Fix: Use shell:true and pass the entire command as a single string without additionalfolder
-            const commandWithArgs = `"${codesysExePath}" --profile="${codesysProfileName}" --noUI --runscript="${tempFilePath}"`;
-            process.stderr.write(`Executing: ${commandWithArgs}\n`); // Log the command string
-            // Spawn the CODESYS process using shell:true for proper argument handling
-            const codesysProcess = (0, child_process_1.spawn)(commandWithArgs, {
-                stdio: ['ignore', 'pipe', 'pipe'], // Ignore stdin, pipe stdout and stderr
-                shell: true // Use shell to handle the command string properly
-            });
-            // Capture stdout
-            codesysProcess.stdout.on('data', (data) => {
-                const chunk = data.toString();
-                // console.error('CODESYS stdout:', chunk); // Optional: Original debug log
-                output += chunk;
-            });
-            // Capture stderr
-            codesysProcess.stderr.on('data', (data) => {
-                const chunk = data.toString();
-                process.stderr.write(`CODESYS stderr: ${chunk}\n`); // Use process.stderr
-                output += chunk; // Include stderr in the output for debugging
-            });
-            // Wait for the process to exit with a timeout
-            const exitCode = yield new Promise((resolve, reject) => {
-                // Add timeout handling
-                const timeoutMs = 30000; // 30 seconds
-                const timeout = setTimeout(() => {
-                    process.stderr.write(`TIMEOUT: CODESYS process did not complete in ${timeoutMs}ms\n`);
-                    // Force resolve with 0 to proceed with parsing output collected so far
-                    codesysProcess.kill();
-                    resolve(0);
-                }, timeoutMs);
-                codesysProcess.on('close', (code) => {
-                    clearTimeout(timeout);
-                    resolve(code !== null && code !== void 0 ? code : 0);
-                });
-                codesysProcess.on('error', (err) => {
-                    clearTimeout(timeout);
-                    // Error starting the process itself (e.g., command not found)
-                    process.stderr.write(`Failed to start CODESYS process: ${err.message}\n`); // Use process.stderr
-                    reject(err);
-                });
-            });
-            process.stderr.write(`CODESYS process exited with code: ${exitCode}\n`); // Use process.stderr
-            // Determine success based on exit code and output markers
-            // Note: CODESYS scripting might return exit code 0 even if the script had logical errors.
-            // Relying on specific output markers is more robust.
-            if (output.includes(SCRIPT_SUCCESS_MARKER)) {
-                success = true;
-            }
-            else if (output.includes(SCRIPT_ERROR_MARKER)) {
-                success = false;
-            }
-            else {
-                // If no markers found, fall back to exit code (less reliable)
-                success = exitCode === 0;
-                if (!success) {
-                    // Append the specific CODESYS error if available and no other marker found
-                    if (!output.includes(SCRIPT_ERROR_MARKER)) {
-                        output += `\nSCRIPT_ERROR: Process exited with non-zero code ${exitCode}. Check CODESYS stderr output above for details.`;
-                    }
-                    else {
-                        output += `\nSCRIPT_ERROR: Process exited with non-zero code ${exitCode}.`;
-                    }
-                }
-                else {
-                    // If exit code is 0 but no success marker, treat as potential issue or simple script
-                    console.error("Warning: CODESYS script finished with exit code 0 but no SCRIPT_SUCCESS marker found."); // Log warning to stderr
-                    // Optionally, you could treat this as success or failure depending on requirements
-                    // For now, let's assume success if exit code is 0 and no error marker.
-                    if (!output.includes(SCRIPT_ERROR_MARKER)) {
-                        success = true;
-                    }
-                }
-            }
-        }
-        catch (error) {
-            process.stderr.write(`Error executing CODESYS script: ${error}\n`); // Use process.stderr
-            output += `\nSCRIPT_ERROR: Failed to execute script process. ${error.message}`;
-            success = false;
-        }
-        finally {
-            // Clean up the temporary file
-            try {
-                yield (0, promises_1.unlink)(tempFilePath);
-                process.stderr.write(`Temporary script deleted: ${tempFilePath}\n`); // Use process.stderr
-            }
-            catch (cleanupError) {
-                process.stderr.write(`Failed to delete temporary script file ${tempFilePath}: ${cleanupError}\n`); // Use process.stderr
-                // Don't overwrite the original error if cleanup fails
-                if (success) { // Only add cleanup error if the main process didn't already fail
-                    output += `\nWARNING: Failed to delete temporary script file ${tempFilePath}. ${cleanupError.message}`;
-                }
-            }
-        }
-        process.stderr.write(`Final script output received:\n---\n${output}\n---\n`); // Use process.stderr
-        return { success, output }; // Revert return object
-    });
-}