codesysultra 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+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.16] - 2025-05-06
+
+### Fixed
+- Reverted to v1.1.3 code base which has working POU creation functionality
+- Fixed path handling by using simpler approach from v1.1.3
+- Restored original Application object finding logic that worked in v1.1.3
+
+## [1.0.0] - 2025-04-23
+
+### Added
+- Initial release of the MCP server for CODESYS
+- Command-line interface with configuration options
+- Project management functionality:
+  - Opening existing CODESYS projects
+  - Creating new CODESYS projects
+  - Saving projects
+- POU (Program Organization Unit) management:
+  - Creating POUs (Programs, Function Blocks, Functions)
+  - Setting POU code (declaration and implementation)
+  - Creating properties and methods for Function Blocks
+- Project compilation support
+- Resources for querying:
+  - Project status
+  - Project structure
+  - POU code
+- Documentation for installation and usage

package/CONTRIBUTING.md

@@ -0,0 +1,72 @@
+# Contributing to @codesys/mcp-toolkit
+
+Thank you for considering contributing to the CODESYS MCP Toolkit! This document provides guidelines and steps for contributing.
+
+## Code of Conduct
+
+Please be respectful and considerate of others when contributing to this project. We aim to foster an inclusive and welcoming community.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+Bug reports help improve the project! When reporting bugs:
+
+1. Check if the bug has already been reported
+2. Use the bug report template
+3. Include detailed steps to reproduce the issue
+4. Describe the expected vs. actual behavior
+5. Include screenshots if applicable
+6. Provide environment details (OS, Node.js version, etc.)
+
+### Suggesting Features
+
+We welcome feature suggestions! When suggesting features:
+
+1. Describe the problem your feature would solve
+2. Explain how your feature would work
+3. Consider potential alternatives
+4. Provide examples of similar features in other projects (if applicable)
+
+### Pull Requests
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes
+4. Run tests and ensure they pass
+5. Commit your changes (`git commit -m 'Add amazing feature'`)
+6. Push to your branch (`git push origin feature/amazing-feature`)
+7. Open a Pull Request
+
+## Development Setup
+
+1. Clone the repository
+   ```bash
+   git clone https://github.com/yourusername/codesys-mcp-toolkit.git
+   cd codesys-mcp-toolkit
+   ```
+
+2. Install dependencies
+   ```bash
+   npm install
+   ```
+
+3. Build the project
+   ```bash
+   npm run build
+   ```
+
+## Style Guidelines
+
+- Follow existing code formatting patterns
+- Use meaningful variable and function names
+- Add comments where necessary to explain complex logic
+- Update documentation when changing functionality
+
+## Testing
+
+- Add tests for new features
+- Ensure all tests pass before submitting a PR
+- Consider edge cases in your tests
+
+Thank you for contributing!

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Nirithy
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,156 @@
+# CodeSysUltra
+
+一个为 CODESYS V3 编程环境设计的强大工具包，通过模型上下文协议（MCP）实现与 CODESYS 的无缝集成。
+
+## 简介
+
+CodeSysUltra 是一个基于 Node.js 的 MCP 服务器，它允许你通过 MCP 客户端（如 Claude Desktop）与 CODESYS V3 进行交互。利用 CODESYS 的脚本引擎，你可以自动化项目管理、POU 创建、代码编辑和编译等任务。
+
+## 核心功能
+
+### 项目管理
+- 打开现有的 CODESYS 项目
+- 从标准模板创建新项目
+- 保存项目更改
+
+### POU 管理
+- 创建程序、功能块和函数
+- 设置声明和实现代码
+- 为功能块创建属性
+- 为功能块创建方法
+- 编译项目
+
+### MCP 资源
+- `codesys://project/status` - 检查脚本状态和当前打开的项目状态
+- `codesys://project/{+project_path}/structure` - 获取指定项目的对象结构
+- `codesys://project/{+project_path}/pou/{+pou_path}/code` - 读取指定 POU、方法或属性访问器的声明和实现代码
+
+## 环境要求
+
+- **CODESYS V3**：已安装的 CODESYS V3（测试版本 3.5 SP21），并在安装时启用了**脚本引擎**组件
+- **Node.js**：建议使用 18.0.0 或更高版本
+- **MCP 客户端**：支持 MCP 的应用程序（例如 Claude Desktop）
+
+> 注意：CODESYS 内部使用 Python 2.7 作为脚本引擎，但本工具包会处理所有交互，你无需单独管理 Python。
+
+## 安装方法
+
+### 全局安装（推荐）
+
+使用 npm 进行全局安装：
+
+```bash
+npm install -g codesysultra
+```
+
+安装后，`codesys-mcp-tool` 命令将可在系统终端中使用。
+
+### 从源码安装
+
+高级用户也可以从源码进行开发安装（如有需要，请参考 CONTRIBUTING.md）。
+
+## 配置说明
+
+本工具包需要知道你的 CODESYS 安装位置和要使用的配置文件。配置通常在 MCP 客户端应用程序（如 Claude Desktop）中完成。
+
+### 推荐配置方式（直接命令）
+
+由于在某些宿主应用程序（如 Claude Desktop）中通过 `npx` 启动 Node.js 工具时可能会出现环境变量问题（特别是 `PATH`），**强烈建议**配置 MCP 客户端直接运行已安装的 `codesys-mcp-tool` 命令。
+
+**Claude Desktop 配置示例（`settings.json` -> `mcpServers`）：**
+
+```json
+{
+  "mcpServers": {
+    "codesys_local": {
+      "command": "codesys-mcp-tool",
+      "args": [
+        "--codesys-path", "C:\\Program Files\\CODESYS\\Common\\CODESYS.exe",
+        "--codesys-profile", "你的配置文件名称"
+      ]
+    }
+  }
+}
+```
+
+**配置步骤：**
+1. 将 `"C:\\Program Files\\CODESYS\\Common\\CODESYS.exe"` 替换为你实际的 `CODESYS.exe` 文件的完整路径
+2. 将 `"你的配置文件名称"` 替换为你要使用的 CODESYS 配置文件的确切名称（在 CODESYS 界面中可见）
+3. 确保 `codesys-mcp-tool` 命令在 MCP 客户端运行的系统 PATH 中可访问。通过 `npm install -g` 全局安装通常会自动处理
+4. 重启 MCP 客户端应用程序（如 Claude Desktop）以应用设置更改
+
+### 备选配置方式（使用 npx - 不推荐）
+
+使用 `npx` 启动在某些环境中已被观察到会导致立即错误（如 `'C:\Program' is not recognized...`），这可能是由于 `npx` 处理执行环境的方式造成的。**如果可能，请使用上述直接命令方法。**
+
+```json
+{
+  "mcpServers": {
+    "codesys_local": {
+      "command": "npx",
+      "args": [
+        "-y",
+        "codesysultra",
+        "--codesys-path", "C:\\Program Files\\CODESYS\\Common\\CODESYS.exe",
+        "--codesys-profile", "你的配置文件名称"
+      ]
+    }
+  }
+}
+```
+
+## 命令行参数
+
+直接运行 `codesys-mcp-tool` 或配置时，可以使用以下参数：
+
+- `-p, --codesys-path <path>` - `CODESYS.exe` 的完整路径（必需，覆盖 `CODESYS_PATH` 环境变量）
+- `-f, --codesys-profile <profile>` - CODESYS 配置文件名称（必需，覆盖 `CODESYS_PROFILE` 环境变量）
+- `-w, --workspace <dir>` - 工作区目录，用于解析传递给工具的相对项目路径。默认为命令启动的目录
+- `-h, --help` - 显示帮助信息
+- `--version` - 显示包版本
+
+## 常见问题
+
+### 连接后立即出现 `'C:\Program' is not recognized...` 错误
+
+**原因**：这通常发生在通过 `npx` 在 Claude Desktop 等环境中启动工具时。提供给进程的执行环境（`PATH` 变量）可能导致内部 CODESYS 命令（如运行 Python）失败。
+
+**解决方案**：配置 MCP 客户端直接运行命令（`"command": "codesys-mcp-tool"`），而不是使用 `"command": "npx"`。参见上面的推荐配置方式。
+
+### 工具失败 / 输出中出现错误
+
+- 检查 MCP 客户端应用程序的日志（例如 Claude Desktop 日志）。查找 `INTEROP:` 消息或从 CODESYS 脚本执行打印到 stderr 的 Python `DEBUG:` / `ERROR:` 消息
+- 确保传递给命令的 `--codesys-path` 和 `--codesys-profile` 参数正确，并指向启用了脚本的有效 CODESYS 安装
+- 验证传递给工具的项目路径和对象路径是否正确（使用正斜杠 `/`）
+- 确保没有其他 CODESYS 实例以冲突的方式运行（例如，锁定配置文件）
+
+### 找不到命令 `codesys-mcp-tool`
+
+- 确保已全局安装包（`npm install -g codesysultra`）
+- 确保 npm 全局 bin 目录在系统的 `PATH` 环境变量中。使用 `npm config get prefix` 查找，并将 `bin` 子目录（Windows 上为主目录本身）添加到你的 PATH
+
+### 查看日志
+
+- Claude Desktop 日志：`C:\Users\<你的用户名>\AppData\Roaming\Claude\logs\`（Windows）
+
+## 贡献指南
+
+欢迎贡献、提出问题和功能请求！随时查看问题页面。
+
+## 许可证
+
+本项目采用 Apache License 2.0 许可证 - 详见 LICENSE 文件。
+
+## 致谢
+
+- CODESYS GmbH 团队提供了强大的 CODESYS 平台及其脚本引擎
+- 模型上下文协议项目定义了交互标准
+- 所有帮助改进此工具包的贡献者和用户
+
+## 版本历史
+
+当前版本：1.0
+
+## 联系方式
+
+如有问题或建议，请通过 GitHub Issues 联系我们。

package/dist/bin.js

@@ -0,0 +1,71 @@
+#!/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
+)
+    .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
+};
+// --- 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 <<<");