通知：

这是 Studio 5000 AI 助手的 v35 版分支，独立维护。它默认使用 Studio 5000 Logix Designer v35，但通过设置脚本的 --version 参数支持任何已安装的版本（请参阅下面的 选择你的 Studio 5000 版本）。感谢此项目所基于的原始项目：rivie13/studio5000-AI-Assistant（默认 v36）。此仓库是一个原型——欢迎你将其分叉并打造为你自己的版本。

🤖 Studio 5000 AI 驱动的 PLC 编程助手

这个革命性的 MCP（模型上下文协议）服务器通过提供 AI 驱动的代码生成、L5X 例程创建、真实的 .ACD 文件生成以及无缝的 Studio 5000 集成，彻底改变了 PLC 编程。将自然语言规范直接转换为可用的梯形图逻辑和完整的 Studio 5000 项目！

⚡ TL;DR - 一条命令完成设置

# 1. Get Python 3.12 (NOT 3.11!) from python.org
python --version  # Must show 3.12.x

# 2. Clone the repo
git clone https://github.com/ProJewks/THE_Studio5000_AI_Assistant_V35.git
cd THE_Studio5000_AI_Assistant_V35

# 3. Run the setup script — installs everything and writes your config for you
python setup.py

setup.py 会检测你已安装的 Studio 5000 版本（默认为 v35），安装 requirements.txt，如果找到 Logix Designer SDK wheel 文件则安装它，为你的机器生成带有正确路径的即用型 MCP 配置文件，并运行内置自检。如果你不是 v35 版本，请参阅 选择你的 Studio 5000 版本，关于如何处理它生成的文件，请参阅 setup.py 生成什么。

就这样！ ✅ 如果你想手动配置，请跳到 Claude Desktop 的配置，或者直接将 Claude Desktop/Claude Code 指向 setup.py 已经生成的文件。

Related MCP server: tiacommander-mcp

🔀 选择你的 Studio 5000 版本

此分支默认为 v35，但你并不局限于它。setup.py 会扫描你机器上每个已安装的 Logix Designer 版本，让你选择：

# Auto-detect and prompt interactively (default: v35 if present)
python setup.py

# Force a specific version, e.g. the upstream project's v36
python setup.py --version 36

# Non-interactive, accept every default (CI / scripted installs)
python setup.py --yes

# Skip prompts but still write straight into Claude Desktop's config
python setup.py --version 37 --write-claude-desktop --yes

如果某个版本未被自动检测到，脚本会回退到标准的 Rockwell 安装路径（...\Logix Designer\ENU\v<N>\Bin\Help\ENU\rs5000），使用你提供的任何版本号——如果你的安装位置非标准，可以在服务器本身上用 --doc-root 覆盖（请参阅 步骤 5）。

📦 setup.py 生成什么

下面的每个文件都是特定于机器的（绝对路径、你的 Python 解释器），并且被 git 忽略——任何时候重新运行 python setup.py 即可重新生成它们：

mcp_config.json（没有 .local）作为纯模板保留在仓库中供参考——不要手动编辑它，请运行 setup.py。

📚 新团队成员资源

🎯 完整的团队指南可用：

• 📖 TEAM_USAGE_GUIDE.md - 带有真实示例的完整工作流指南

• ⚡ QUICK_REFERENCE_CARD.md - 日常命令和快捷方式

• 🔧 TEAM_TROUBLESHOOTING_GUIDE.md - 常见问题和解决方案

🚀 团队成员快速入门

准备好使用此工具了吗？请按照以下步骤操作：

先决条件 ⚠️ 关键

• Python 3.12（不是 3.11 或更早版本——SDK 将无法工作！）

• 机器上安装了 Studio 5000 Logix Designer v35 或更高版本

• Windows 操作系统（Studio 5000 SDK 仅支持 Windows）

安装步骤

1. 验证 Python 3.12：

   python --version
   # Must show Python 3.12.x - if not, install Python 3.12 from python.org

2. 克隆并运行设置：

   git clone https://github.com/ProJewks/THE_Studio5000_AI_Assistant_V35.git
   cd THE_Studio5000_AI_Assistant_V35
   python setup.py

   这会一步完成依赖安装、SDK wheel 安装和配置生成——请参阅上面的 TL;DR。下面的步骤 2-3 是手动、逐步的等效操作，如果你更愿意自己做的话。

3. 安装 Studio 5000 SDK（用于 .ACD 文件）——仅在你跳过 setup.py 时才需要：

   pip install "C:\Users\Public\Documents\Studio 5000\Logix Designer SDK\python\logix_designer_sdk-*-py3-none-any.whl"

4. 测试安装：

   python src/mcp_server/studio5000_mcp_server.py --test

   ✅ 应显示：文档已索引，SDK 可用，测试通过

5. 可以使用了！ - 服务器将自动检测你的 Studio 5000 安装路径

遇到问题？ 请参阅下面的 故障排除 部分。

🚀 AI 驱动的功能

🧠 自然语言到 PLC 代码

• AI 代码生成：将纯英语转换为可用的梯形图逻辑

  • "按下启动按钮时启动电机，按下停止按钮时停止电机" → 带有正确启动/停止互锁的完整梯形图逻辑

• 智能模式识别：自动检测启动/停止、定时器、计数器和基本 I/O 模式

• 智能标签创建：自动生成带有描述性名称的适当 I/O 标签

• 指令验证：根据官方 Studio 5000 文档数据库验证生成的代码

📁 L5X 项目生成

• 项目结构创建：生成带有程序、例程和标签的 L5X 项目文件（可以创建要导入到现有项目中的例程，也可以创建要手动开发的空 L5X 文件）

• 多控制器支持：支持各种 Allen-Bradley 控制器（1756-L83E、1756-L85E 等）

• ⚠️ 当前限制：生成的 L5X 文件可能存在需要手动修复的 RLL 格式问题

• 结构化输出：XML 结构遵循 Studio 5000 模式，但可能需要验证

• 💡 最佳实践：用于项目模板，然后在 Studio 5000 中手动添加逻辑

