@codesys/mcp-toolkit 1.0.3 → 1.0.4

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

@@ -73,86 +73,95 @@ function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName)
         const tempFilePath = path.join(tempDir, tempFileName);
         let output = '';
         let success = false;
-        // Define timeout duration *before* the promise
-        const timeoutMs = 60000; // Increased timeout to 60 seconds (accessible below)
         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`);
-            // Arguments for CODESYS.exe
-            const argsArray = [
+            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:false and pass command and arguments separately to properly handle paths with spaces
+            const command = codesysExePath;
+            const args = [
                 `--profile=${codesysProfileName}`,
-                `--noUI`,
+                '--noUI',
                 `--runscript=${tempFilePath}`
             ];
-            process.stderr.write(`Executing: "${codesysExePath}" with args: ${JSON.stringify(argsArray)}\n`);
-            process.stderr.write('>>>> DEBUG: Attempting spawn with shell:true to handle paths with spaces. <<<<\n');
-            // Spawn the CODESYS process WITH shell:true to handle paths with spaces properly
-            const codesysProcess = (0, child_process_1.spawn)(`"${codesysExePath}"`, argsArray, {
-                stdio: ['ignore', 'pipe', 'pipe'],
-                shell: true
+            process.stderr.write(`Executing: ${command} ${args.join(' ')}\n`); // Log the command
+            // Spawn the CODESYS process using shell:false for proper path handling with spaces
+            const codesysProcess = (0, child_process_1.spawn)(command, args, {
+                stdio: ['ignore', 'pipe', 'pipe'], // Ignore stdin, pipe stdout and stderr
+                shell: false // Don't use shell to avoid issues with paths containing spaces
             });
-            // Capture stdout & stderr
+            // 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`);
-                output += chunk;
+                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) => {
-                // Note: timeoutMs is now defined in the outer scope
+                // Add timeout handling
+                const timeoutMs = 30000; // 30 seconds
                 const timeout = setTimeout(() => {
-                    process.stderr.write(`TIMEOUT: CODESYS process did not complete in ${timeoutMs}ms. Killing process.\n`);
-                    codesysProcess.kill('SIGTERM');
-                    setTimeout(() => {
-                        if (!codesysProcess.killed) {
-                            process.stderr.write('Force killing CODESYS process after timeout.\n');
-                            codesysProcess.kill('SIGKILL');
-                        }
-                    }, 2000);
-                    resolve(999); // Use a distinct code for timeout
-                }, timeoutMs); // Use timeoutMs here
+                    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);
-                    process.stderr.write(`Failed to start CODESYS process: ${err.message}\n`);
+                    // 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`);
+            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 (exitCode !== 0) {
-                success = false;
-                if (!output.includes(SCRIPT_ERROR_MARKER)) {
-                    // Use timeoutMs from outer scope here - NOW IT WORKS!
-                    const exitReason = exitCode === 999 ? `due to timeout (${timeoutMs}ms)` : `with non-zero code ${exitCode}`;
-                    output += `\nSCRIPT_ERROR: Process exited ${exitReason}. Check CODESYS stderr output above for details.`;
-                }
-            }
             else {
-                if (!output.includes(SCRIPT_SUCCESS_MARKER)) {
-                    process.stderr.write("Warning: CODESYS script finished with exit code 0 but no SCRIPT_SUCCESS marker found.\n");
+                // 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;
+                    }
                 }
-                success = true;
             }
         }
         catch (error) {
-            process.stderr.write(`Error executing CODESYS script: ${error}\n`);
+            process.stderr.write(`Error executing CODESYS script: ${error}\n`); // Use process.stderr
             output += `\nSCRIPT_ERROR: Failed to execute script process. ${error.message}`;
             success = false;
         }
@@ -160,16 +169,17 @@ function executeCodesysScript(scriptContent, codesysExePath, codesysProfileName)
             // Clean up the temporary file
             try {
                 yield (0, promises_1.unlink)(tempFilePath);
-                process.stderr.write(`Temporary script deleted: ${tempFilePath}\n`);
+                process.stderr.write(`Temporary script deleted: ${tempFilePath}\n`); // Use process.stderr
             }
             catch (cleanupError) {
-                process.stderr.write(`Warning: Failed to delete temporary script file ${tempFilePath}: ${cleanupError.message}\n`);
-                if (success) {
+                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`);
-        return { success, output };
+        process.stderr.write(`Final script output received:\n---\n${output}\n---\n`); // Use process.stderr
+        return { success, output }; // Revert return object
     });
 }