@codesys/mcp-toolkit 1.1.7 → 1.1.9

package/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.9] - 2025-05-06
+
+### Added
+- Added three new MCP tools that were previously only available as resources:
+  - `check_status`: Tool to check CODESYS environment and open project status
+  - `get_project_structure`: Tool to retrieve the structure of a CODESYS project
+  - `get_pou_code`: Tool to retrieve code from a specific POU
+- These tools allow Claude and other AI assistants to directly access project inspection functionality
+
+## [1.1.8] - 2025-05-06
+
+### Fixed
+- Enhanced create_pou script to automatically find the Application object when only "Application" is specified as the parent path
+- Added better error messages with suggestions when Application isn't found
+
 ## [1.1.7] - 2025-05-06
 
 ### Fixed

package/dist/scripts/create_pou.py

@@ -35,9 +35,52 @@ try:
     pou_type_enum = pou_type_map.get(POU_TYPE_STR)
     if not pou_type_enum: raise ValueError("Invalid POU type string: %s. Use Program, FunctionBlock, or Function." % POU_TYPE_STR)
 
-    # Find parent object using the robust function
-    parent_object = find_object_by_path_robust(primary_project, PARENT_PATH_REL, "parent container")
-    if not parent_object: raise ValueError("Parent object not found for path: %s" % PARENT_PATH_REL)
+    # For common case where user just specified "Application", automatically try to find it
+    if PARENT_PATH_REL == "Application":
+        # Get project name from file path to build the likely full path
+        project_name = os.path.splitext(os.path.basename(PROJECT_FILE_PATH))[0]
+        potential_paths = [
+            PARENT_PATH_REL,                      # Original "Application"
+            f"{project_name}.{PARENT_PATH_REL}",  # "projectName.Application"
+            f"{project_name}/{PARENT_PATH_REL}",  # "projectName/Application"
+            f"{project_name}"                     # Just the project name itself might work
+        ]
+        
+        print(f"DEBUG: Parent path is simply 'Application', trying several variants to find it")
+        
+        # Try each potential path until one works
+        parent_object = None
+        for path in potential_paths:
+            print(f"DEBUG: Attempting to find parent with path: '{path}'")
+            parent_candidate = find_object_by_path_robust(primary_project, path, "parent container")
+            if parent_candidate:
+                parent_object = parent_candidate
+                print(f"DEBUG: Successfully found parent using path: '{path}'")
+                break
+                
+        if not parent_object:
+            # For diagnostics, try to get the application object directly as a fallback
+            print("DEBUG: All path attempts failed. Trying to access application directly...")
+            try:
+                if hasattr(primary_project, 'active_application'):
+                    app = primary_project.active_application
+                    if app:
+                        parent_object = app
+                        print(f"DEBUG: Found application object directly: {app.get_name()}")
+                if not parent_object and hasattr(primary_project, 'find'):
+                    apps = primary_project.find("Application", True)
+                    if apps:
+                        parent_object = apps[0]
+                        print(f"DEBUG: Found application via search: {parent_object.get_name()}")
+            except Exception as e:
+                print(f"ERROR: Direct application access also failed: {e}")
+    else:
+        # Use the provided path normally
+        parent_object = find_object_by_path_robust(primary_project, PARENT_PATH_REL, "parent container")
+    
+    # Final check if parent was found
+    if not parent_object: 
+        raise ValueError("Parent object not found for path: %s. Try using the full path like 'ProjectName.Application' or run get_project_structure first to see the correct structure." % PARENT_PATH_REL)
 
     parent_name = getattr(parent_object, 'get_name', lambda: str(parent_object))()
     print("DEBUG: Using parent object: %s (Type: %s)" % (parent_name, type(parent_object).__name__))

package/dist/server.js

@@ -619,6 +619,153 @@ function startMcpServer(config) {
                 };
             }
         }));