🏭 真实 .ACD 项目创建

• 官方 Studio 5000 SDK 集成：使用 Rockwell 官方 SDK 创建真正的 .ACD 文件

• 直接 Studio 5000 兼容性：.ACD 文件无需转换即可直接在 Studio 5000 中打开

• ✅ 空项目创建：准备好进行手动开发的干净 ACD 模板（可靠）

• ⚠️ 完整项目创建：实验性——SDK 对 MainProgram/MainTask 的部分导入（不可靠）

• 版本控制：支持不同的 Studio 5000 主要修订版本（默认 v35）

• 💡 推荐：使用空 ACD 创建 + 手动 L5X 导入工作流

🔍 向量驱动的语义搜索

• 智能 L5X 分析：对大型 L5X 文件进行语义搜索（已用 49k+ 行测试）

• 生产级处理：处理复杂的工业自动化项目

• 智能代码插入：AI 在现有例程中找到新逻辑的最佳位置

• 依赖分析：自动检测组件关系和依赖

• 模式识别：理解输送机控制、编码器逻辑、故障处理和定时器模式

• FAISS 向量数据库：基于嵌入相似性的闪电般快速的语义搜索

📐 技术图纸分析

• PDF 工程图纸：提取和搜索技术图纸（P&ID、电气原理图、控制逻辑图）

• AutoCAD 集成：解析带有丰富文本和矢量图形内容的 CAD 生成的 PDF

• 设备上下文：自动查找设备标签和系统组件引用的图纸

• 视觉 AI 增强：对复杂技术图表和设备连接进行高级分析

• 交叉引用能力：将图纸与现有 L5X 代码和标签数据库关联，以实现完整的系统理解

📊 高级 L5X 分析系统

• 真实生产测试：已使用来自工业系统的实际 2.9MB L5X 文件验证

• 复杂度评分：自动评估例程复杂度和重构需求

• 组件映射：跟踪定时器、计数器、标签及其互连

• 精准修改：在不干扰现有逻辑的情况下精确插入梯级

• 专业工作流：只读分析，配合 SDK 驱动的修改能力

📚 文档访问

• 综合指令数据库：搜索官方 Studio 5000 文档

• 智能搜索：按名称、描述、类别或功能查找 PLC 指令

• 详细信息：获取有关指令语法、参数和用法的全面详细信息

• 类别浏览：按功能类别浏览指令（报警、数学、运动、定时器等）

• 语言支持：关于每种指令支持哪些编程语言的信息（梯形图、ST、FBD）

• 实时验证：使用官方 Rockwell 文档进行即时验证

📋 详细安装指南

先决条件 - 请先阅读！⚠️

🚨 关键要求：仅限 Python 3.12

• 此项目要求 Python 3.12 - 更早版本将失败

• Studio 5000 SDK 不兼容 Python 3.11 及更早版本

• 在继续之前先验证你的 Python 版本

系统要求：

• Python 3.12.x（从 python.org 下载）

• 已安装 Studio 5000 Logix Designer v35 或更高版本

• Windows 操作系统（Studio 5000 SDK 仅支持 Windows）

• 初始设置可能需要管理员权限

逐步设置

步骤 1：安装 Python 3.12

1. 下载：前往 python.org 并下载 Python 3.12

2. 安装：在安装过程中，勾选"将 Python 添加到 PATH" ✅

3. 验证：打开命令提示符并运行：

   python --version
   # Must show: Python 3.12.x (if not, restart command prompt)

步骤 2：获取项目

1. 克隆仓库：

   git clone https://github.com/ProJewks/THE_Studio5000_AI_Assistant_V35.git
   cd THE_Studio5000_AI_Assistant_V35

2. 更喜欢一条命令的方式？ 现在运行 python setup.py，然后跳到 步骤 4——它会为你完成步骤 3 和 3.5，包括 选择你的 Studio 5000 版本。下面的手动步骤适合任何想要完全控制每个部分的人。

步骤 3：安装依赖（关键！）

1. 安装所有必需的包：

   pip install -r requirements.txt

   这会安装：

   • 核心组件：BeautifulSoup、XML 处理、异步支持

   • AI 和向量搜索：PyTorch、sentence-transformers、FAISS 向量数据库

   • 语义分析：用于指令和 L5X 搜索的向量嵌入

   • 性能：针对生产使用优化的版本

   如果遇到错误，请尝试：

   python -m pip install --upgrade pip
   pip install -r requirements.txt

   注意：向量数据库组件（torch、sentence-transformers、faiss-cpu）包含在内，用于语义搜索功能。这些支持高级 L5X 分析和指令搜索功能。

步骤 3.5：安装 Studio 5000 SDK（对 .ACD 文件至关重要！）🚨

⚠️ 团队成员必须执行此步骤 - 仅在你不需要 .ACD 文件创建时才跳过

1. 在你的 Studio 5000 安装中找到 SDK wheel 文件：

   # Look for this file (version may vary):
   dir "C:\Users\Public\Documents\Studio 5000\Logix Designer SDK\python\logix_designer_sdk-*-py3-none-any.whl"

2. 安装 SDK wheel 文件：

   # Replace with your actual file path and version:
   pip install "C:\Users\Public\Documents\Studio 5000\Logix Designer SDK\python\logix_designer_sdk-2.0.1-py3-none-any.whl"

3. 备选方案 - 如果你找不到 wheel 文件：

   # Navigate to the SDK directory and install from there:
   cd "C:\Users\Public\Documents\Studio 5000\Logix Designer SDK\python"
   pip install logix_designer_sdk-*-py3-none-any.whl

没有此步骤：文档和 L5X 生成将正常工作，但 .ACD 文件创建将失败！

步骤 4：测试你的安装 ✅

1. 运行测试命令：

   python src/mcp_server/studio5000_mcp_server.py --test

2. 你应该看到：

   • ✅ "文档索引成功"（找到 500+ 条指令）

   • ✅ "SDK 可用：True"（如果你正确安装了 SDK wheel 文件）

   • ✅ "SDK 可用：False"（如果你跳过了 SDK 安装也可以——L5X 生成仍然有效）

   • ✅ 示例搜索结果和代码生成测试

