@codesys/mcp-toolkit 1.5.8 → 2.0.0-alpha.0

package/README.md.enhanced

@@ -1,155 +0,0 @@
-# @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/bin.js

@@ -1,75 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-/**
- * 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
-// 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-tool') // Set the command name users will see
-    .description('Model Context Protocol (MCP) server for CODESYS automation platform')
-    .version(version)
-    .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
-)
-    // Add option to disable session management
-    .option('--no-session', 'Disable session management (use one-time script execution only)', false)
-    .parse(process.argv); // Parse the arguments
-const options = commander_1.program.opts();
-// --- Log the options Commander parsed ---
-console.error(`========================================`);
-console.error(`Starting CODESYS MCP Server v${version}`);
-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(`========================================`);
-// --- End Logging ---
-// --- Prepare Config for Server ---
-const serverConfig = {
-    codesysPath: options.codesysPath.trim(),
-    profileName: options.codesysProfile.trim(),
-    workspaceDir: options.workspace.trim(), // Pass workspace dir
-    enableSessionManagement: options.session // Determined by --no-session flag (default: true)
-};
-console.error(`BIN.TS: Session management is ${serverConfig.enableSessionManagement ? 'enabled' : 'disabled'}`);
-// --- 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 <<<");

package/dist/check_session_paths.js

@@ -1,149 +0,0 @@
-"use strict";
-/**
- * Session Path Diagnostic Tool
- * This script checks the consistency of paths used in the session management system.
- */
-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;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-const path = __importStar(require("path"));
-const os = __importStar(require("os"));
-const fs = __importStar(require("fs"));
-// Session directory paths from direct_session_command.ts
-const DIRECT_SESSION_DIR = path.join(os.tmpdir(), 'codesys_session');
-const DIRECT_COMMAND_FILE = path.join(DIRECT_SESSION_DIR, 'command.json');
-const DIRECT_RESULT_FILE = path.join(DIRECT_SESSION_DIR, 'result.json');
-const DIRECT_SESSION_LOCK_FILE = path.join(DIRECT_SESSION_DIR, 'session.lock');
-const DIRECT_STATE_FILE = path.join(DIRECT_SESSION_DIR, 'session_state.json');
-// Constants from sessionManager.ts
-const SESSION_DIR = path.join(os.tmpdir(), 'codesys_session');
-const COMMAND_FILE = 'command.json';
-const RESULT_FILE = 'result.json';
-const STATE_FILE = 'session_state.json';
-const SESSION_LOCK_FILE = 'session.lock';
-console.log("==== Session Path Diagnostics ====");
-console.log("\nBase session directory check:");
-console.log(`- DIRECT_SESSION_DIR: ${DIRECT_SESSION_DIR}`);
-console.log(`- SESSION_DIR: ${SESSION_DIR}`);
-console.log(`  Direct and manager directories match: ${DIRECT_SESSION_DIR === SESSION_DIR}`);
-console.log("\nExpected file paths in direct_session_command.ts:");
-console.log(`- Command file: ${DIRECT_COMMAND_FILE}`);
-console.log(`- Result file: ${DIRECT_RESULT_FILE}`);
-console.log(`- Lock file: ${DIRECT_SESSION_LOCK_FILE}`);
-console.log(`- State file: ${DIRECT_STATE_FILE}`);
-console.log("\nFile names in sessionManager.ts:");
-console.log(`- Command file: ${COMMAND_FILE}`);
-console.log(`- Result file: ${RESULT_FILE}`);
-console.log(`- Lock file: ${SESSION_LOCK_FILE}`);
-console.log(`- State file: ${STATE_FILE}`);
-console.log("\nFile existence checks:");
-console.log(`- Base session directory exists: ${fs.existsSync(SESSION_DIR)}`);
-if (fs.existsSync(SESSION_DIR)) {
-    console.log(`- Command file exists: ${fs.existsSync(DIRECT_COMMAND_FILE)}`);
-    console.log(`- Result file exists: ${fs.existsSync(DIRECT_RESULT_FILE)}`);
-    console.log(`- Lock file exists: ${fs.existsSync(DIRECT_SESSION_LOCK_FILE)}`);
-    console.log(`- State file exists: ${fs.existsSync(DIRECT_STATE_FILE)}`);
-    console.log("\nContent checks (if files exist):");
-    if (fs.existsSync(DIRECT_COMMAND_FILE)) {
-        try {
-            const commandContent = fs.readFileSync(DIRECT_COMMAND_FILE, 'utf8');
-            console.log(`- Command file content: ${commandContent.substring(0, 150)}...`);
-            try {
-                const commandJson = JSON.parse(commandContent);
-                console.log(`  Status: ${commandJson.status}`);
-                console.log(`  Has command object: ${commandJson.command !== null}`);
-                if (commandJson.command) {
-                    console.log(`  Command type: ${commandJson.command.type}`);
-                }
-            }
-            catch (e) {
-                console.log(`  Error parsing command file JSON: ${e}`);
-            }
-        }
-        catch (e) {
-            console.log(`- Error reading command file: ${e}`);
-        }
-    }
-    if (fs.existsSync(DIRECT_RESULT_FILE)) {
-        try {
-            const resultContent = fs.readFileSync(DIRECT_RESULT_FILE, 'utf8');
-            console.log(`- Result file content: ${resultContent.substring(0, 150)}...`);
-            try {
-                const resultJson = JSON.parse(resultContent);
-                console.log(`  Status: ${resultJson.status}`);
-                console.log(`  Has result object: ${resultJson.result !== null}`);
-            }
-            catch (e) {
-                console.log(`  Error parsing result file JSON: ${e}`);
-            }
-        }
-        catch (e) {
-            console.log(`- Error reading result file: ${e}`);
-        }
-    }
-    if (fs.existsSync(DIRECT_SESSION_LOCK_FILE)) {
-        try {
-            const lockContent = fs.readFileSync(DIRECT_SESSION_LOCK_FILE, 'utf8');
-            console.log(`- Lock file content: ${lockContent}`);
-            const lockTime = parseFloat(lockContent);
-            const currentTime = Date.now() / 1000; // convert to seconds
-            const lockAgeSeconds = currentTime - lockTime;
-            console.log(`  Lock age: ${lockAgeSeconds.toFixed(1)} seconds`);
-        }
-        catch (e) {
-            console.log(`- Error reading lock file: ${e}`);
-        }
-    }
-    if (fs.existsSync(DIRECT_STATE_FILE)) {
-        try {
-            const stateContent = fs.readFileSync(DIRECT_STATE_FILE, 'utf8');
-            console.log(`- State file content: ${stateContent.substring(0, 150)}...`);
-            try {
-                const stateJson = JSON.parse(stateContent);
-                console.log(`  Session ID: ${stateJson.sessionId || stateJson.session_id}`);
-                console.log(`  Status: ${stateJson.status}`);
-            }
-            catch (e) {
-                console.log(`  Error parsing state file JSON: ${e}`);
-            }
-        }
-        catch (e) {
-            console.log(`- Error reading state file: ${e}`);
-        }
-    }
-}
-else {
-    console.log("  Cannot check files as base directory does not exist");
-}
-console.log("\n==== End of Session Path Diagnostics ====");