Appearance
Cloud IDE 插件
Cloud IDE 插件在新建弹窗中对应“云侧插件 > 在 Cloud IDE 中创建”。它适合没有可直接调用的接口,或需要在平台托管环境中编写聚合、转换、校验和专用业务逻辑的场景。
与云侧 API 插件的区别
| 对比项 | Cloud IDE 插件 | 云侧 API 插件 |
|---|---|---|
| 执行位置 | AIOS 托管运行时 | 外部 HTTP/HTTPS 服务 |
| 工具实现 | IDE 中的 Node.js/Python3 代码 | HTTP 方法、路径和参数映射 |
| 依赖管理 | 在 IDE 项目中维护依赖包 | 由外部服务自行维护 |
| 适合场景 | 聚合、转换、轻量业务逻辑 | 已有稳定 API 的直接接入 |
创建插件
- 新建插件并选择“云侧插件”。
- 插件工具创建方式选择“在 Cloud IDE 中创建”。
- IDE 运行时选择 Node.js 或 Python3。
- 创建后进入插件详情,点击“在 IDE 中创建工具”。

图 1:选择云侧插件后,将工具创建方式切换为“在 Cloud IDE 中创建”,并选择运行时。

图 2:Cloud IDE 插件从详情页进入开发工作台;具体按钮会随插件状态变化。
Cloud IDE 工作台
历史文档中的 IDE 工作流与当前页面的核心结构一致,主要包含:
- 工具列表:创建、选择、编辑、重置或删除工具;一个插件可以维护多个工具。
- 依赖包:添加和移除项目依赖,同一插件内的工具共享依赖配置。
- 代码编辑:维护工具入口源码和异常处理逻辑。
- 元数据:维护工具信息、输入参数和输出参数。
- 测试代码:填写测试输入并运行工具。
- 控制台:查看发布、测试、依赖安装和运行日志。
- 发布:测试通过后填写版本名称和版本说明。
工具契约
Cloud IDE 工具不是只有代码。模型根据元数据决定是否调用以及如何传参,因此必须同步维护:
| 内容 | 要求 |
|---|---|
| 工具名称与说明 | 明确动作、适用条件和结果,避免使用“处理数据”之类泛化描述 |
| 输入参数 | 写明类型、必填、格式、单位、枚举和边界 |
| 输出参数 | 与真实返回对象一致,保证工作流可以选择字段 |
| 代码实现 | 校验输入、处理异常、返回结构化结果 |
历史 IDE 文档要求工具返回 JSON 对象。当前实现也应保持结构化返回;不要返回无法稳定解析的日志文本、HTML 页面或随运行变化的字段结构。
推荐开发顺序
- 创建一个最小工具,写清名称和用途。
- 先声明输入参数,再编写参数校验和主逻辑。
- 添加所需依赖,避免引入无关或来源不明的包。
- 处理空值、非法输入、超时和外部服务异常。
- 使用测试代码完成一次成功运行和至少一次失败场景。
- 根据真实结果维护输出参数,不能只依赖自动解析结果。
- 保存代码、依赖和元数据,再发布插件版本。
多工具与依赖管理
- 只把运行环境和业务边界一致的工具放在同一个插件中。
- 升级共享依赖前检查所有工具,不能只验证当前编辑的工具。
- 删除工具前先检查智能体、工作流和应用引用。
- 工具重命名会改变调用契约,应按不兼容变更处理。
运行与安全
- 不在源码中硬编码 Token、密码或环境地址。
- 对第三方请求配置合理超时,返回可定位但不泄密的错误。
- 临时文件在任务结束后清理,并限制文件大小和类型。
- 发布日志和测试结果要脱敏。
- 依赖版本变化后重新测试,不以“构建成功”代替真实运行。