3. 如果 SDK 可用显示为 False 但你安装了 wheel 文件：

   • 检查 wheel 文件路径是否正确

   • 尝试：python -c "import logix_designer_sdk; print('SDK OK')"

4. 如果测试完全失败，请查看 故障排除 部分

🎉 你已准备好使用此工具！ 🎉

服务器将自动检测您的 Studio 5000 安装路径。跳转到 Claude Desktop 配置 部分即可开始使用！

第 5 步：配置环境变量（仅限高级用户）

⚠️ 跳过此步骤 - 仅当 Studio 5000 安装在非标准位置时才需要

选项 A：通过 Windows 环境变量设置

• 打开系统属性 → 环境变量

• 添加以下用户或系统变量：

STUDIO5000_DOC_PATH=C:\Program Files (x86)\Rockwell Software\Studio 5000\Logix Designer\ENU\v35\Bin\Help\ENU\rs5000
STUDIO5000_SDK_PATH=C:\Users\Public\Documents\Studio 5000\Logix Designer SDK\python
PYTHON312_PATH=C:\Users\YourUsername\AppData\Local\Programs\Python\Python312\python.exe

选项 B：创建 .env 文件（位于项目根目录）：

STUDIO5000_DOC_PATH=C:\Program Files (x86)\Rockwell Software\Studio 5000\Logix Designer\ENU\v35\Bin\Help\ENU\rs5000
STUDIO5000_SDK_PATH=C:\Users\Public\Documents\Studio 5000\Logix Designer SDK\python
PYTHON312_PATH=C:\Users\YourUsername\AppData\Local\Programs\Python\Python312\python.exe

4. 找到您的 Studio 5000 路径：

   文档路径：在您的 Studio 5000 安装目录中查找此文件：

   <Studio5000_Install>\Logix Designer\ENU\v35\Bin\Help\ENU\rs5000\17691.htm

   常见位置：

   • C:\Program Files (x86)\Rockwell Software\Studio 5000\Logix Designer\ENU\v35\Bin\Help\ENU\rs5000

   • C:\Program Files\Rockwell Software\Studio 5000\Logix Designer\ENU\v35\Bin\Help\ENU\rs5000

   SDK 路径：查找 SDK Python 文件夹：

   C:\Users\Public\Documents\Studio 5000\Logix Designer SDK\python

5. 测试服务器：

   # Test with environment variables (recommended)
   python src/mcp_server/studio5000_mcp_server.py --test
   
   # Or test with explicit path
   python src/mcp_server/studio5000_mcp_server.py --doc-root "C:\Program Files (x86)\Rockwell Software\Studio 5000\Logix Designer\ENU\v35\Bin\Help\ENU\rs5000" --test

   成功输出应显示：

   • 文档索引（找到数百条指令）

   • 示例搜索结果

   • AI 代码生成测试

   • SDK 可用性状态

Claude Desktop 配置

如果您运行了 python setup.py，此步骤已完成——它已将您的真实、正确的路径 （无论您克隆到哪个文件夹，无论您的 Windows 用户名是什么）写入 claude_desktop_config.snippet.json，或者如果您传入了 --write-claude-desktop，则直接合并到 Claude Desktop 的配置中。无需手动填写以下内容。

手动配置？ 将以下内容添加到您的 Claude Desktop 配置文件（通常位于 %APPDATA%\Claude\config.json）。将 YourUsername 和文件夹名称替换为您实际克隆此仓库的位置——只有在您使用默认名称克隆时，该文件夹才叫 THE_Studio5000_AI_Assistant_V35：

Windows 配置

选项 A：使用环境变量（推荐）

{
  "mcpServers": {
    "studio5000-ai-assistant": {
      "command": "python",
      "args": [
        "C:\\Users\\YourUsername\\THE_Studio5000_AI_Assistant_V35\\src\\mcp_server\\studio5000_mcp_server.py"
      ],
      "cwd": "C:\\Users\\YourUsername\\THE_Studio5000_AI_Assistant_V35",
      "env": {
        "STUDIO5000_DOC_PATH": "C:\\Program Files (x86)\\Rockwell Software\\Studio 5000\\Logix Designer\\ENU\\v35\\Bin\\Help\\ENU\\rs5000",
        "STUDIO5000_SDK_PATH": "C:\\Users\\Public\\Documents\\Studio 5000\\Logix Designer SDK\\python"
      }
    }
  }
}

选项 B：使用命令行参数

{
  "mcpServers": {
    "studio5000-ai-assistant": {
      "command": "python",
      "args": [
        "C:\\Users\\YourUsername\\THE_Studio5000_AI_Assistant_V35\\src\\mcp_server\\studio5000_mcp_server.py",
        "--doc-root",
        "C:\\Program Files (x86)\\Rockwell Software\\Studio 5000\\Logix Designer\\ENU\\v35\\Bin\\Help\\ENU\\rs5000"
      ],
      "cwd": "C:\\Users\\YourUsername\\THE_Studio5000_AI_Assistant_V35"
    }
  }
}

重要说明：

• 将 YourUsername 替换为您实际的 Windows 用户名

• 调整 Studio 5000 路径以匹配您的安装

• 使用 Python 3.12 - 如需可指定完整路径："command": "C:\\Users\\YourUsername\\AppData\\Local\\Programs\\Python\\Python312\\python.exe"

备选方案：使用 Cursor IDE

如果您使用 Cursor IDE，在此项目工作区中工作时 MCP 服务器默认可用。服务器将自动使用已设置的环境变量，或者您也可以在 Cursor 的 MCP 设置中手动配置。强烈推荐将此项目与 Cursor IDE 配合使用，并通过 cursor mcp 设置（mcp.json）进行配置。

🛠️ 可用的 AI 工具

配置完成后，以下强大工具将在您的 AI 对话中可用：

🧠 AI 代码生成工具

1. 生成梯形图逻辑

工具：generate_ladder_logic 参数：

• specification（字符串）：所需 PLC 行为的自然语言描述

功能：

