使用说明
AAS AI Editor
AI-Powered Editor for Industry 4.0 Digital Twins
为什么选择AAS AI编辑器?
创建和维护 资产管理外壳(AAS) 这很复杂——它们需要严格遵守元模型约束、语义ID和IDTA模板规范。手动编辑容易出错且耗时。
AAS人工智能编辑器 通过将可视化编辑器与 克劳德·艾 通过模型上下文协议(MCP):
- 🤖 人工智能辅助编辑 --Claude建议编辑、填充模板和自动更正验证错误
- ✅ 循环中的人类 --所有AI更改在申请前都需要您的明确批准
- 🔄 自我纠正验证 --人工智能通过迭代改进自动修复错误
- 📋 IDTA模板 --内置对标准化子模型模板的支持
从npm安装
独立使用软件包,无需克隆存储库:
MCP服务器(用于Claude集成)
# Run directly with npx
npx @aas-ai-editor/mcp-server
# Or add to Claude Code
claude mcp add aas-editor npx @aas-ai-editor/mcp-server
核心库(用于您自己的项目)
npm install @aas-ai-editor/core
import { readAasx, writeAasx } from '@aas-ai-editor/core/aasx';
import { selectSubmodelBySemanticId } from '@aas-ai-editor/core/aas';
const { environment } = await readAasx(aasxBuffer);
const nameplate = selectSubmodelBySemanticId(environment, 'https://admin-shell.io/...');
看 核心包文档 以获取API的完整参考。
开发设置
适用于希望在本地运行完整应用程序的贡献者。
先决条件
- Node.js 20+和pnpm 9+
- Python 3.11+(用于深度验证)
- 一 无烟煤API键
克隆并运行
# Clone the repository
git clone https://github.com/hadijannat/aas-ai-editor.git
cd aas-ai-editor
# Install dependencies
pnpm install
# Configure your API key
cp .env.example .env
# Edit .env and add: ANTHROPIC_API_KEY=sk-ant-...
# Start all services
pnpm dev
打开 http://localhost:5173 并在AI的帮助下开始编辑AASX文件。
Docker替代方案: 跑
pnpm docker:dev对于容器化设置。
特性
编辑
| 特性 | 描述 |
|---|---|
| 🌳 可视化树编辑器 | 使用直观的树界面导航AAS结构 |
| ✏️ 物业表格 | 使用类型感知表单控件编辑元素属性 |
| ↩️ 取消/重做 | 基于补丁操作的完整历史记录 |
| 📦 AASX支持 | 打开、编辑和保存标准AASX软件包 |
AI 助手
| 特性 | 描述 |
|---|---|
| 🤖 聪明的建议 | Claude建议根据您的内容进行上下文编辑 |
| 🔧 自动校正 | 自动修复验证错误(最多3次尝试) |
| 📋 模板填充 | AI用适当的值填充IDTA模板 |
| 👁️ 差异预览 | 在应用之前检查所有AI更改 |
验证
| 特性 | 描述 |
|---|---|
| ⚡ 快速验证 | 浏览器中的即时结构检查 |
| 🔬 深度验证 | 通过aas测试引擎进行完整的元模型验证 |
| 📐 模板验证 | 验证是否符合IDTA规范 |
| 🔗 背景调查 | 检测损坏的引用和缺失的元素 |
运作原理
flowchart LR
subgraph Browser["🌐 Browser"]
UI["Vue 3 UI<br/>Tree • Forms • Diff"]
end
subgraph Server["⚙️ Server"]
MCP["MCP Server<br/>22 Tools"]
Core["Core Library<br/>AASX • Patch • Diff"]
Val["Validation<br/>aas-test-engines"]
end
subgraph AI["🤖 AI"]
Claude["Claude<br/>Suggestions"]
end
UI <-->|"MCP Protocol"| MCP
MCP <--> Core
MCP <--> Val
MCP <-->|"Anthropic API"| Claude
人工智能工作流程:
- 您请求编辑(例如,“添加铭牌子模型”)
- Claude提出了基于IDTA模板的补丁
- 快速验证检查更改
- 如果存在错误,Claude会自动纠正(最多3次)
- 您审核差异并批准或拒绝
MCP工具参考
编辑揭露 22个MCP工具 对于AI交互:
文档工具
| 工具 | 说明 |
|---|---|
document_load |
将AASX文件加载到会话中 |
document_save |
将当前文档另存为AASX |
document_create |
创建新的空AAS环境 |
document_undo / document_redo |
浏览编辑历史记录 |
查询工具
| 工具 | 说明 |
|---|---|
query_list_submodels |
列出环境中的所有子模型 |
query_find_by_semantic_id |
按语义标识符查找元素 |
query_get_by_path |
获取JSON指针路径中的元素 |
query_list_elements |
列出子模型中的元素 |
query_get_pointer |
获取元素的JSON指针 |
query_diff |
比较文档的两个版本 |
编辑工具
| 工具 | 说明 |
|---|---|
edit_add |
在路径中添加新元素 |
edit_update |
更新现有元素 |
edit_delete |
移除一个元素 |
edit_move / edit_copy |
重新定位或复制元素 |
edit_batch |
以原子方式应用多个编辑 |
验证工具
| 工具 | 说明 |
|---|---|
validate_fast |
快速结构验证 |
validate_deep |
完整元模型验证 |
validate_summary |
汇总验证报告 |
validate_template |
检查IDTA模板的合规性 |
validate_auto_fix |
自动修复验证错误 |
技术栈
| 包装 | 用途 |
|---|---|
@aas-ai-editor/core |
AASX解析、补丁操作、差异算法、IDTA模板 |
@aas-ai-editor/mcp-server |
MCP协议服务器、Claude集成、会话管理 |
@aas-ai-editor/web-ui |
Vue 3 SPA,带有树编辑器、表单和审批工作流 |
validation-service |
Python FastAPI封装aas测试引擎 |
发展
| 命令 | 描述 |
|---|---|
pnpm dev |
以开发模式启动所有服务 |
pnpm dev:web |
仅启动web UI |
pnpm dev:mcp |
仅启动MCP服务器 |
pnpm test |
运行所有单元测试 |
pnpm test:e2e |
运行Playwright E2E测试 |
pnpm lint |
使用ESLint检查代码 |
pnpm typecheck |
运行TypeScript类型检查 |
pnpm build |
构建所有生产包 |
文档
| 文档 | 描述 |
|---|---|
| 架构概述 | 系统设计和组件交互 |
| MCP工具参考 | 完整的工具文档 |
| 数据流 | 数据如何在系统中移动 |
| 入门指南 | 分步教程 |
| 开发者指南 | 贡献和扩展 |
贡献
我们欢迎捐款!看 贡献.md 关于以下方面的指导方针:
- 报告问题
- 提交拉取请求
- 开发工作流程
- 代码风格
许可证
MIT许可证——见 许可证 了解详情。
Built with ❤️ for the Industry 4.0 community