SuperAPI AI 工具集

cloud-api-recipe-authoring

写作与研究

查看项目

更新于 10-16 11:41

技能介绍

用途

本技能用于撰写或修订「cloud-api-operations recipe」——即针对云开发高频管控面场景的操作文档,存放在 config/source/skills/cloud-api-operations/references/recipes/。目标是让「AI 可以 100% 操作云开发」可验证:每个高频场景都有一篇能照着跑通的 recipe,且每篇都建立在公开 API 之上。

适用时机包括:新增一篇 recipe、修改现有 recipe、判断某能力该不该进 recipe 集、更新目录表与状态列、复核已有 recipe 是否仍满足准入。

核心分工原则

产品排期中「对外开放 API」通常不优先,于是形成固定落差:控制台上了功能,AI 却操作不了。补齐落差有两条路,本技能不走「全都封装」那条,而是只封装核心,长尾走 recipe,以保持工具面稳定、降低模型选错工具的概率。

能力归属判断:有公开 API + 高频核心 → 已在 MCP / CLI 工具里,直接用;有公开 API + 长尾(串联多 Action、有非平凡前置、有踩坑或回查义务)→ 写 recipe;有公开 API + 单接口读文档即可调 → 既不封装也不写 recipe,现场查索引;没有公开 API(只在控制台可见)→ 谁也封装不了,属于产品缺口。

准入硬门槛(API first)

三条必须同时满足:一、有公开云 API,目标 Action 已列入公开 API 概览或接口文档;二、语言无关可调用,云 API 直调 / 官方 SDK / CLI / MCP 任一条通路均可,但必须是公开 API 的封装;三、写操作能由使用者独立完成,含签名、必要前置查询与加解密。不满足时不写进对外发布面,同时作为产品缺口反馈;维护者可归档到内部目录并写清未通过原因与解封条件。

正负向清单

不该写 recipe 的:读公开 API 概览加单个接口文档就能直接调的;已有专用 MCP 工具覆盖的;纯参数含义或概念说明;只对某个 SDK 语言成立的用法。

必须写 recipe 的:需要串联多个 Action 或多个产品的;有非平凡前置(CAM 授权升级、临时密钥、环境绑定、签名或加密)的;有实测踩坑的;调用后有回查或清理义务的。

固定结构

顺序固定为:When to use → 前置权限 → 接口序列 → 踩坑清单 → 验证步骤(入口特殊才加第六节「入口」)。

When to use 写可判定的触发条件并划界;前置权限写 service / version、凭据身份、所需 CAM 策略,要求能直接给出可点击的一键授权链接;接口序列写最小可跑序列,每一步返回值能对应下一步入参,表格每步带 service 列;踩坑清单用「坑 / 现象 / 正确做法」表格,每行对应真实报错;验证步骤每条有明确通过判据。

写作规则与文案红线

遵循单一可信源、context pointer、信息层级与渐进披露、co-location、完成条件、leading word、正面表述、环境即真源、剪枝等规则。对外文件不写验证过程、测试状态叙述、维护者待办、内部标识;「实测」是值级标记,贴在具体参数或返回值上,最多一个;可信度只记在 recipes/README.md 目录表的状态列(✅ 生产实证 / 🟡 部分实证 / 🟡 文档核对)。界面口径需单独标注,既不算实测也不算官方文档契约。

实测口径与判据

准入过了不等于能写,需先拿真账号跑通只读路径。callCloudApi 有环境绑定门禁,账号级登录后首个调用仍返回 ENV_REQUIRED。只跑 Describe* / Check* / Validate*,写操作留给使用者手动执行;有可自由支配的测试环境时写操作要真跑并还原,两个方向都跑。

读接口对「不属于当前凭据的目标」常静默返回成功加空值,实测前需先用一个「一定会报错」的接口探目标可达性。区分「未开通」与「不可达」需要确实属于当前凭据且该能力未开通的样本。同一个空值往往对应多种状态,判据字段有取值域时按取值域写全。

校验与产物链

改完必跑一系列脚本:generate-prompts-data.mjs、generate-prompts.mjs、sync-claude-skills-mirror.mjs、build-compat-config.mjs、check-prompts-sync.mjs、diff-compat-config.mjs、check-recipes.mjs。动过接口序列结构后必跑 check-recipes.mjs(校验表格结构与编号交叉引用)。新增或删除文本面会让 compat-diff 报 blocking,必须刷 baseline。新增或删除 recipe 只能用全量刷新。校验完成前不要宣称改完。

适用场景与限制

适用于云开发 AI 工具链的维护者,尤其是需要为长尾云 API 能力补充可执行文档的场景。限制在于:能力的可用性强依赖是否存在公开 API;权限判断需实测,历史结论不作为事实;角色挂载策略会随产品迭代变动,以实际策略内容为准;相对路径引用需拼接到仓库 raw 链接之后再取用。