• 模式识别：自动检测启动/停止、定时器、计数器及基本 I/O 模式

• 智能标签生成：创建合适的标签名称和数据类型

• 指令验证：使用 Studio 5000 文档数据库进行验证

示例："创建逻辑，用启动按钮启动电机，用停止按钮停止电机"

2. 创建 L5X 项目

工具：create_l5x_project 参数：

• project_spec（对象）：项目规格，包括：

  • name（字符串）：项目名称

  • controller_type（字符串）：控制器型号（例如，"1756-L83E"）

  • specification（字符串）：逻辑的自然语言描述

  • save_path（可选字符串）：保存 L5X 文件的路径

输出：可直接导入的完整 Studio 5000 L5X 项目文件

3. 创建空 .ACD 模板 ✅

工具：create_acd_project
参数：

• project_spec（对象）：ACD 项目规格，包括：

  • name（字符串）：项目名称

  • controller_type（字符串）：控制器型号

  • major_revision（整数）：Studio 5000 版本（默认 36）

  • save_path（字符串）：.ACD 文件的保存路径

输出：使用官方 Studio 5000 SDK 创建的空 .ACD 文件 - 可直接进行手动开发

⚠️ 重要提示：仅创建空项目。关于"包含 MainProgram/MainTask 的完整项目"的说法不可靠。

💡 推荐工作流程：创建空 ACD → 在 Studio 5000 中手动开发逻辑

4. 验证梯形图逻辑 ⚡ 快速可靠的验证

工具：validate_ladder_logic 参数：

• logic_spec（对象）：包含：

  • ladder_logic（字符串）：要验证的梯形图逻辑代码

  • instructions_used（数组）：使用的 PLC 指令列表

🎯 快速验证系统：

生产级快速验证 ⚡

• 速度：0.001-0.020 秒

• 可靠性：100% 可靠，无外部依赖

• 检测项：语法错误、无效指令、括号不匹配、结构问题、逻辑模式

• 要求：无 - 始终可用

• 覆盖范围：针对 500+ 条 Studio 5000 指令进行验证

输出：包含错误、警告和建议的全面验证报告

💡 为什么快速验证更好：即时结果、100% 可靠性、捕获所有关键 PLC 编程错误，并与您的开发工作流程无缝集成。无需复杂设置！

📚 文档工具

5. 搜索指令

工具：search_instructions 参数：

• query（字符串）：搜索词（指令名称、描述、功能）

• category（可选字符串）：按指令类别筛选

功能：在官方 Studio 5000 文档数据库中搜索

6. 获取指令详情

工具：get_instruction 参数：

• name（字符串）：精确指令名称（例如，"TON"、"MOV"、"ADD"、"PID"）

输出：完整的指令信息，包括语法、参数、示例和支持的语言

7. 列出类别

工具：list_categories 参数：无（需要虚拟参数）

输出：所有可用的指令类别（报警、数学、运动、定时器等）

8. 按类别列出指令

工具：list_instructions_by_category 参数：

• category（字符串）：类别名称

输出：指定类别中的所有指令

9. 获取指令语法

工具：get_instruction_syntax 参数：

• name（字符串）：指令名称

输出：该指令的详细语法和参数信息

🔍 L5X 分析与向量搜索工具

10. 搜索 L5X 内容

工具：search_l5x_content 参数：

• query（字符串）：自然语言搜索查询（例如，"编码器脉冲计数器"、"卡纸检测逻辑"）

• project_file（字符串）：要搜索的 L5X 文件路径

• max_results（整数）：返回的最大结果数（默认：5）

功能：对现有 L5X 文件进行语义搜索，查找相关逻辑模式

11. 分析 L5X 项目结构

工具：analyze_routine_structure 参数：

• project_file（字符串）：要分析的 L5X 文件路径

• routine_name（可选字符串）：要分析的特定例程

输出：复杂度分析、依赖映射和重构建议

12. 查找最佳插入点

工具：find_insertion_point 参数：

• project_file（字符串）：目标 L5X 文件

• new_logic_description（字符串）：要插入的逻辑描述

• routine_name（字符串）：插入的目标例程

输出：推荐的梯级位置及置信度评分，用于最佳代码放置

13. 智能逻辑插入

工具：smart_insert_logic 参数：

• project_file（字符串）：目标 L5X 文件

• routine_name（字符串）：目标例程

• logic_specification（字符串）：新逻辑的自然语言描述

• insertion_point（整数）：插入的梯级位置

功能：结合现有代码分析，在最佳位置进行 AI 生成的逻辑插入

📚 SDK 文档搜索工具

14. 搜索 SDK 文档

工具：search_sdk_documentation 参数：

• query（字符串）：关于 SDK 操作的自然语言查询

• limit（整数）：返回的最大结果数（默认：10）

功能：通过语义理解搜索 Studio 5000 SDK 文档

15. 获取 SDK 操作详情

工具：get_sdk_operation_info 参数：

• name（字符串）：SDK 操作名称

• operation_type（可选字符串）：按类型筛选（方法、类、枚举、示例）

输出：包含示例和参数的详细 SDK 操作信息

📐 PDF 技术图纸工具

16. 索引 PDF 图纸

工具：index_pdf_drawings 参数：

• pdf_file_path（字符串）：技术图纸 PDF 文件的路径

• force_rebuild（布尔值）：强制重新索引现有缓存

• use_vision_ai（布尔值）：启用高级视觉 AI 分析

功能：处理并索引技术 PDF 图纸以进行语义搜索

17. 搜索技术图纸

工具：search_drawings 参数：

• query（字符串）：自然语言搜索查询（例如，"电机 M001 电气连接"）

• drawing_type_filter（可选字符串）：按类型筛选（电气、PID、逻辑、I/O 列表）

• equipment_filter（可选字符串）：按设备标签筛选

输出：带图纸上下文和页码引用的排序搜索结果

18. 查找设备上下文

工具：find_equipment_context 参数：

• equipment_tag（字符串）：设备标识符（例如，"M001"、"CV-001"）

• context_type（可选字符串）：所需上下文类型（电气、工艺、安全）

