Skip to main content

MCP工具和资源

工具在中执行操作 CODESYS 项目或设备上并返回结果。阅读工具对项目或设备没有影响。写作工具会永久更改项目的内容或结构,并在表格中进行相应的标记。

开发工具

开发工具编辑 CODESYS 在不与控制器建立连接的情况下进行项目。

开发工具用于以下任务:

  • 结构化文本编程

  • 管理项目结构和库

  • 检查项目

工具

描述

效果

add_or_remove_library

向项目添加库引用或将其删除。

在库管理器中更改库引用

add_or_remove_program_call_in_task

将程序分配给任务,使其在运行周期中执行。在创建新程序后使用该工具。

该工具还可以从任务中删除程序调用。

更改任务的程序调用

browse_project_tree

显示项目树或特定子树的结构。方法、属性和操作可选择显示在其父 POU 下方。

只读

check_for_errors

检查项目是否存在错误并返回带有源路径和行号的诊断消息。在标准模式下,该工具指的是预编译规则。或者,可以触发完整编译。

只读。或者,该工具可以触发项目的编译。

create_folder

在项目树中创建新文件夹。此工具用于将 POU 组织成逻辑组

将在项目中创建一个新文件夹。

create_or_replace_structured_text_object

创建新的结构化文本对象或完全重写现有的结构化文本对象。可以在一次调用中创建带有嵌套子 POU 的完整 POU。未明确包含的子 POU 将被保留。

同一路径上的现有对象将被覆盖。

get_active_app_as_path

返回当前加载的项目的路径。

只读

get_active_path_and_selection

返回当前选择的路径 CODESYS。选择代码时,还会返回行号和所选文本。

只读

get_available_libraries_list

返回中所有可用库的列表 CODESYS。

只读

get_detailed_library_documentation

返回库中特定函数的详细文档。包括参数、返回类型和其他相关详细信息。

只读

get_library_documentation

简要概述库的内容。包含所有函数、类型及其顶级签名。

只读

get_libraries_referenced_in_application

返回应用程序中引用的所有库的列表。

只读

get_structured_text_content

返回指定路径下对象的结构化文本源代码。默认情况下,嵌套的子对象(例如方法、动作、属性和转换)包含在输出

还支持使用开始和结束行限制输出

只读

remove_object

从项目中移除对象。该工具还用于从功能块中移除单个下级 POU

该对象将被不可撤销地删除。

rename_object

重命名一个对象并更新对该对象的所有引用。如果无法调整引用,则不会进行重命名

完成重命名,更改所有引用

replace_text_in_structured_text

在结构化文本对象中执行有针对性的文本替换。

目标对象中的指定文本将被替换。

search_in_files_by_regex

在整个项目代码中搜索文本模式。返回匹配项并按对象路径和行号分组。

只读

search_libraries_for_type

在所有可用库中按名称搜索类型或函数。返回库名称和元素类型。

只读

search_path_by_glob

使用 glob 模式在项目树中查找对象。如果有许多结果具有共同祖先,则输出将按组显示

只读

设备工具

设备工具编辑 CODESYS 项目的设备树并管理设备存储库。

设备工具用于以下任务:

  • 扫描、添加、更换和配置设备

  • 将变量映射到 I/O 通道

  • 管理设备存储库中的设备描述

设备工具无法建立与控制器的连接。更改后的配置只有在下次下载或在线更改时才能到达控制器。

工具

描述

效果

acknowledge_device_diagnosis

确认控制器上设备的诊断消息。或者,该工具还会确认所有从属设备的诊断消息。该工具对应于 确认诊断,确认子树的诊断 CODESYS 中的命令。应用程序必须处于在线模式。

写作。将值写入控制器上设备的确认参数。设备驱动程序决定设备的响应方式。

add_device

将设备存储库中的设备添加到设备树中。该工具将设备添加为顶级设备或位于设备或连接器下方。例如,顶级设备就是控制器。对于老虎机, plug_device 已使用。

写作。向项目添加设备。如果控制器的应用程序处于联机模式,则该工具不可用。

copy_scanned_devices

扫描主站、扫描仪或控制器下方的现场总线上的设备,并将设备添加到项目中。该工具对应于 扫描设备 命令输入 CODESYS 然后将设备复制到项目中。如果未选择任何设备,则该工具会添加所有安装了设备描述的响应设备。对于按其身份分配设备的现场总线,该工具还会根据结果添加单个设备 scan_for_devices。

写作。更改项目。对于按位置分配设备的现场总线,该工具仅将主设备下方的现有配置替换为 replace_devices 参数。在这种情况下,该工具会移除扫描未找到的设备。如果没有设备响应,则该工具不会更改任何内容。