+        server.tool("check_status", "Checks the status of the CODESYS environment and any open project", {}, () => __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            console.error(`Tool call: check_status`);
+            try {
+                const scriptContent = yield (0, scriptLoader_1.loadScriptTemplate)('check_status');
+                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName);
+                if (!result.success) {
+                    return {
+                        content: [{ type: "text", text: `Failed to check CODESYS status: ${result.output}` }],
+                        isError: true
+                    };
+                }
+                const outputLines = result.output.split(/[\r\n]+/).filter(line => line.trim());
+                const statusData = {};
+                outputLines.forEach(line => {
+                    const match = line.match(/^([^:]+):\s*(.*)$/);
+                    if (match) {
+                        statusData[match[1].trim()] = match[2].trim();
+                    }
+                });
+                const statusText = `CODESYS Status:\n - Scripting OK: ${(_a = statusData['Scripting OK']) !== null && _a !== void 0 ? _a : 'Unknown'}\n - Project Open: ${(_b = statusData['Project Open']) !== null && _b !== void 0 ? _b : 'Unknown'}\n - Project Name: ${(_c = statusData['Project Name']) !== null && _c !== void 0 ? _c : 'Unknown'}\n - Project Path: ${(_d = statusData['Project Path']) !== null && _d !== void 0 ? _d : 'N/A'}`;
+                return {
+                    content: [{ type: "text", text: statusText }],
+                    isError: false
+                };
+            }
+            catch (error) {
+                console.error(`Error checking status:`, error);
+                return {
+                    content: [{ type: "text", text: `Failed to check CODESYS status: ${error.message}` }],
+                    isError: true
+                };
+            }
+        }));
+        server.tool("get_pou_code", "Retrieves the code (declaration and implementation) of a POU from a CODESYS project", {
+            projectFilePath: zod_1.z.string().describe("Path to the CODESYS project file."),
+            pouPath: zod_1.z.string().describe("Path to the POU within the project (e.g., 'Application/MyFB').")
+        }, (args) => __awaiter(this, void 0, void 0, function* () {
+            const { projectFilePath, pouPath } = args;
+            let absPath = path.normalize(path.isAbsolute(projectFilePath) ? projectFilePath : path.join(WORKSPACE_DIR, projectFilePath));
+            const sanitizedPouPath = String(pouPath).replace(/\\/g, '/').replace(/^\/+|\/+$/g, '');
+            console.error(`Tool call: get_pou_code: Project='${absPath}', POU='${sanitizedPouPath}'`);
+            try {
+                // Load script template and prepare parameters
+                const scriptTemplate = yield (0, scriptLoader_1.loadScriptTemplate)('get_pou_code');
+                const ensureProjectOpenTemplate = yield (0, scriptLoader_1.loadScriptTemplate)('ensure_project_open');
+                const findObjectByPathTemplate = yield (0, scriptLoader_1.loadScriptTemplate)('find_object_by_path');
+                const combinedScript = ensureProjectOpenTemplate + '\n\n' + findObjectByPathTemplate + '\n\n' + scriptTemplate;
+                const scriptContent = (0, scriptLoader_1.interpolateScript)(combinedScript, {
+                    'PROJECT_FILE_PATH': absPath.replace(/\\/g, '\\\\'),
+                    'POU_FULL_PATH': sanitizedPouPath
+                });
+                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName);
+                if (!result.success) {
+                    return {
+                        content: [{ type: "text", text: `Failed to get POU code: ${result.output}` }],
+                        isError: true
+                    };
+                }
+                const declStartMarker = "### POU DECLARATION START ###";
+                const declEndMarker = "### POU DECLARATION END ###";
+                const implStartMarker = "### POU IMPLEMENTATION START ###";
+                const implEndMarker = "### POU IMPLEMENTATION END ###";
+                const declStartIdx = result.output.indexOf(declStartMarker);
+                const declEndIdx = result.output.indexOf(declEndMarker);
+                const implStartIdx = result.output.indexOf(implStartMarker);
+                const implEndIdx = result.output.indexOf(implEndMarker);
+                let declaration = "/* Declaration not found in output */";
+                let implementation = "/* Implementation not found in output */";
+                let isError = false;
+                if (declStartIdx !== -1 && declEndIdx !== -1 && declStartIdx < declEndIdx) {
+                    declaration = result.output.substring(declStartIdx + declStartMarker.length, declEndIdx).replace(/\\n/g, '\n').trim();
+                }
+                else {
+                    console.error(`WARN: Declaration markers not found correctly for ${sanitizedPouPath}`);
+                    isError = true;
+                }
+                if (implStartIdx !== -1 && implEndIdx !== -1 && implStartIdx < implEndIdx) {
+                    implementation = result.output.substring(implStartIdx + implStartMarker.length, implEndIdx).replace(/\\n/g, '\n').trim();
+                }
+                else {
+                    console.error(`WARN: Implementation markers not found correctly for ${sanitizedPouPath}`);
+                    isError = true;
+                }
+                const codeText = `// ----- Declaration -----\n${declaration}\n\n// ----- Implementation -----\n${implementation}`;
+                return {
+                    content: [{ type: "text", text: codeText }],
+                    isError: isError
+                };
+            }
+            catch (error) {
+                console.error(`Error getting POU code:`, error);
+                return {
+                    content: [{ type: "text", text: `Failed to get POU code for '${pouPath}' in '${projectFilePath}': ${error.message}` }],
+                    isError: true
+                };
+            }
+        }));
+        server.tool("get_project_structure", "Retrieves the structure of a CODESYS project including its POUs, methods, properties, etc.", {
+            projectFilePath: zod_1.z.string().describe("Path to the CODESYS project file to examine.")
+        }, (args) => __awaiter(this, void 0, void 0, function* () {
+            const { projectFilePath } = args;
+            let absPath = path.normalize(path.isAbsolute(projectFilePath) ? projectFilePath : path.join(WORKSPACE_DIR, projectFilePath));
+            console.error(`Tool call: get_project_structure: ${absPath}`);
+            try {
+                // Load the script templates and prepare with parameters
+                const scriptTemplate = yield (0, scriptLoader_1.loadScriptTemplate)('get_project_structure');
+                const ensureProjectOpenTemplate = yield (0, scriptLoader_1.loadScriptTemplate)('ensure_project_open');
+                const combinedScript = ensureProjectOpenTemplate + '\n\n' + scriptTemplate;
+                const scriptContent = (0, scriptLoader_1.interpolateScript)(combinedScript, {
+                    'PROJECT_FILE_PATH': absPath.replace(/\\/g, '\\\\')
+                });
+                const result = yield (0, codesys_interop_1.executeCodesysScript)(scriptContent, codesysExePath, codesysProfileName);
+                if (!result.success) {
+                    return {
+                        content: [{ type: "text", text: `Failed to get project structure: ${result.output}` }],
+                        isError: true
+                    };
+                }
+                // Extract the structure from the output
+                let structureText = '';
+                const startMarker = "--- PROJECT STRUCTURE START ---";
+                const endMarker = "--- PROJECT STRUCTURE END ---";
+                const startIndex = result.output.indexOf(startMarker);
+                const endIndex = result.output.indexOf(endMarker);
+                if (startIndex !== -1 && endIndex !== -1 && startIndex < endIndex) {
+                    structureText = result.output.substring(startIndex + startMarker.length, endIndex).replace(/\\n/g, '\n').trim();
+                    return {
+                        content: [{ type: "text", text: structureText }],
+                        isError: false
+                    };
+                }
+                else {
+                    return {
+                        content: [{ type: "text", text: `Could not parse structure markers in output for ${absPath}.\n\nOutput:\n${result.output}` }],
+                        isError: true
+                    };
+                }
+            }
+            catch (error) {
+                console.error(`Error tool get_project_structure:`, error);
+                return {
+                    content: [{ type: "text", text: `Failed to get project structure for '${projectFilePath}': ${error.message}` }],
+                    isError: true
+                };
+            }
+        }));
         server.tool("compile_project", "Compiles (Builds) the primary application within a CODESYS project.", {
             projectFilePath: zod_1.z.string().describe("Path to the project file containing the application to compile (e.g., 'C:/Projects/MyPLC.project').")
         }, (args) => __awaiter(this, void 0, void 0, function* () {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codesys/mcp-toolkit",
-  "version": "1.1.7",
+  "version": "1.1.9",
   "description": "Model Context Protocol (MCP) server for CODESYS automation platform",
   "main": "dist/server.js",
   "bin": {

package/src/scripts/create_pou.py

@@ -35,9 +35,52 @@ try:
     pou_type_enum = pou_type_map.get(POU_TYPE_STR)
     if not pou_type_enum: raise ValueError("Invalid POU type string: %s. Use Program, FunctionBlock, or Function." % POU_TYPE_STR)
 
-    # Find parent object using the robust function
-    parent_object = find_object_by_path_robust(primary_project, PARENT_PATH_REL, "parent container")
-    if not parent_object: raise ValueError("Parent object not found for path: %s" % PARENT_PATH_REL)
+    # For common case where user just specified "Application", automatically try to find it
+    if PARENT_PATH_REL == "Application":
+        # Get project name from file path to build the likely full path
+        project_name = os.path.splitext(os.path.basename(PROJECT_FILE_PATH))[0]
+        potential_paths = [
+            PARENT_PATH_REL,                      # Original "Application"
+            f"{project_name}.{PARENT_PATH_REL}",  # "projectName.Application"
+            f"{project_name}/{PARENT_PATH_REL}",  # "projectName/Application"
+            f"{project_name}"                     # Just the project name itself might work
+        ]
+        
+        print(f"DEBUG: Parent path is simply 'Application', trying several variants to find it")
+        
+        # Try each potential path until one works
+        parent_object = None
+        for path in potential_paths:
+            print(f"DEBUG: Attempting to find parent with path: '{path}'")
+            parent_candidate = find_object_by_path_robust(primary_project, path, "parent container")
+            if parent_candidate:
+                parent_object = parent_candidate
+                print(f"DEBUG: Successfully found parent using path: '{path}'")
+                break
+                
+        if not parent_object:
+            # For diagnostics, try to get the application object directly as a fallback
+            print("DEBUG: All path attempts failed. Trying to access application directly...")
+            try:
+                if hasattr(primary_project, 'active_application'):
+                    app = primary_project.active_application
+                    if app:
+                        parent_object = app
+                        print(f"DEBUG: Found application object directly: {app.get_name()}")
+                if not parent_object and hasattr(primary_project, 'find'):
+                    apps = primary_project.find("Application", True)
+                    if apps:
+                        parent_object = apps[0]
+                        print(f"DEBUG: Found application via search: {parent_object.get_name()}")
+            except Exception as e:
+                print(f"ERROR: Direct application access also failed: {e}")
+    else:
+        # Use the provided path normally
+        parent_object = find_object_by_path_robust(primary_project, PARENT_PATH_REL, "parent container")
+    
+    # Final check if parent was found
+    if not parent_object: 
+        raise ValueError("Parent object not found for path: %s. Try using the full path like 'ProjectName.Application' or run get_project_structure first to see the correct structure." % PARENT_PATH_REL)
 
     parent_name = getattr(parent_object, 'get_name', lambda: str(parent_object))()
     print("DEBUG: Using parent object: %s (Type: %s)" % (parent_name, type(parent_object).__name__))