功能：查找与特定设备相关的所有图纸和文档

🎯 PLC 项目创建的三种强大方法

您的 MCP 服务器支持 三种不同的方法 来创建 PLC 项目，每种方法针对不同的使用场景进行了优化：

🥇 方法 1：L5X 生成 + 手动导入（存在限制）

🎯 生成内容：包含 MainProgram 和 MainTask 的 L5X 项目结构
⚠️ 输出：可能需要手动修复 RLL 格式问题的 L5X 文件
🎯 最适合：项目模板和基本结构创建
🎯 手动步骤：

1. 生成 L5X 模板（30 秒）

2. 在文本编辑器中修复 RLL 格式问题

3. 将修正后的 L5X 导入 Studio 5000

用法："为传送带控制创建一个 L5X 项目模板"
工具：create_l5x_project

⚡ 现实检查：

• ⚠️ 生成的 L5X 可能存在 XML 格式问题

• ✅ 适合作为项目结构模板

• ✅ 仅导入您需要的修正后逻辑

• ✅ 文件验证后即可实现专业工作流程

🥈 方法 2：空 .ACD 模板（可靠）

✅ 生成内容：空 .ACD 项目文件（干净模板）
✅ 输出：可直接在 Studio 5000 中打开的空项目
✅ 最适合：完全手动开发的起点
🛠️ 手动步骤：自行创建 MainProgram 和 MainTask，手动开发逻辑

用法："创建一个用于手动开发的空 .ACD 模板"
工具：create_acd_project

为什么这种方法有效：

• ✅ 100% 可靠的空项目创建

• ✅ 无可能失败的复杂 SDK 操作

• ✅ 为手动开发提供干净的基础

🥉 方法 3：仅 AI 逻辑生成（适用于现有项目）

🧠 生成内容：经过验证的专业梯形图逻辑
🧠 输出：可直接复制粘贴的梯形图逻辑代码
🧠 最适合：为现有公司项目添加逻辑
🧠 手动步骤：将生成的逻辑复制到您现有的例程中

用法："为我现有的项目生成传送带控制逻辑"
工具：generate_ladder_logic

🎯 当前状态与推荐工作流程

实际可用的功能：✅ AI 逻辑生成 + 空 ACD 模板 + 手动开发

现实的工业工作流程：

1. 生成 AI 逻辑："创建带卡料检测的输送机控制" → 专业的梯形图逻辑代码

2. 创建空白 ACD：干净的项目模板，随时可进行开发

3. 手动开发：将逻辑复制到 Studio 5000 中，手动创建 MainProgram/MainTask

4. 生产就绪：借助 AI 辅助开发出功能完整的逻辑

为什么这是诚实且实用的：

• ✅ 100% 可靠的空白 ACD 创建 - 无复杂故障

• ✅ AI 生成的逻辑可用 - 为手动开发打下良好基础

• ✅ 专业工作流 - AI 辅助，人类工程师验证并实施

• ✅ 零导入问题 - 无损坏的 XML 或 SDK 复杂问题

高级功能的现实情况：

• ⚠️ L5X 生成：可创建结构，但导入前可能需要修复 XML

• ⚠️ 完整 ACD 项目：实验性 SDK 功能，经常失败

• ✅ 快速验证：100% 可靠地捕获逻辑错误

• ✅ 向量搜索：非常适合分析现有项目

💡 使用示例

配置好 MCP 服务器后，您可以提问并生成代码，例如：

🧠 AI 代码生成示例

• "创建梯形图逻辑：按下启动按钮时启动电机，按下停止按钮时停止电机"

• "生成带启动、停止和急停功能的输送机控制系统"

• "为电磁阀创建一个 5 秒延时定时器"

• "构建带自动/手动模式和运行小时计数器的泵控制梯形图逻辑"

• "设计一个带互锁和安全回路的三工位装配线"

📁 项目创建示例

• "创建一个完整的 .ACD 项目，包含输送机控制逻辑和安全互锁" → 包含 MainProgram + 逻辑的完整 .ACD

• "为 1756-L83E 控制器生成电机控制 .ACD 项目" → 可直接使用的 .ACD 文件

• "创建一个完整的 Studio 5000 L5X 项目，用于带启动/停止功能的电机控制" → 用于导入的 L5X

• "构建一个带安全互锁的三工位装配线完整 L5X 项目" → 复杂 L5X 项目

• "创建一个用于手动开发的空白 .ACD 模板" → 干净的模板文件

📚 文档示例

• "Studio 5000 中有哪些可用的定时器指令？"

• "展示 PID 指令的完整语法和参数"

• "有哪些可用的运动控制指令？"

• "如何在梯形图逻辑中使用 GSV（获取系统值）指令？"

• "TON、TOF 和 RTO 定时器指令有什么区别？"

🔍 验证示例

• "验证这段梯形图逻辑：XIC(START)XIO(STOP)OTE(MOTOR)"

• "检查我的 TON 定时器指令用法及这些参数是否正确"

• "确认我的计数器逻辑是否符合 Studio 5000 最佳实践"

🔍 L5X 分析与向量搜索示例

• "在我的现有输送机项目中搜索编码器脉冲计数逻辑"

• "在我的 L5X 文件中查找所有基于定时器的故障检测模式"

• "分析我的分拣跟踪例程的复杂度"

• "我应该在我的现有输送机例程中哪里插入卡料检测逻辑？"

• "在我的生产 L5X 文件中查找所有 VFD 速度控制逻辑"

• "展示我的编码器反馈系统的依赖关系图"

📚 SDK 文档搜索示例

• "如何使用 LogixProject.partial_import_rungs_from_xml_file 方法？"

• "有哪些可用的标签操作 SDK 方法？"

• "展示使用 Studio 5000 SDK 创建项目的示例"

• "查找与例程分析和修改相关的 SDK 操作"

📐 技术图纸分析示例

• "为我的 Amazon 输送机系统项目索引技术图纸 PDF"

• "在图纸中查找电机 M001 的所有电气连接"

• "展示与输送机 CV-001 相关的 P&ID 图"