enable_or_disable_device

启用或禁用设备、模块或插入的插槽。该工具对应于 CODESYS 中的和命令

写作。更改项目中的设备。当设备被禁用时,其下属设备也会被禁用。登录控制器应用程序时无法执行该工具。

get_device_online_status

读取设备和所有下属设备的联机状态。在线状态对应于设备树中的状态图标,例如:

  • 跑步

  • 警告

  • 错误

  • 没有许可证

  • 诊断

  • 已禁用

随着 include_diagnosis 参数,该工具还会从设备的状态页面读取诊断,例如诊断消息或统计信息。该工具仅在应用程序处于在线模式时读取状态。

只读。

install_device_descriptions

将设备描述文件安装到设备存储库,例如 devdesc.xml、ESI、EDS、GSDML 和 IODD。该工具每次调用最多安装 20 个文件。

写作。更改安装的设备存储库。使用相同版本覆盖现有描述

list_device_identifications

列出所有设备、连接器和插槽及其设备描述的类型、ID、版本和模块 ID。该工具用于重现配置或检查所使用的修订版。

只读。

list_io_channels

使用数据类型和映射变量列出设备的 I/O 通道。输出对应于设备编辑器中的页面。

只读。

map_variables_to_io_channels

将变量映射到 I/O 通道或删除映射。单个呼叫也可以处理多个设备。该工具会提前检查所有条目。

写作。替换之前的映射。如果该工具拒绝了参赛作品,则项目将保持不变

plug_device

将设备插入空插槽或端口。例如,该工具将模块插入总线耦合器或将设备插入IO-Link

写作。项目中已插入设备。如果控制器的应用程序处于联机模式,则该工具不可用。

read_device_parameters

使用值、默认值、数据类型和访问权限读取设备的参数。输出对应于离线模式下设备编辑器的参数页面。

只读。该工具不读取任何在线值。

scan_for_devices

扫描连接到主机、控制器或扫描仪下方的现场总线的设备。控制器必须是可访问的。对于大多数现场总线,具有现场总线配置的应用程序也必须处于运行状态。

只读。保留现有设备。该工具包括所有响应设备,包括同一网络上另一台计算机的设备。因此,请检查结果。 CODESYS 在扫描期间被阻止。扫描通常需要几秒钟。如果控制器没有响应,则扫描大约需要时间 20 秒。

copy_scanned_devices

该工具会添加使用以下方法找到的设备 scan_for_devices 并且尚未进入该项目的项目。控制器必须是可访问的。对于大多数现场总线,具有现场总线配置的应用程序也必须处于运行状态。

写作。将找到的设备添加到项目中。保留现有设备。该工具添加了所有响应设备。

search_device_catalogue

使用正则表达式按名称、供应商和订单号搜索已安装的设备描述。或者,该工具将搜索范围限制为可安装在特定设备下方或插槽

只读。

uninstall_device_descriptions

不可撤销地从设备存储库中卸载设备描述。该工具还会卸载依赖于它们的描述

写作。卸载是不可撤销的,会影响所有项目,包括当前打开的项目。该工具不检查打开的项目。之后,这些项目中的设备缺少了描述。

unplug_device

将设备从插槽或端口中移除。设备树中的插槽仍然是空的。

写作。移除设备和所有从属元素。

update_device

替换设备的设备描述。该工具对应于 CODESYS 中的命令。如果未指定描述,则该工具使用最新安装的版本。

写作。设备保留其名称和位置。在可能的情况下,设备还会保留其子节点和设置

write_device_parameters

更改项目中设备参数的值。该工具检查值的方式与设备编辑器相同。

写作。仅更改项目。登录控制器应用程序时无法执行该工具。

在线工具

使用真正的硬件,在线工具会根据物理设备的应用程序起作用。阅读在线工具对应用程序和设备没有影响。编写在线工具会更改应用程序或设备的状态。

小心

使用以下安全功能保护控制器免受 AI 助手的意外操作:

  • 已确认的在线模式: 如果为设备启用了 “确认联机模式”,则以下工具不会执行任何操作并报告错误:

    • logout_application

    • reset_application

    • set_online_values

    • start_application

    • stop_application

    • execute_single_cycle_or_step

  • PLC 用户管理:使用 PLC-UserManagement,您可以详细定义允许谁执行哪些操作。在控制器上,创建一个仅拥有 AI 助手预定权限的用户。以该用户身份登录设备。

  • 操作模式:操作模式通常保护控制器免受意外访问,包括错误执行的工具。

工具

描述

效果

execute_single_cycle_or_step

执行登录应用程序的一个周期或一个步骤,然后停止。

