@codesys/mcp-toolkit 1.1.3 → 1.2.0

package/README.md.enhanced

@@ -1,155 +1,155 @@
-# @codesys/mcp-toolkit
-
-![npm](https://img.shields.io/npm/v/@codesys/mcp-toolkit)
-![License](https://img.shields.io/github/license/yourusername/codesys-mcp-toolkit)
-
-A Model Context Protocol (MCP) server for CODESYS V3 programming environments. This toolkit enables seamless interaction between MCP clients (like Claude Desktop) and CODESYS, allowing automation of project management, POU creation, code editing, and compilation tasks.
-
-<p align="center">
-  <img src="https://github.com/yourusername/codesys-mcp-toolkit/raw/main/docs/assets/diagram.png" alt="CODESYS MCP Toolkit Architecture" width="600">
-</p>
-
-## 🌟 Features
-
-- **Project Management**
-  - Open existing CODESYS projects
-  - Create new projects from templates
-  - Save project changes
-
-- **POU Management**
-  - Create Programs, Function Blocks, and Functions
-  - Set declaration and implementation code
-  - Create properties and methods for Function Blocks
-  - Compile projects
-
-- **MCP Resources**
-  - `codesys://project/status`: Check scripting status and project state
-  - `codesys://project/{+project_path}/structure`: Retrieve project structure
-  - `codesys://project/{+project_path}/pou/{+pou_path}/code`: Read POU code
-
-- **MCP Tools**
-  - `open_project`: Open specified CODESYS project
-  - `create_project`: Create new CODESYS project
-  - `save_project`: Save currently open project
-  - `create_pou`: Create new Program, Function Block, or Function
-  - `set_pou_code`: Update code for a specified POU
-  - `create_property`: Create property in a Function Block
-  - `create_method`: Create method in a Function Block
-  - `compile_project`: Compile the open project
-
-## 📋 Prerequisites
-
-- **CODESYS V3**: A working CODESYS V3 installation (tested with 3.5 SP21) with **Scripting Engine** component enabled
-- **Node.js**: Version 18 or later required
-- **MCP Client**: An MCP-enabled application (e.g., Claude Desktop)
-
-## 🚀 Installation
-
-### Option 1: Install from npm (Recommended)
-
-```bash
-npm install -g @codesys/mcp-toolkit
-```
-
-This installs the package globally, making the `codesys-mcp-toolkit` command available in your terminal.
-
-### Option 2: Install from Source
-
-```bash
-# Clone the repository
-git clone https://github.com/yourusername/codesys-mcp-toolkit.git
-cd codesys-mcp-toolkit
-
-# Install dependencies
-npm install
-
-# Build the project
-npm run build
-
-# Install globally
-npm install -g .
-```
-
-## 🔧 Configuration
-
-### Claude Desktop Configuration
-
-1. Locate your Claude Desktop configuration file:
-   - Windows: `C:\Users\<YourUsername>\AppData\Roaming\Claude\claude_desktop_config.json`
-
-2. Add the CODESYS MCP server entry:
-
-```json
-{
-  "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"
-      ]
-    }
-  }
-}
-```
-
-3. Customize the paths to match your CODESYS installation:
-   - `--codesys-path`: Path to your CODESYS.exe
-   - `--codesys-profile`: Your CODESYS profile name
-
-4. Restart Claude Desktop to apply the changes
-
-## 🛠️ Usage Examples
-
-### Creating a Function Block with Properties
-
-```
-Ask Claude: "Using the CODESYS Local server, please create a Motor Controller function block with Start and Stop methods, plus CurrentSpeed property."
-```
-
-Claude will execute these MCP tool calls:
-1. `create_pou` to create the MotorController Function Block
-2. `create_property` to add the CurrentSpeed property
-3. `create_method` to add Start and Stop methods
-4. `set_pou_code` to implement each method and property
-
-### Opening and Compiling a Project
-
-```
-Ask Claude: "Can you open the project at C:/MyProjects/TestProject.project using CODESYS Local and compile it?"
-```
-
-Claude will:
-1. Use `open_project` to open the specified file
-2. Use `compile_project` to build the application
-
-## 🔍 Troubleshooting
-
-### Common Issues
-
-- **Connection Failures**: Check Claude Desktop logs for error messages
-- **Path Issues**: Ensure CODESYS executable path is correct
-- **Profile Mismatch**: Verify profile name matches exactly
-- **Permission Problems**: Ensure Claude has appropriate permissions
-- **CODESYS Already Running**: Close other CODESYS instances
-
-### Debug Logs
-
-Check logs at:
-- Windows: `C:\Users\<YourUsername>\AppData\Roaming\Claude\logs\`
-
-## 🤝 Contributing
-
-Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
-
-## 📝 License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
-## 🙏 Acknowledgements
-
-- 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
+# @codesys/mcp-toolkit
+
+![npm](https://img.shields.io/npm/v/@codesys/mcp-toolkit)
+![License](https://img.shields.io/github/license/yourusername/codesys-mcp-toolkit)
+
+A Model Context Protocol (MCP) server for CODESYS V3 programming environments. This toolkit enables seamless interaction between MCP clients (like Claude Desktop) and CODESYS, allowing automation of project management, POU creation, code editing, and compilation tasks.
+
+<p align="center">
+  <img src="https://github.com/yourusername/codesys-mcp-toolkit/raw/main/docs/assets/diagram.png" alt="CODESYS MCP Toolkit Architecture" width="600">
+</p>
+
+## 🌟 Features
+
+- **Project Management**
+  - Open existing CODESYS projects
+  - Create new projects from templates
+  - Save project changes
+
+- **POU Management**
+  - Create Programs, Function Blocks, and Functions
+  - Set declaration and implementation code
+  - Create properties and methods for Function Blocks
+  - Compile projects
+
+- **MCP Resources**
+  - `codesys://project/status`: Check scripting status and project state
+  - `codesys://project/{+project_path}/structure`: Retrieve project structure
+  - `codesys://project/{+project_path}/pou/{+pou_path}/code`: Read POU code
+
+- **MCP Tools**
+  - `open_project`: Open specified CODESYS project
+  - `create_project`: Create new CODESYS project
+  - `save_project`: Save currently open project
+  - `create_pou`: Create new Program, Function Block, or Function
+  - `set_pou_code`: Update code for a specified POU
+  - `create_property`: Create property in a Function Block
+  - `create_method`: Create method in a Function Block
+  - `compile_project`: Compile the open project
+
+## 📋 Prerequisites
+
+- **CODESYS V3**: A working CODESYS V3 installation (tested with 3.5 SP21) with **Scripting Engine** component enabled
+- **Node.js**: Version 18 or later required
+- **MCP Client**: An MCP-enabled application (e.g., Claude Desktop)
+
+## 🚀 Installation
+
+### Option 1: Install from npm (Recommended)
+
+```bash
+npm install -g @codesys/mcp-toolkit
+```
+
+This installs the package globally, making the `codesys-mcp-toolkit` command available in your terminal.
+
+### Option 2: Install from Source
+
+```bash
+# Clone the repository
+git clone https://github.com/yourusername/codesys-mcp-toolkit.git
+cd codesys-mcp-toolkit
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+
+# Install globally
+npm install -g .
+```
+
+## 🔧 Configuration
+
+### Claude Desktop Configuration
+
+1. Locate your Claude Desktop configuration file:
+   - Windows: `C:\Users\<YourUsername>\AppData\Roaming\Claude\claude_desktop_config.json`
+
+2. Add the CODESYS MCP server entry:
+
+```json
+{
+  "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"
+      ]
+    }
+  }
+}
+```
+
+3. Customize the paths to match your CODESYS installation:
+   - `--codesys-path`: Path to your CODESYS.exe
+   - `--codesys-profile`: Your CODESYS profile name
+
+4. Restart Claude Desktop to apply the changes
+
+## 🛠️ Usage Examples
+
+### Creating a Function Block with Properties
+
+```
+Ask Claude: "Using the CODESYS Local server, please create a Motor Controller function block with Start and Stop methods, plus CurrentSpeed property."
+```
+
+Claude will execute these MCP tool calls:
+1. `create_pou` to create the MotorController Function Block
+2. `create_property` to add the CurrentSpeed property
+3. `create_method` to add Start and Stop methods
+4. `set_pou_code` to implement each method and property
+
+### Opening and Compiling a Project
+
+```
+Ask Claude: "Can you open the project at C:/MyProjects/TestProject.project using CODESYS Local and compile it?"
+```
+
+Claude will:
+1. Use `open_project` to open the specified file
+2. Use `compile_project` to build the application
+
+## 🔍 Troubleshooting
+
+### Common Issues
+
+- **Connection Failures**: Check Claude Desktop logs for error messages
+- **Path Issues**: Ensure CODESYS executable path is correct
+- **Profile Mismatch**: Verify profile name matches exactly
+- **Permission Problems**: Ensure Claude has appropriate permissions
+- **CODESYS Already Running**: Close other CODESYS instances
+
+### Debug Logs
+
+Check logs at:
+- Windows: `C:\Users\<YourUsername>\AppData\Roaming\Claude\logs\`
+
+## 🤝 Contributing
+
+Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## 📝 License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## 🙏 Acknowledgements
+
+- 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

package/dist/codesys_interop.js

@@ -7,6 +7,7 @@
  * - Creating temporary Python script files
  * - Executing them via CODESYS's scripting engine
  * - Capturing and processing results
+ * - Supporting both one-off script execution and persistent sessions
  *
  * IMPORTANT: Path handling for Windows is critical - paths with spaces require
  * special handling to avoid the 'C:\Program' not recognized error.
@@ -60,6 +61,8 @@ const promises_1 = require("fs/promises");
 const path = __importStar(require("path"));
 const os = __importStar(require("os"));
 const fs = __importStar(require("fs")); // Import fs for existsSync check
+// Optional import for session manager
+const sessionManager_1 = require("./sessionManager");
 // Define expected success/error markers from the Python scripts
 const SCRIPT_SUCCESS_MARKER = 'SCRIPT_SUCCESS';
 const SCRIPT_ERROR_MARKER = 'SCRIPT_ERROR';
@@ -69,12 +72,13 @@ const SCRIPT_ERROR_MARKER = 'SCRIPT_ERROR';
  * @param scriptContent The Python script code to execute.
  * @param codesysExePath The full path to the CODESYS.exe executable (can contain spaces).
  * @param codesysProfileName The name of the CODESYS profile to use for scripting.
+ * @param sessionManager Optional session manager for persistent session execution
  * @returns A promise resolving to an object containing the success status and the script's output.
  *
  * NOTE: Using shell: true with careful command string quoting to handle
  * CODESYS argument parsing quirks when launched non-interactively.
  */
-function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName) {
+function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName, sessionManager) {
     return __awaiter(this, void 0, void 0, function* () {
         // --- Pre-checks ---
         if (!codesysExePath)
@@ -84,6 +88,29 @@ function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName)
         if (!fs.existsSync(codesysExePath))
             throw new Error(`CODESYS executable not found at provided path: ${codesysExePath}`);
         // --- End Pre-checks ---
+        // --- Check if we should use the persistent session ---
+        if (sessionManager) {
+            const sessionState = sessionManager.getState();
+            if (sessionState === sessionManager_1.SessionState.RUNNING || sessionState === sessionManager_1.SessionState.BUSY) {
+                process.stderr.write(`INTEROP: Using persistent session for script execution\n`);
+                try {
+                    const result = yield sessionManager.executeScript(scriptContent);
+                    return {
+                        success: result.success,
+                        output: result.output
+                    };
+                }
+                catch (error) {
+                    process.stderr.write(`INTEROP: Error executing script in persistent session: ${error.message}\n`);
+                    process.stderr.write(`INTEROP: Falling back to one-time execution mode\n`);
+                    // Continue with the non-persistent approach as fallback
+                }
+            }
+            else {
+                process.stderr.write(`INTEROP: Session not in RUNNING/BUSY state (current: ${sessionState}). Using one-time execution.\n`);
+            }
+        }
+        // --- Standard one-time script execution ---
         const tempDir = os.tmpdir();
         const tempFileName = `codesys_script_${Date.now()}_${Math.random().toString(36).substring(2, 9)}.py`;
         const tempFilePath = path.join(tempDir, tempFileName); // Path module uses OS-specific separators ('\' on Windows)
@@ -118,7 +145,7 @@ function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName)
             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 pathSeparator = os.platform() === 'win32' ? ';' : ':';
             const originalPath = spawnEnv.PATH || '';
             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

package/dist/scriptLoader.js

@@ -0,0 +1,158 @@
+"use strict";
+/**
+ * Script Loader Module
+ * Centralizes loading and management of Python script templates
+ *
+ * This module:
+ * - Loads script templates from the /scripts directory
+ * - Provides script template interpolation functions
+ * - Manages script parameter substitution
+ */
+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.loadScriptTemplate = loadScriptTemplate;
+exports.loadScriptTemplateSync = loadScriptTemplateSync;
+exports.interpolateScript = interpolateScript;
+exports.combineScripts = combineScripts;
+exports.preloadAllScriptTemplates = preloadAllScriptTemplates;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const util_1 = require("util");
+const readFileAsync = (0, util_1.promisify)(fs.readFile);
+const SCRIPTS_DIR = path.join(__dirname, 'scripts');
+// Cache for loaded scripts to avoid repeated file system access
+const scriptCache = {};
+/**
+ * Loads a script template from the scripts directory
+ * @param scriptName The name of the script file (without .py extension)
+ * @returns The script content as a string
+ */
+function loadScriptTemplate(scriptName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Add .py extension if not provided
+        const fileName = scriptName.endsWith('.py') ? scriptName : `${scriptName}.py`;
+        const filePath = path.join(SCRIPTS_DIR, fileName);
+        // Return from cache if available
+        if (scriptCache[fileName]) {
+            return scriptCache[fileName];
+        }
+        try {
+            const content = yield readFileAsync(filePath, 'utf8');
+            // Store in cache for future use
+            scriptCache[fileName] = content;
+            return content;
+        }
+        catch (error) {
+            throw new Error(`Failed to load script template '${fileName}': ${error.message}`);
+        }
+    });
+}
+/**
+ * Loads a script template synchronously (for use during startup)
+ * @param scriptName The name of the script file (without .py extension)
+ * @returns The script content as a string
+ */
+function loadScriptTemplateSync(scriptName) {
+    // Add .py extension if not provided
+    const fileName = scriptName.endsWith('.py') ? scriptName : `${scriptName}.py`;
+    const filePath = path.join(SCRIPTS_DIR, fileName);
+    // Return from cache if available
+    if (scriptCache[fileName]) {
+        return scriptCache[fileName];
+    }
+    try {
+        const content = fs.readFileSync(filePath, 'utf8');
+        // Store in cache for future use
+        scriptCache[fileName] = content;
+        return content;
+    }
+    catch (error) {
+        throw new Error(`Failed to load script template '${fileName}': ${error.message}`);
+    }
+}
+/**
+ * Interpolates parameters into a script template
+ * @param template The script template string
+ * @param params Object containing parameter names and values
+ * @returns The script with parameter values substituted
+ */
+function interpolateScript(template, params) {
+    let result = template;
+    // Replace each parameter in the template
+    for (const [key, value] of Object.entries(params)) {
+        // Convert value to string and escape backslashes for Python
+        const escapedValue = String(value).replace(/\\/g, '\\\\');
+        // Replace {PARAM_NAME} with the escaped value
+        const paramPattern = new RegExp(`\\{${key}\\}`, 'g');
+        result = result.replace(paramPattern, escapedValue);
+    }
+    return result;
+}
+/**
+ * Combines multiple script fragments with proper indentation
+ * @param scripts Object containing named script fragments
+ * @returns Combined script content
+ */
+function combineScripts(scripts) {
+    return Object.values(scripts).join('\n\n');
+}
+/**
+ * Load all script templates from the scripts directory
+ * This is useful during development to preload the cache
+ */
+function preloadAllScriptTemplates() {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const files = fs.readdirSync(SCRIPTS_DIR);
+            for (const file of files) {
+                if (file.endsWith('.py')) {
+                    yield loadScriptTemplate(file);
+                }
+            }
+        }
+        catch (error) {
+            console.error(`Failed to preload script templates: ${error.message}`);
+        }
+    });
+}