@codesys/mcp-toolkit 1.1.3 → 1.1.5

package/docs/index.md

@@ -1,26 +1,26 @@
-# CODESYS MCP Toolkit Documentation
-
-Welcome to the documentation for the CODESYS MCP Toolkit!
-
-## Overview
-
-The CODESYS MCP Toolkit provides a bridge between Model Context Protocol (MCP) clients and CODESYS V3 programming environments. This toolkit enables seamless interaction for automating project management, POU creation, code editing, and compilation tasks.
-
-## Components
-
-- **MCP Server**: Core component that handles MCP protocol communication
-- **CODESYS Script Integration**: Interface with CODESYS scripting engine
-- **Command-Line Interface**: For direct usage and configuration
-
-## Getting Started
-
-- [Installation](installation.md)
-- [Configuration](configuration.md)
-- [Usage Examples](examples.md)
-- [API Reference](api.md)
-
-## Advanced Topics
-
-- [Contributing Guidelines](../CONTRIBUTING.md)
-- [Troubleshooting](troubleshooting.md)
-- [Custom Extensions](extensions.md)
+# CODESYS MCP Toolkit Documentation
+
+Welcome to the documentation for the CODESYS MCP Toolkit!
+
+## Overview
+
+The CODESYS MCP Toolkit provides a bridge between Model Context Protocol (MCP) clients and CODESYS V3 programming environments. This toolkit enables seamless interaction for automating project management, POU creation, code editing, and compilation tasks.
+
+## Components
+
+- **MCP Server**: Core component that handles MCP protocol communication
+- **CODESYS Script Integration**: Interface with CODESYS scripting engine
+- **Command-Line Interface**: For direct usage and configuration
+
+## Getting Started
+
+- [Installation](installation.md)
+- [Configuration](configuration.md)
+- [Usage Examples](examples.md)
+- [API Reference](api.md)
+
+## Advanced Topics
+
+- [Contributing Guidelines](../CONTRIBUTING.md)
+- [Troubleshooting](troubleshooting.md)
+- [Custom Extensions](extensions.md)

package/docs/installation.md