写作。控制器读取输入、执行程序和写入输出。在此过程中,机器可能会移动。

get_application_state

返回应用程序是否已登录。该工具还会返回应用程序是否正在运行、已停止或在断点处暂

只读。

get_device_log

读取设备的运行时日志。如果联机操作失败,日志将包含原因。

只读。

get_online_values

读取已登录应用程序变量的当前值。

只读。

list_forced_values

列出已登录应用程序的所有强制变量。

只读。

login_and_update_application_if_needed

使用户登录到设备上的应用程序。如果需要,该工具会编译项目并将其下载到设备上

写作。建立与设备的连接,并在需要时将代码下载到设备。

login_application_if_unchanged

如果应用程序未更改,则用户登录到设备上的应用程序。此登录变体更加谨慎,不会将任何项目更改转移到设备上。

警告

后续的工具调用可能会重置登录的应用程序或写入和强制执行单个变量。

写作。该工具编译应用程序,以便将其与设备上的应用程序进行比较。设备上的应用程序保持不变。

logout_application

将用户注销应用程序。或者,该工具可以先对变量进行强制

写作。终止在线连接

reset_application

重置应用程序。可能的类型有温暖、冷和原产地。

写作。停止程序执行并重置变量值。重置为 origin 时,该工具会删除控制器上的应用程序

set_online_values

写入变量值、强制或强制执行变量值。

写作。会话结束后,强制仍在继续。

start_application

启动指定的应用程序。该应用程序必须登录。首先使用以下命令登录应用程序 login_application_if_unchanged 或者 login_and_update_application_if_needed。如果应用程序未登录,则该工具会报告错误。如果应用程序已经在运行,则该工具不会更改任何内容。

写作。在目标设备上执行代码。使用真正的硬件,代码在物理设备上运行。

stop_application

停止指定的应用程序。该应用程序必须登录。首先使用以下命令登录应用程序 login_application_if_unchanged 或者 login_and_update_application_if_needed。如果应用程序未登录,则该工具会报告错误。如果应用程序已经停止,则该工具不会更改任何内容。

写作。停止目标设备上的代码。

项目管理工具

项目管理工具打开、保存和关闭 CODESYS 项目并返回项目状态。一次只能打开一个项目。阅读项目管理工具对项目没有影响。编写项目管理工具会更改打开的项目或项目文件。

重要

以下访问限制适用于项目管理工具:

  • 目录白名单:这些工具仅适用于用户批准的文件夹中的项目文件 工具 → 选项 → MCP 服务器 → 文件存取。安装后,未批准任何文件夹。安装文件夹、存储库文件夹和 Windows 文件夹始终处于屏蔽状态。

  • 用户管理: 的权利 CODESYS 用户管理也适用于工具。如果登录的用户没有命令权限,则该工具不会执行该命令并报告错误

工具

描述

效果

close_project

关闭打开的项目。如果项目包含未保存的更改,则该工具会报告错误。随着 discard_changes 参数,该工具会丢弃更改并关闭项目。

写作。 discard_changes,未保存的更改会丢失。

get_project_status

返回打开项目的状态。状态包括文件路径、项目类型、未保存的更改和写入保护。或者,该工具还会返回项目信息。

只读。

open_project

打开项目、库或 FBS 项目。或者,该工具以只读模式打开项目。

写作。加载项目。对于大型项目,打开可能需要几分钟。

save_project

将打开的项目保存到其存储位置。

写作。覆盖项目文件

save_project_as

打开的项目保存到新路径中。新项目仍处于开放状态。

写作。创建新文件。随着 overwrite 参数,该工具会覆盖现有文件。原始文件保持不变。

资源

资源是只读上下文数据,例如模板和语法引用。与工具不同,资源不执行操作,但提供静态内容。可以在提示中直接引用资源,例如:“根据测试用例模板创建测试用例”。

资源

描述

CODESYS 结构化文本方言描述

方言的语法参考 CODESYS ST 附有 IEC 61131-3 标准的解释和示例,以及 CODESYS特定扩展。该参考包括语法规则、数据类型和文字、变量部分、运算符、控制流、调用约定、接口、继承和常见错误来源。此资源可以在代码生成和代码检查期间使用,以避免因方言特异性而导致的语法错误

CODESYS IEC UnitTest 测试用例模板

遵循模式的测试用例模板 TM.Testcase。该模板包含以下方法:

  • Setup: 准备测试对象

  • Execute: 刺激和结果测试

  • Teardown: 测试完成后清理

  • Abort: 取消对正在运行的测试的处理

此资源用于创建新的单元测试,以便根据推荐的模式生成测试用例 CODESYS Test Manager。