• "图纸中分流闸门显示了哪些安全互锁？"

• "查找分拣跟踪系统的控制逻辑图"

• "在图纸中搜索卡料检测传感器的接线和连接"

🏭 实际应用

• "为 5 个顺序步骤的洗车系统生成梯形图逻辑"

• "创建一个完整的包装线项目，包含输送机控制和产品计数"

• "构建带 PID 回路和报警处理的温度控制系统"

AI 将自动使用 MCP 服务器工具，基于您的实际 Studio 5000 文档提供准确、最新的信息，并生成可用的 PLC 代码。

🔄 手动导入工作流（推荐）

分步指南：从自然语言到可用的 PLC 代码

场景：您需要带卡料检测的输送机控制逻辑

第 1 步：生成 L5X 项目

向您的 AI 助手提问：

"创建一个完整的 L5X 项目，用于带卡料检测的输送机控制，使用上游和下游光电眼"

结果：完整的 L5X 文件，包含：

• ✅ MainProgram 和 MainTask

• ✅ 专业的梯形图逻辑

• ✅ 所有必要的标签及描述

• ✅ 已验证的指令

第 2 步：导入 Studio 5000

1. 打开 Studio 5000，使用您现有的项目（或新建一个）

2. 转到：文件 → 导入

3. 选择：您生成的 L5X 文件

4. 选择：导入 MainProgram（或特定组件）

5. 点击：导入

6. 完成！ - 可用的逻辑已准备好进行测试

第 3 步：自定义和测试

• 将您的 I/O 地址映射到生成的标签

• 在您的特定应用中测试逻辑

• 根据您的需求进行修改

🏭 用于公司项目

• 使用您现有的公司 ACD 模板

• 只生成您需要的逻辑

• 导入到已建立的项目结构中

• 保持您的编码标准和实践

⚡ 专业提示

• 为不同部分生成多个 L5X 文件（安全、过程、I/O）

• 选择性导入 - 只选择程序、只选择标签，或只选择特定例程

• 版本控制友好 - L5X 文件与 Git 配合良好

• 团队协作 - 与团队成员共享生成的 L5X 文件

故障排除

❗ 关键问题

1. Python 版本不匹配

问题：MCP 服务器启动，但 SDK 功能无法使用，或出现导入错误。

解决方案：

# Check your Python version
python --version
# Must show 3.12.x

# If not 3.12, install Python 3.12 and use full path in Claude config:
"command": "C:\\Users\\YourUsername\\AppData\\Local\\Programs\\Python\\Python312\\python.exe"

原因：Studio 5000 SDK 特别要求 Python 3.12。较早版本会导致 SDK 导入失败。

2. 文档路径未找到

问题："未找到主索引文件"或"未找到指令"

解决方案 - 查找您的文档路径：

1. 打开文件资源管理器并搜索：17691.htm

2. 查看这些常见位置：

   C:\Program Files (x86)\Rockwell Software\Studio 5000\Logix Designer\ENU\v35\Bin\Help\ENU\rs5000\17691.htm
   C:\Program Files\Rockwell Software\Studio 5000\Logix Designer\ENU\v35\Bin\Help\ENU\rs5000\17691.htm
   C:\Program Files (x86)\Rockwell Software\Studio 5000\Logix Designer\ENU\v37\Bin\Help\ENU\rs5000\17691.htm

3. 设置正确的路径（除文件名外的所有内容）：

   # Via environment variable
   set STUDIO5000_DOC_PATH=C:\Program Files (x86)\Rockwell Software\Studio 5000\Logix Designer\ENU\v35\Bin\Help\ENU\rs5000
   
   # Or via command line
   python src/mcp_server/studio5000_mcp_server.py --doc-root "C:\Program Files (x86)\Rockwell Software\Studio 5000\Logix Designer\ENU\v35\Bin\Help\ENU\rs5000" --test

3. SDK 不可用

问题："Studio 5000 SDK 不可用"或"SDK 导入失败"

最常见原因：您没有安装 SDK wheel 文件！ ⚠️

解决方案：

1. 🚨 关键：首先安装 SDK wheel 文件：

   # Find and install the wheel file (most teammates miss this step!)
   pip install "C:\Users\Public\Documents\Studio 5000\Logix Designer SDK\python\logix_designer_sdk-*-py3-none-any.whl"

2. 检查 SDK 安装：

   • 查找：C:\Users\Public\Documents\Studio 5000\Logix Designer SDK\python\

   • 如果缺失，请重新安装带 SDK 组件的 Studio 5000

3. 验证 SDK 是否可用：

   # Test if SDK is now available
   python -c "import logix_designer_sdk; print('SDK OK')"

4. 如果仍然失败，设置 SDK 路径：

   set STUDIO5000_SDK_PATH=C:\Users\Public\Documents\Studio 5000\Logix Designer SDK\python

⚠️ 常见设置问题

4. 服务器无法启动

症状：服务器立即崩溃或显示 JSON-RPC 错误。

解决方案：

• 检查 Claude 配置中的 Python 路径 - 使用 Python 3.12 的完整路径

• 验证工作目录 - "cwd" 应指向项目根目录

• 检查文件权限 - 确保对所有项目文件具有读取权限

• 隔离测试：

  python src/mcp_server/studio5000_mcp_server.py --test

5. 环境变量不生效

问题：尽管设置了环境变量，服务器仍使用硬编码路径。

解决方案：

1. 设置环境变量后重启命令提示符/IDE

2. 检查变量名（区分大小写）：

   • STUDIO5000_DOC_PATH

   • STUDIO5000_SDK_PATH

   • PYTHON312_PATH

3. 测试环境变量：

   echo %STUDIO5000_DOC_PATH%
   echo %STUDIO5000_SDK_PATH%

6. Claude Desktop 配置问题

问题：MCP 服务器未出现在 Claude Desktop 中。

解决方案：

1. 检查 config.json 语法 - 使用 JSON 验证器

2. 配置更改后完全重启 Claude Desktop

3. 使用绝对路径 - Claude 配置中不要使用相对路径

