@codesys/mcp-toolkit 1.0.8 → 1.1.0

package/README.md

@@ -1,254 +1,151 @@
+
 # @codesys/mcp-toolkit
 
 ![npm](https://img.shields.io/npm/v/@codesys/mcp-toolkit)
 ![License](https://img.shields.io/github/license/johannesPettersson80/codesys-mcp-toolkit)
+![Node Version](https://img.shields.io/node/v/@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.
+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 via the CODESYS Scripting Engine.
 
 ## 🌟 Features
 
 - **Project Management**
-  - Open existing CODESYS projects
-  - Create new projects from templates
-  - Save project changes
+  - Open existing CODESYS projects (`open_project`)
+  - Create new projects from standard templates (`create_project`)
+  - Save project changes (`save_project`)
 
 - **POU Management**
-  - Create Programs, Function Blocks, and Functions
-  - Set declaration and implementation code
-  - Create properties and methods for Function Blocks
-  - Compile projects
+  - Create Programs, Function Blocks, and Functions (`create_pou`)
+  - Set declaration and implementation code (`set_pou_code`)
+  - Create properties for Function Blocks (`create_property`)
+  - Create methods for Function Blocks (`create_method`)
+  - Compile projects (`compile_project`)
 
 - **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
+  - `codesys://project/status`: Check scripting status and currently open project state.
+  - `codesys://project/{+project_path}/structure`: Retrieve the object structure of a specified project.
+  - `codesys://project/{+project_path}/pou/{+pou_path}/code`: Read the declaration and implementation code for a specified POU, Method, or Property accessor.
 
 ## 📋 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)
+- **CODESYS V3**: A working CODESYS V3 installation (tested with 3.5 SP21) with the **Scripting Engine** component enabled during installation.
+- **Node.js**: Version 18.0.0 or later is recommended.
+- **MCP Client**: An MCP-enabled application (e.g., Claude Desktop).
+
+*(Note: CODESYS uses Python 2.7 internally for its scripting engine, but this toolkit handles the interaction; you do not need to manage Python separately.)*
 
 ## 🚀 Installation
 
-### Option 1: Install from npm (Recommended)
+The recommended way to install is globally using npm:
 
 ```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
+This installs the package globally, making the `codesys-mcp-tool` command available in your system's terminal PATH.
 
-# Build the project
-npm run build
+*(Advanced users can also install from source for development - see CONTRIBUTING.md if available).*
 
-# Install globally
-npm install -g .
-```
+## 🔧 Configuration (IMPORTANT!)
 
-## 🔧 Configuration
+This toolkit needs to know where your CODESYS installation is and which profile to use. Configuration is typically done within your MCP Client application (like Claude Desktop).
 
-### Claude Desktop Configuration
+### Recommended Configuration Method (Direct Command)
 
-1. Locate your Claude Desktop configuration file:
-   - Windows: `C:\Users\<YourUsername>\AppData\Roaming\Claude\claude_desktop_config.json`
+Due to potential environment variable issues (especially with `PATH`) when launching Node.js tools via wrappers like `npx` within certain host applications (e.g., Claude Desktop), it is **strongly recommended** to configure your MCP client to run the installed command `codesys-mcp-tool` **directly**.
 
-2. Add the CODESYS MCP server entry:
+**Example for Claude Desktop (`settings.json` -> `mcpServers`):**
 
 ```json
 {
   "mcpServers": {
+    // ... other servers ...
     "codesys_local": {
-      "command": "npx",
+      "command": "codesys-mcp-tool", // <<< Use the direct command name
       "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"
+        // Pass arguments directly to the tool using flags
+        "--codesys-path", "C:\\Program Files\\Path\\To\\Your\\CODESYS\\Common\\CODESYS.exe",
+        "--codesys-profile", "Your CODESYS Profile Name"
+        // Optional: Add --workspace "/path/to/your/projects" if needed
       ]
     }
+    // ... other servers ...
   }
 }
 ```
 
-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
+**Key Steps:**
+1.  Replace `"C:\\Program Files\\Path\\To\\Your\\CODESYS\\Common\\CODESYS.exe"` with the **full, correct path** to your specific `CODESYS.exe` file.
+2.  Replace `"Your CODESYS Profile Name"` with the **exact name** of the CODESYS profile you want to use (visible in the CODESYS UI).
+3.  Ensure the `codesys-mcp-tool` command is accessible in the system PATH where the MCP Client application runs. Global installation via `npm install -g` usually handles this.
+4.  Restart your MCP Client application (e.g., Claude Desktop) to apply the settings changes.
 
-## 🛠️ Usage Examples
+### Alternative Configuration (Using `npx` - Not Recommended)
 
-### Creating a Function Block with Properties
+Launching with `npx` has been observed to cause immediate errors (`'C:\Program' is not recognized...`) in some environments, likely due to how `npx` handles the execution environment. **Use the Direct Command method above if possible.** If you must use `npx`:
 
+```json
+// Example using npx (POTENTIALLY PROBLEMATIC - USE WITH CAUTION):
+{
+  "mcpServers": {
+    "codesys_local": {
+      "command": "npx",
+      "args": [
+        "-y", // Tells npx to install temporarily if not found globally
+        "@codesys/mcp-toolkit",
+        // Arguments for the tool MUST come AFTER the package name
+        "--codesys-path", "C:\\Program Files\\Path\\To\\Your\\CODESYS\\Common\\CODESYS.exe",
+        "--codesys-profile", "Your CODESYS Profile Name"
+      ]
+    }
+  }
+}
 ```
-Ask Claude: "Using the CODESYS Local server, please create a Motor Controller function block with Start and Stop methods, plus CurrentSpeed property."
-```
+*(Note: The `--` separator after the package name might sometimes help `npx` but is not guaranteed to fix the environment issue.)*
 
-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
+## 🛠️ Command-Line Arguments
 
-### Opening and Compiling a Project
+When running `codesys-mcp-tool` directly or configuring it, you can use these arguments:
 
-```
-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
+*   `-p, --codesys-path <path>`: Full path to `CODESYS.exe`. (Required, overrides `CODESYS_PATH` env var, has a default but relying on it is not recommended).
+*   `-f, --codesys-profile <profile>`: Name of the CODESYS profile. (Required, overrides `CODESYS_PROFILE` env var, has a default but relying on it is not recommended).
+*   `-w, --workspace <dir>`: Workspace directory for resolving relative project paths passed to tools. Defaults to the directory where the command was launched (which might be unpredictable when run by another application). Setting this explicitly might be needed if using relative paths.
+*   `-h, --help`: Show help message.
+*   `--version`: Show package version.
 
 ## 🔍 Troubleshooting
 
-### Common Issues
+*   **`'C:\Program' is not recognized...` error immediately after connection:**
+    *   **Cause:** This typically happens when the tool is launched via `npx` within an environment like Claude Desktop. The execution environment (`PATH` variable) provided to the process likely causes an internal CODESYS command (like running Python) to fail.
+    *   **Solution:** Configure your MCP Client to run the command **directly** (`"command": "codesys-mcp-tool"`) instead of using `"command": "npx"`. See the **Recommended Configuration Method** section above.
 
-- **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
+*   **Tool Fails / Errors in Output:**
+    *   Check the logs from your MCP Client application (e.g., Claude Desktop logs). Look for `INTEROP:` messages or Python `DEBUG:` / `ERROR:` messages printed to stderr from the CODESYS script execution.
+    *   Ensure the `--codesys-path` and `--codesys-profile` arguments passed to the command are correct and point to a valid CODESYS installation with scripting enabled.
+    *   Verify the project paths and object paths you are passing to tools are correct (use forward slashes `/`).
+    *   Make sure no other CODESYS instances are running in conflicting ways (e.g., holding a lock on the profile).
 
-### Debug Logs
+*   **`command not found: codesys-mcp-tool`:**
+    *   Ensure the package was installed globally (`npm install -g @codesys/mcp-toolkit`).
+    *   Ensure the npm global bin directory is in your system's `PATH` environment variable. Find it with `npm config get prefix` and add the `bin` subdirectory (or the main directory itself on Windows) to your PATH.
 
-Check logs at:
-- Windows: `C:\Users\<YourUsername>\AppData\Roaming\Claude\logs\`
+*   **Check Logs:**
+    *   Claude Desktop logs: `C:\Users\<YourUsername>\AppData\Roaming\Claude\logs\` (Windows)
 
 ## 📖 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`)
+*(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.
 
 ## 📝 License
-
+*(Keep as is)*
 This project is licensed under the MIT License - see the [LICENSE](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

package/dist/bin.js

@@ -4,36 +4,68 @@
  * CODESYS MCP Server CLI
  * Command-line interface for starting the CODESYS MCP server
  * with configurable CODESYS executable paths and profile names.
+ *
+ * This is the entry point for the MCP toolkit when invoked as a command-line tool.
+ * It handles argument parsing and passes configuration to server.ts via function parameters.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+// Use Commander for initial parsing
 const commander_1 = require("commander");
+// Import the server setup function
+const server_js_1 = require("./server.js"); // Adjust path if needed
+console.error(">>> BIN.TS Starting <<<");
 // Define version from package.json
-const packageJson = require('../package.json');
-const version = packageJson.version;
+// Use import assertion for JSON in ES modules if possible, otherwise require is okay for CommonJS
+let version = 'unknown';
+try {
+    // Assuming CommonJS based on package.json type="commonjs"
+    const packageJson = require('../package.json');
+    version = packageJson.version;
+}
+catch (e) {
+    console.error("BIN.TS: Warning - Could not read package.json for version.", e);
+}
 commander_1.program
-    .name('codesys-mcp-toolkit')
+    .name('codesys-mcp-tool') // Set the command name users will see
     .description('Model Context Protocol (MCP) server for CODESYS automation platform')
     .version(version)
-    .option('-e, --codesys-path <path>', 'Path to CODESYS executable', 'C:\\Program Files\\CODESYS 3.5.21.0\\CODESYS\\Common\\CODESYS.exe')
-    .option('-p, --codesys-profile <profile>', 'CODESYS profile name', 'CODESYS V3.5 SP21')
-    .parse(process.argv);
+    .option(// Use options consistently
+'-p, --codesys-path <path>', 'Path to CODESYS executable (can contain spaces, use quotes if needed)', process.env.CODESYS_PATH || 'C:\\Program Files\\CODESYS 3.5.21.0\\CODESYS\\Common\\CODESYS.exe' // Default AFTER reading env var
+)
+    .option('-f, --codesys-profile <profile>', // Changed alias to 'f' to avoid conflict if you add other '-p' options
+'CODESYS profile name (overrides CODESYS_PROFILE env var)', process.env.CODESYS_PROFILE || 'CODESYS V3.5 SP21' // Default AFTER reading env var
+)
+    // Add workspace option if needed, defaults to cwd
+    .option('-w, --workspace <dir>', 'Workspace directory for relative project paths', process.cwd() // Default to current working directory
+)
+    .parse(process.argv); // Parse the arguments
 const options = commander_1.program.opts();
-// Enhanced logging for debugging purposes
+// --- Log the options Commander parsed ---
 console.error(`========================================`);
 console.error(`Starting CODESYS MCP Server v${version}`);
-console.error(`CODESYS path: ${options.codesysPath}`);
-console.error(`CODESYS profile: ${options.codesysProfile}`);
-console.error(`Using Node.js ${process.version}`);
-console.error(`Current directory: ${process.cwd()}`);
+console.error(`BIN.TS Options: ${JSON.stringify(options)}`);
+console.error(`  CODESYS Path Used: ${options.codesysPath}`);
+console.error(`  CODESYS Profile Used: ${options.codesysProfile}`);
+console.error(`  Workspace Used: ${options.workspace}`);
+console.error(`  Node.js: ${process.version}`);
 console.error(`========================================`);
-// Pass properly sanitized command line arguments
-const codesysPath = options.codesysPath.trim();
-const codesysProfile = options.codesysProfile.trim();
-// The server.js file expects these as positional parameters
-process.argv[2] = codesysPath;
-process.argv[3] = codesysProfile;
-// Also set them as environment variables as a backup mechanism
-process.env.CODESYS_PATH = codesysPath;
-process.env.CODESYS_PROFILE = codesysProfile;
-// Import and start the server
-import('./server.js');
+// --- End Logging ---
+// --- Prepare Config for Server ---
+const serverConfig = {
+    codesysPath: options.codesysPath.trim(),
+    profileName: options.codesysProfile.trim(),
+    workspaceDir: options.workspace.trim() // Pass workspace dir
+};
+// --- End Prepare Config ---
+// --- Call the server setup function ---
+console.error("BIN.TS: Calling startMcpServer...");
+(0, server_js_1.startMcpServer)(serverConfig)
+    .then(() => {
+    console.error("BIN.TS: startMcpServer finished (likely connected and listening).");
+    // Keep process alive (server handles shutdown)
+})
+    .catch(error => {
+    console.error("BIN.TS: FATAL error during server startup:", error);
+    process.exit(1);
+});
+console.error(">>> BIN.TS End of synchronous execution <<<");