SuperAPI AI 工具集

fw-ai-actions-app

通用与其它

查看项目

更新于 10-16 01:09

技能介绍

用途:该技能是 Freshworks Platform 3.0 上开发 AI Actions 应用与集成的专家级技能,适用于创建、扩展或修复 actions.json 集成,由控制器在意图为 AI Actions 应用时调用。

主要能力与规则:请求参数必须保持扁平(flat),不允许嵌套对象,必要时可用原始类型数组但不能是对象数组;响应 schema 可以嵌套,但只保留必要字段;函数名在 actions.json 与 server.js 之间必须大小写完全一致;外部 HTTP 请求使用 $request.invokeTemplate 与请求模板;不得硬编码密钥,凭证只能用 iparams(secure: true)或 OAuth;每个 actions.json 中动作描述需控制在 200 字符以内以保证 LLM 可靠选工具。

项目结构:AI actions 应用不需要 app 文件夹,使用 actions.json、server/server.js、server/test_data/actionName.json、config/requests.json、config/iparams.json、manifest.json,并强制要求包含 README.md,记录可用动作与参数、认证配置及测试夹具运行方式。manifest 声明 common(requests、functions)并将支持的产品模块声明为空对象,engines 为 node 24.11.0、fdk 10.0.0(除非项目另有规定)。

工具链与校验:需 Node 24.x + FDK 10.x,缺失时用 fw-setup;旧应用在 validate 前需 /fdk-migrate 或手动 2.x 到 3.0 迁移;创建文件前先运行 /fw-setup-status。确定应用目录后从 <app-directory> 执行 fdk validate 与 FDK 测试服务器。

使用方式:示例流程为获取第三方 API 文档、在 parameters 中定义扁平字段(如 ticket_id、team_id)、实现 handler 与请求模板、编写测试数据,再运行 fdk validate。成功时 renderData(null, data),错误时 renderData({ status, message }, null),并对用户可见错误做脱敏。

限制:不适用于 Freshworks 应用仅做 UI 的通用工作,此类应使用 fw-app-dev 技能;不得为模仿厂商 JSON 而嵌套请求参数;第三方 API 端点必须先确认文档,不得假设。其他收费、价格或平台细节暂未提供。