@@ -1,84 +1,84 @@
-# Installation Guide
-
-This guide covers how to install the CODESYS MCP Toolkit on your system.
-
-## Prerequisites
-
-Before installing, ensure you have:
-
-1. **Node.js**: Version 18 or later
-   - Download from [nodejs.org](https://nodejs.org/)
-   - Verify installation with `node --version`
-
-2. **CODESYS V3**: A working CODESYS V3 installation 
-   - Tested with version 3.5 SP21
-   - Must have the **Scripting Engine** component enabled
-   - Verify by opening CODESYS and checking if scripting commands are available
-
-3. **MCP Client**: An MCP-enabled application (e.g., Claude Desktop)
-
-## Installation Methods
-
-### Method 1: Install from npm (Recommended)
-
-The simplest way to install is directly from npm:
-
-```bash
-npm install -g @codesys/mcp-toolkit
-```
-
-This installs the package globally on your system, making the `codesys-mcp-toolkit` command available in your terminal.
-
-Verify the installation by running:
-
-```bash
-codesys-mcp-toolkit --version
-```
-
-### Method 2: Install from Source
-
-For development or to get the latest unreleased changes:
-
-```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 .
-```
-
-Verify the installation using the same command as above.
-
-## Next Steps
-
-After installation:
-
-1. [Configure your MCP client](configuration.md) to use the CODESYS MCP Toolkit
-2. Try some [basic examples](examples.md)
-3. Learn about the [available tools and resources](api.md)
-
-## Troubleshooting Installation Issues
-
-### Common Issues
-
-- **Permission errors**: You may need to run npm with administrative privileges
-  ```bash
-  sudo npm install -g @codesys/mcp-toolkit  # On Linux/macOS
-  # or use PowerShell as Administrator on Windows
-  ```
-
-- **Path issues**: Ensure the npm global bin directory is in your PATH
-
-- **Node.js version**: Verify you have Node.js 18 or later
-  ```bash
-  node --version
-  ```
-
-If you encounter other issues, please check the [troubleshooting guide](troubleshooting.md) or [open an issue](https://github.com/yourusername/codesys-mcp-toolkit/issues) on GitHub.
+# Installation Guide
+
+This guide covers how to install the CODESYS MCP Toolkit on your system.
+
+## Prerequisites
+
+Before installing, ensure you have:
+
+1. **Node.js**: Version 18 or later
+   - Download from [nodejs.org](https://nodejs.org/)
+   - Verify installation with `node --version`
+
+2. **CODESYS V3**: A working CODESYS V3 installation 
+   - Tested with version 3.5 SP21
+   - Must have the **Scripting Engine** component enabled
+   - Verify by opening CODESYS and checking if scripting commands are available
+
+3. **MCP Client**: An MCP-enabled application (e.g., Claude Desktop)
+
+## Installation Methods
+
+### Method 1: Install from npm (Recommended)
+
+The simplest way to install is directly from npm:
+
+```bash
+npm install -g @codesys/mcp-toolkit
+```
+
+This installs the package globally on your system, making the `codesys-mcp-toolkit` command available in your terminal.
+
+Verify the installation by running:
+
+```bash
+codesys-mcp-toolkit --version
+```
+
+### Method 2: Install from Source
+
+For development or to get the latest unreleased changes:
+
+```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 .
+```
+
+Verify the installation using the same command as above.
+
+## Next Steps
+
+After installation:
+
+1. [Configure your MCP client](configuration.md) to use the CODESYS MCP Toolkit
+2. Try some [basic examples](examples.md)
+3. Learn about the [available tools and resources](api.md)
+
+## Troubleshooting Installation Issues
+
+### Common Issues
+
+- **Permission errors**: You may need to run npm with administrative privileges
+  ```bash
+  sudo npm install -g @codesys/mcp-toolkit  # On Linux/macOS
+  # or use PowerShell as Administrator on Windows
+  ```
+
+- **Path issues**: Ensure the npm global bin directory is in your PATH
+
+- **Node.js version**: Verify you have Node.js 18 or later
+  ```bash
+  node --version
+  ```
+
+If you encounter other issues, please check the [troubleshooting guide](troubleshooting.md) or [open an issue](https://github.com/yourusername/codesys-mcp-toolkit/issues) on GitHub.

package/examples/README.md

@@ -1,78 +1,78 @@
-# CODESYS MCP Toolkit Examples
-
-This directory contains examples of how to use the CODESYS MCP toolkit effectively.
-
-## Example Configuration Files
-
-### Basic MCP Configuration
-
-`claude_desktop_config.json` - Example configuration for Claude Desktop:
-
-```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"
-      ]
-    }
-  }
-}
-```
-
-## Example Prompts
-
-Here are some example prompts you can use with Claude Desktop:
-
-### Create a Motor Controller Function Block
-
-```
-Using the CODESYS Local server, please create a MotorController function block with the following:
-
-1. Properties:
-   - SpeedSetpoint (INT)
-   - ActualSpeed (INT)
-   - IsRunning (BOOL)
-
-2. Methods:
-   - Start() - Sets IsRunning to TRUE
-   - Stop() - Sets IsRunning to FALSE
-   - SetSpeed(speed: INT) - Sets SpeedSetpoint to the given value
-
-Create this in a new project at C:/MyProjects/MotorControl.project
-```
-
-### Open and Analyze an Existing Project
-
-```
-Using the CODESYS Local server, please open the project at C:/MyProjects/ExistingProject.project and show me its structure. Then, show me the code for the main POU.
-```
-
-### Compile a Project
-
-```
-Using the CODESYS Local server, please open the project at C:/MyProjects/MyProject.project and compile it. Let me know if there are any errors.
-```
-
-## Programmatic Usage Examples
-
-If you're integrating directly with the server code, here are some examples:
-
-### CLI Usage
-
-Run the server directly:
-
-```bash
-codesys-mcp-toolkit --codesys-path "C:\Program Files\CODESYS 3.5.21.0\CODESYS\Common\CODESYS.exe" --codesys-profile "CODESYS V3.5 SP21"
-```
-
-## Use Cases
-
-* Automated PLC project creation
-* Standardized Function Block library management
-* Continuous integration for CODESYS projects
-* Documentation generation from CODESYS projects
+# CODESYS MCP Toolkit Examples
+
+This directory contains examples of how to use the CODESYS MCP toolkit effectively.
+
+## Example Configuration Files
+
+### Basic MCP Configuration
+
+`claude_desktop_config.json` - Example configuration for Claude Desktop:
+
+```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"
+      ]
+    }
+  }
+}
+```
+
+## Example Prompts
+
+Here are some example prompts you can use with Claude Desktop:
+
+### Create a Motor Controller Function Block
+
+```
+Using the CODESYS Local server, please create a MotorController function block with the following:
+
+1. Properties:
+   - SpeedSetpoint (INT)
+   - ActualSpeed (INT)
+   - IsRunning (BOOL)
+
+2. Methods:
+   - Start() - Sets IsRunning to TRUE
+   - Stop() - Sets IsRunning to FALSE
+   - SetSpeed(speed: INT) - Sets SpeedSetpoint to the given value
+
+Create this in a new project at C:/MyProjects/MotorControl.project
+```
+
+### Open and Analyze an Existing Project
+
+```
+Using the CODESYS Local server, please open the project at C:/MyProjects/ExistingProject.project and show me its structure. Then, show me the code for the main POU.
+```
+
+### Compile a Project
+
+```
+Using the CODESYS Local server, please open the project at C:/MyProjects/MyProject.project and compile it. Let me know if there are any errors.
+```
+
+## Programmatic Usage Examples
+
+If you're integrating directly with the server code, here are some examples:
+
+### CLI Usage
+
+Run the server directly:
+
+```bash
+codesys-mcp-toolkit --codesys-path "C:\Program Files\CODESYS 3.5.21.0\CODESYS\Common\CODESYS.exe" --codesys-profile "CODESYS V3.5 SP21"
+```
+
+## Use Cases
+
+* Automated PLC project creation
+* Standardized Function Block library management
+* Continuous integration for CODESYS projects
+* Documentation generation from CODESYS projects

package/examples/sample_config.json

@@ -1,32 +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"
-      ]
-    },
-    "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,48 +1,48 @@
-{
-  "name": "@codesys/mcp-toolkit",
-  "version": "1.1.3",
-  "description": "Model Context Protocol (MCP) server for CODESYS automation platform",
-  "main": "dist/server.js",
-  "bin": {
-    "codesys-mcp-tool": "./dist/bin.js"
-  },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc",
-    "start": "node ./dist/server.js"
-  },
-  "keywords": [
-    "codesys",
-    "mcp",
-    "modelcontextprotocol",
-    "plc",
-    "automation",
-    "programming"
-  ],
-  "author": "Your Name <your.email@example.com>",
-  "license": "MIT",
-  "type": "commonjs",
-  "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": ">=18.0.0"
-  },
-  "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.10.2",
-    "axios": "^1.6.8",
-    "commander": "^11.1.0",
-    "yargs": "^17.7.2",
-    "zod": "^3.24.3"
-  },
-  "devDependencies": {
-    "@types/node": "^20.14.1",
-    "@types/yargs": "^17.0.33",
-    "typescript": "^5.5.3"
-  }
-}
+{
+  "name": "@codesys/mcp-toolkit",
+  "version": "1.1.5",
+  "description": "Model Context Protocol (MCP) server for CODESYS automation platform",
+  "main": "dist/server.js",
+  "bin": {
+    "codesys-mcp-tool": "./dist/bin.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tsc",
+    "start": "node ./dist/server.js"
+  },
+  "keywords": [
+    "codesys",
+    "mcp",
+    "modelcontextprotocol",
+    "plc",
+    "automation",
+    "programming"
+  ],
+  "author": "Your Name <your.email@example.com>",
+  "license": "MIT",
+  "type": "commonjs",
+  "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": ">=18.0.0"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.10.2",
+    "axios": "^1.6.8",
+    "commander": "^11.1.0",
+    "yargs": "^17.7.2",
+    "zod": "^3.24.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.17.32",
+    "@types/yargs": "^17.0.33",
+    "typescript": "^5.5.3"
+  }
+}