@codesys/mcp-toolkit

@codesys/mcp-toolkit

site icon
2025.04.23 0
TypeScriptCODESYS 自动化MCP 服务器编程工具开发效率
codesys-mcp-toolkit 是一个为 CODESYS V3 编程环境设计的 Model Context Protocol (MCP) 服务器工具包。它允许 MCP 客户端(如 Claude Desktop)与 CODESYS 无缝交互,实现项目管理、POU 创建、代码编辑和编译任务的自动化。
View on GitHub

Overview

基本能力

产品定位

codesys-mcp-toolkit 是一个为 CODESYS V3 编程环境设计的 MCP 服务器工具包,旨在通过 MCP 协议实现与 CODESYS 的自动化交互。

核心功能

  • 项目管理
  • 打开现有 CODESYS 项目
  • 从模板创建新项目
  • 保存项目更改

  • POU 管理

  • 创建程序、功能块和函数
  • 设置声明和实现代码
  • 为功能块创建属性和方法
  • 编译项目

  • MCP 资源

  • codesys://project/status: 检查脚本状态和项目状态
  • codesys://project/{+project_path}/structure: 检索项目结构
  • codesys://project/{+project_path}/pou/{+pou_path}/code: 读取 POU 代码

  • MCP 工具

  • open_project: 打开指定的 CODESYS 项目
  • create_project: 创建新的 CODESYS 项目
  • save_project: 保存当前打开的项目
  • create_pou: 创建新的程序、功能块或函数
  • set_pou_code: 更新指定 POU 的代码
  • create_property: 在功能块中创建属性
  • create_method: 在功能块中创建方法
  • compile_project: 编译打开的项目

适用场景

  • 自动化 CODESYS 项目管理
  • 批量创建和编辑 POU
  • 自动化代码生成和编译
  • 与 MCP 客户端(如 Claude Desktop)集成

使用教程

使用依赖

  • CODESYS V3: 需要安装 CODESYS V3(测试版本为 3.5 SP21),并启用 Scripting Engine 组件
  • Node.js: 需要版本 18 或更高
  • MCP Client: 需要支持 MCP 的应用程序(如 Claude Desktop)

安装教程

选项 1: 从 npm 安装(推荐)

npm install -g @codesys/mcp-toolkit

这将全局安装包,使 codesys-mcp-toolkit 命令在终端中可用。

选项 2: 从源代码安装

# 克隆仓库
git clone https://github.com/johannesPettersson80/codesys-mcp-toolkit.git
cd codesys-mcp-toolkit

# 安装依赖
npm install

# 构建项目
npm run build

# 全局安装
npm install -g .

调试方式

常见问题

  • 连接失败: 检查 Claude Desktop 日志中的错误消息
  • 路径问题: 确保 CODESYS 可执行文件路径正确
  • 配置文件不匹配: 验证配置文件名称是否完全匹配
  • 权限问题: 确保 Claude 有适当的权限
  • CODESYS 已在运行: 关闭其他 CODESYS 实例

调试日志

检查日志位置: - Windows: C:\Users\<YourUsername>\AppData\Roaming\Claude\logs\

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。