4. 检查 Claude 日志，位于 %APPDATA%\Claude\logs\

🔧 高级故障排除

快速验证：100% 可靠，零设置

✅ 当前状态：快速验证系统

系统现在使用生产就绪的快速验证，可提供即时、可靠的结果：

为什么快速验证更优越：

• ✅ 即时结果：0.001-0.020 秒验证时间

• ✅ 100% 可靠性：无外部依赖或服务要求

• ✅ 全面覆盖：针对 500+ 条 Studio 5000 指令进行验证

• ✅ 零设置：在任何系统上立即可用

• ✅ 生产就绪：捕获所有关键 PLC 编程错误

验证覆盖范围：

• ✅ 语法验证：括号平衡、正确的指令格式

• ✅ 指令验证：对照官方 Studio 5000 指令集

• ✅ 结构验证：逻辑模式和最佳实践

• ✅ 错误报告：带行号的详细错误消息

• ✅ 警告系统：识别潜在问题和改进建议

不再需要复杂的设置！

系统已超越 SDK 验证依赖。快速验证提供了专业 PLC 开发所需的全部错误检测功能，且没有任何设置复杂性、服务依赖或可靠性问题。

🔧 高级故障排除

7. 多个 Python 版本

如果您安装了多个 Python 版本：

# Use specific Python 3.12 executable
C:\Users\YourUsername\AppData\Local\Programs\Python\Python312\python.exe src/mcp_server/studio5000_mcp_server.py --test

# Or create virtual environment with Python 3.12
py -3.12 -m venv studio5000_env
studio5000_env\Scripts\activate
pip install -r requirements.txt

8. 企业/网络限制

问题：由于权限问题无法访问文档文件。

解决方案：

• 测试时以管理员身份运行

• 检查杀毒软件排除项，针对 Python 和 Studio 5000 目录

• 如果 Studio 5000 位于网络共享上，验证网络驱动器访问权限

9. Studio 5000 版本兼容性

问题：Studio 5000 版本不是 v35。

解决方案：

• 更新文档路径以匹配您的版本（v37、v38 等）

• 更新 .ACD 项目创建中的 major_revision 参数

• 检查 SDK 版本兼容性

🧪 测试命令

使用以下命令验证您的设置：

# Test 1: Python version
python --version

# Test 2: Basic server test
python src/mcp_server/studio5000_mcp_server.py --test

# Test 3: Documentation path
dir "C:\Program Files (x86)\Rockwell Software\Studio 5000\Logix Designer\ENU\v35\Bin\Help\ENU\rs5000\17691.htm"

# Test 4: SDK availability (after installing wheel file)
python -c "import logix_designer_sdk; print('SDK Available')"

# Test 5: Environment variables
echo %STUDIO5000_DOC_PATH%
echo %STUDIO5000_SDK_PATH%

📞 获取帮助

如果您仍然遇到问题：

1. 运行测试命令并捕获完整输出

2. 检查您的 Python 版本和 Studio 5000 安装路径

3. 报告问题前验证所有文件路径存在

4. 寻求帮助时包含您的确切配置

测试服务器

有关测试说明，请参阅上方安装指南中的第 4 步。

技术细节

架构

MCP 服务器由四个主要组件组成：

1. 文档解析器（studio5000_mcp_server.py）：

   • 使用 BeautifulSoup 解析 HTML 文档文件

   • 构建所有指令的内存索引

   • 提取指令名称、类别、描述、语法和参数

   • 提供快速搜索和检索功能

2. AI 代码助手（ai_assistant/code_assistant.py）：

   • 带模式识别的自然语言解析

   • 为启动/停止、定时器、计数器模式生成梯形图逻辑

   • 使用适当数据类型智能创建标签

   • 使用文档数据库进行代码验证

3. L5X 生成器（code_generator/l5x_generator.py）：

   • 基于 XML 的 L5X 项目文件生成

   • 包含程序、例程和标签的完整项目结构

   • Studio 5000 模式合规

   • 美化打印的 XML 输出

4. Studio 5000 SDK 接口（sdk_interface/studio5000_sdk.py）：

   • 使用官方 Rockwell SDK 创建真实的 .ACD 项目

   • SDK 兼容性要求 Python 3.12

   • 空白项目模板生成

   • 直接 Studio 5000 集成

MCP 协议

• 遵循 Model Context Protocol 规范实现 AI 集成

• 通过 stdin/stdout 进行 JSON-RPC 2.0 通信

• 基于工具架构，提供 15+ 个可用工具

• 向量驱动的语义搜索能力

• 生产级 L5X 文件分析

• 所有操作均支持异步

📁 项目结构

THE_Studio5000_AI_Assistant_V35/        # (folder name is whatever you clone it as)
├── setup.py                             # One-command installer — run this first
├── src/                                # Main source code
│   ├── mcp_server/
│   │   └── studio5000_mcp_server.py    # Main MCP server with AI features
│   ├── code_generator/
│   │   ├── l5x_generator.py            # L5X project file generation
│   │   └── templates/                  # L5X XML templates
│   ├── ai_assistant/                   # Enhanced AI assistance
│   │   ├── code_assistant.py           # AI-powered natural language processing
│   │   ├── enhanced_main_assistant.py  # Production-ready AI assistant
│   │   ├── mcp_integration.py          # MCP protocol integration
│   │   └── warehouse_automation_patterns.py # Industrial automation patterns
│   ├── sdk_interface/
│   │   └── studio5000_sdk.py           # Real Studio 5000 SDK integration
│   ├── documentation/                  # Vector-powered documentation search
│   │   ├── instruction_vector_db.py    # Instruction search vector database
│   │   └── instruction_mcp_integration.py # MCP tools for instruction search
│   ├── l5x_analyzer/                   # Advanced L5X file analysis
│   │   ├── l5x_vector_db.py           # L5X semantic search system
│   │   ├── l5x_mcp_integration.py     # L5X analysis MCP tools
│   │   └── sdk_powered_analyzer.py    # SDK-enhanced L5X analysis
│   ├── sdk_documentation/              # SDK documentation search
│   │   ├── sdk_vector_db.py           # SDK documentation vector search
│   │   ├── sdk_doc_parser.py          # SDK documentation parser
│   │   └── mcp_sdk_integration.py     # SDK documentation MCP tools
│   ├── tag_analyzer/                   # Tag analysis and management
│   │   ├── tag_vector_db.py           # Tag-based vector search
│   │   ├── csv_tag_parser.py          # CSV tag file parsing
│   │   └── tag_mcp_integration.py     # Tag analysis MCP tools
│   └── verification/                   # Code validation system
│       ├── sdk_verifier_clean.py      # Fast validation (production)
│       └── sdk_verifier.py           # Legacy SDK validation (deprecated)
├── *_vector_cache/                     # Vector database cache directories
│   ├── instruction_vector_cache/       # Instruction search cache
│   ├── l5x_vector_cache/              # L5X analysis cache
│   ├── sdk_vector_cache/              # SDK documentation cache
│   └── tag_vector_cache/              # Tag analysis cache
├── examples/                           # Example generated projects
├── docs/                              # Additional documentation
├── requirements.txt                    # Python dependencies (includes vector DB)
├── mcp_config.json                    # Sample MCP configuration for Claude
└── README.md                          # This comprehensive documentation

