@codesys/mcp-toolkit 1.0.1 → 1.0.4

package/README.md

@@ -1,254 +1,254 @@
-# @codesys/mcp-toolkit
-
-![npm](https://img.shields.io/npm/v/@codesys/mcp-toolkit)
-![License](https://img.shields.io/github/license/johannesPettersson80/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.
-
-## 🌟 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/johannesPettersson80/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\`
-
-## 📖 Detailed OOP Workflow Guide
-
-When creating object-oriented structures with this toolkit, follow this step-by-step workflow for best results:
-
-### Creating Function Blocks with Properties and Methods
-
-1. **Create the Function Block**
-   ```
-   create_pou(
-     projectFilePath: "path/to/project.project",
-     name: "PumpController", 
-     type: "FunctionBlock",
-     language: "ST",
-     parentPath: "Application"
-   )
-   ```
-
-2. **Create Properties**
-   ```
-   create_property(
-     projectFilePath: "path/to/project.project",
-     parentPouPath: "Application/PumpController",
-     propertyName: "SpeedSetpoint",
-     propertyType: "INT"
-   )
-   ```
-
-3. **Create Methods**
-   ```
-   create_method(
-     projectFilePath: "path/to/project.project",
-     parentPouPath: "Application/PumpController",
-     methodName: "Start",
-     returnType: "" // Empty for no return value
-   )
-   ```
-
-4. **Implement Methods**
-   ```
-   set_pou_code(
-     projectFilePath: "path/to/project.project",
-     pouPath: "Application/PumpController/Start",
-     implementationCode: "isRunning := TRUE;"
-   )
-   ```
-
-5. **Declare Backing Variables**
-   ```
-   set_pou_code(
-     projectFilePath: "path/to/project.project",
-     pouPath: "Application/PumpController",
-     declarationCode: "VAR PRIVATE\n  _speedSetpoint : INT;\n  _isRunning : BOOL;\nEND_VAR"
-   )
-   ```
-
-6. **Implement Property Accessors**
-   - For GET accessor:
-     ```
-     set_pou_code(
-       projectFilePath: "path/to/project.project",
-       pouPath: "Application/PumpController/SpeedSetpoint/Get",
-       implementationCode: "SpeedSetpoint := _speedSetpoint;"
-     )
-     ```
-   - For SET accessor:
-     ```
-     set_pou_code(
-       projectFilePath: "path/to/project.project",
-       pouPath: "Application/PumpController/SpeedSetpoint/Set",
-       implementationCode: "_speedSetpoint := SpeedSetpoint;"
-     )
-     ```
-
-7. **Save Project**
-   ```
-   save_project(
-     projectFilePath: "path/to/project.project"
-   )
-   ```
-
-### Important Path Usage Notes
-
-- Use forward slashes (`/`) in all object paths
-- Ensure paths are precise and target the specific object
-- For property accessors, always specify the full path including `/Get` or `/Set`
-
-### CODESYS Naming Conventions
-
-- **POUs** (Programs, FBs, Functions): PascalCase (e.g., `MotorControl`)
-- **Interfaces**: PascalCase with I_ prefix (e.g., `I_AxisCommands`)
-- **DUTs** (Structs, Enums): PascalCase (e.g., `MachineState`, `E_OperationMode`)
-- **Variables**: camelCase (e.g., `motorSpeed`)
-- **Backing variables**: camelCase with _ prefix (e.g., `_speedSetpoint`)
-- **Constants**: UPPER_SNAKE_CASE (e.g., `MAX_RPM`)
-- **Properties & Methods**: PascalCase with descriptive names
-
-### Recommended Property Naming
-
-- Control values: Add `Setpoint` suffix (e.g., `SpeedSetpoint`)
-- Measured values: Add `Actual` suffix (e.g., `TemperatureActual`)
-- Status indicators: Use `Is` or `Has` prefix (e.g., `IsRunning`, `HasError`)
-- Configuration: Use descriptive prefixes (e.g., `MaxSpeed`, `MinPressure`)
-
-## 🤝 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/johannesPettersson80/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.
+
+## 🌟 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/johannesPettersson80/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\`
+
+## 📖 Detailed OOP Workflow Guide
+
+When creating object-oriented structures with this toolkit, follow this step-by-step workflow for best results:
+
+### Creating Function Blocks with Properties and Methods
+
+1. **Create the Function Block**
+   ```
+   create_pou(
+     projectFilePath: "path/to/project.project",
+     name: "PumpController", 
+     type: "FunctionBlock",
+     language: "ST",
+     parentPath: "Application"
+   )
+   ```
+
+2. **Create Properties**
+   ```
+   create_property(
+     projectFilePath: "path/to/project.project",
+     parentPouPath: "Application/PumpController",
+     propertyName: "SpeedSetpoint",
+     propertyType: "INT"
+   )
+   ```
+
+3. **Create Methods**
+   ```
+   create_method(
+     projectFilePath: "path/to/project.project",
+     parentPouPath: "Application/PumpController",
+     methodName: "Start",
+     returnType: "" // Empty for no return value
+   )
+   ```
+
+4. **Implement Methods**
+   ```
+   set_pou_code(
+     projectFilePath: "path/to/project.project",
+     pouPath: "Application/PumpController/Start",
+     implementationCode: "isRunning := TRUE;"
+   )
+   ```
+
+5. **Declare Backing Variables**
+   ```
+   set_pou_code(
+     projectFilePath: "path/to/project.project",
+     pouPath: "Application/PumpController",
+     declarationCode: "VAR PRIVATE\n  _speedSetpoint : INT;\n  _isRunning : BOOL;\nEND_VAR"
+   )
+   ```
+
+6. **Implement Property Accessors**
+   - For GET accessor:
+     ```
+     set_pou_code(
+       projectFilePath: "path/to/project.project",
+       pouPath: "Application/PumpController/SpeedSetpoint/Get",
+       implementationCode: "SpeedSetpoint := _speedSetpoint;"
+     )
+     ```
+   - For SET accessor:
+     ```
+     set_pou_code(
+       projectFilePath: "path/to/project.project",
+       pouPath: "Application/PumpController/SpeedSetpoint/Set",
+       implementationCode: "_speedSetpoint := SpeedSetpoint;"
+     )
+     ```
+
+7. **Save Project**
+   ```
+   save_project(
+     projectFilePath: "path/to/project.project"
+   )
+   ```
+
+### Important Path Usage Notes
+
+- Use forward slashes (`/`) in all object paths
+- Ensure paths are precise and target the specific object
+- For property accessors, always specify the full path including `/Get` or `/Set`
+
+### CODESYS Naming Conventions
+
+- **POUs** (Programs, FBs, Functions): PascalCase (e.g., `MotorControl`)
+- **Interfaces**: PascalCase with I_ prefix (e.g., `I_AxisCommands`)
+- **DUTs** (Structs, Enums): PascalCase (e.g., `MachineState`, `E_OperationMode`)
+- **Variables**: camelCase (e.g., `motorSpeed`)
+- **Backing variables**: camelCase with _ prefix (e.g., `_speedSetpoint`)
+- **Constants**: UPPER_SNAKE_CASE (e.g., `MAX_RPM`)
+- **Properties & Methods**: PascalCase with descriptive names
+
+### Recommended Property Naming
+
+- Control values: Add `Setpoint` suffix (e.g., `SpeedSetpoint`)
+- Measured values: Add `Actual` suffix (e.g., `TemperatureActual`)
+- Status indicators: Use `Is` or `Has` prefix (e.g., `IsRunning`, `HasError`)
+- Configuration: Use descriptive prefixes (e.g., `MaxSpeed`, `MinPressure`)
+
+## 🤝 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