关键文件

• 主服务器：src/mcp_server/studio5000_mcp_server.py（包含 15+ 个工具的主 MCP 服务器）

• AI 助手：src/ai_assistant/enhanced_main_assistant.py（生产就绪的 AI 助手）

• L5X 生成器：src/code_generator/l5x_generator.py（创建可导入的 L5X 文件）

• L5X 分析器：src/l5x_analyzer/l5x_vector_db.py（对 L5X 文件进行语义搜索）

• 快速验证：src/verification/sdk_verifier_clean.py（生产验证系统）

• SDK 接口：src/sdk_interface/studio5000_sdk.py（创建真实的 .ACD 文件）

• 向量数据库：*_vector_cache/ 目录（基于 FAISS 的语义搜索）

• 配置：环境变量或命令行参数

贡献

当前能力 - 诚实评估

✅ 实际可用的功能（生产就绪）：

• ✅ 官方 Studio 5000 文档解析（带向量搜索的 HTML）

• ✅ AI 驱动的梯形逻辑文本生成（为手动开发提供良好基础）

• ✅ 创建空 .ACD 文件（基于 SDK 的可靠模板生成）

• ✅ 快速验证系统（0.001 秒响应，100% 可靠）

• ✅ 向量驱动的语义搜索（基于 FAISS，生产级规模）

• ✅ L5X 文件分析（已使用 49k+ 行文件测试）

• ✅ SDK 文档搜索（全面的方法数据库）

• ✅ 模式识别（启动/停止、定时器、计数器模式）

⚠️ 部分可用的功能（需要手动修复）：

• ⚠️ L5X 项目文件生成（可创建结构，但 RLL 格式存在问题）

• ⚠️ 完整的 ACD 创建（实验性 SDK 部分导入功能）

• ⚠️ 智能代码插入（分析可用，插入依赖 SDK）

🔧 需要开发的功能：

• 🔧 正确的 RLL XML 生成（当前在 CDATA 中输出原始文本）

• 🔧 可靠的 SDK 部分导入（复杂且容易出错）

• 🔧 端到端项目自动化（当前需要手动步骤）

未来增强机会

高优先级（已完成！✅）：

• ✅ 完整的 SDK 集成：已完成！现已实现完整的程序/任务创建

• ✅ 例程导入/导出：已完成！使用 SDK 的部分导入功能

• ✅ 程序结构创建：已完成！自动创建 MainProgram 和 MainTask

• 标签管理：实现 SDK 标签创建和管理操作（待办）

• 高级项目操作：构建、升级和部署自动化（待办）

中优先级（功能扩展）：

• 附加语言支持：结构化文本（ST）和功能块图（FBD）生成

• 增强模式识别：更复杂的工业自动化模式

• ✅ SDK 文档改进：已完成！解析器现在可找到 63 个 LogixProject 方法 + 39 个示例 = 102+ 个操作（原为 22 个）

• 高级验证：静态分析和最佳实践检查

低优先级（扩展集成）：

• 多个 Studio 5000 版本：动态版本检测和兼容性

• 集成扩展：支持 FactoryTalk View、RSLinx 和其他 Rockwell 工具

• 云部署：基于 Web 的团队协作界面

• 缓存系统：改善大型文档集的性能

🎯 诚实的价值：AI 辅助开发工作流

该系统为 PLC 开发提供有价值的 AI 辅助：

• ✅ AI 逻辑生成：将自然语言转换为梯形逻辑文本（运行良好）

• ✅ 空 ACD 模板：可直接用于手动开发的干净项目文件（可靠）

• ⚠️ L5X 结构创建：创建可能需要格式修复的项目模板（部分可用）

• ✅ 快速验证：即时语法和指令检查（生产就绪）

• ✅ 向量搜索：对现有项目进行语义分析（生产就绪）

您可以提出："生成带卡料检测的输送机控制逻辑"，并获得高质量的梯形逻辑代码，作为手动开发的基础。AI 提供辅助，但人类工程师仍需实施和验证最终解决方案。

开发环境设置

1. Fork 该仓库

2. 安装 Python 3.12 和依赖项

3. 为您的 Studio 5000 安装设置环境变量

4. 运行测试以验证功能

5. 提交带有清晰文档的拉取请求

许可证和法律

重要法律信息：

• 本项目按原样提供，仅用于教育和开发目的

• Studio 5000、Logix Designer、ControlLogix 和 Allen-Bradley 是 Rockwell Automation, Inc. 的商标

• 本软件与 Rockwell Automation 无关联，未经其认可，也不受其支持

• 用户必须拥有有效的 Studio 5000 许可证才能使用 SDK 功能

• 生成的代码和项目在用于生产环境之前，应由合格人员进行验证

免责声明：此工具辅助 PLC 编程，但不能替代工业自动化系统所需的适当工程实践、安全分析或合规性验证。