SuperAPI AI 工具集

api-to-agent-cli

编程与开发

查看项目

更新于 10-15 17:22

技能介绍

用途:把内部 API/REST endpoint/SDK 重构为 agent 能高效调用的 CLI;也可对现有 CLI 做 agent-readiness retrofit 或打分。不适用:面向人类的 CLI、构建 MCP server、LLM eval pipeline。

核心约束:不允许 1:1 包装,必须先按业务 workflow 合并;必须 ship 配套 SKILL.md;必须通过 11 维 audit。

五阶段流程: Phase 1 Inventory:读取 OpenAPI/Swagger/Postman/SDK 文档或描述,让用户列出 agent 要解决的 Top 20 高频任务(数量须 ≥10),按 inventory.template.md 产出 inventory.md,用户 review 确认后进入下一阶段。 Phase 2 Workflow Merge(核心):把 N 个 endpoint 合并为 30–50 个 agent-facing command,每个 command 对应一个 agent task。要求 merge_ratio = endpoint_count / command_count,目标 3–10;< 3 须报警并拒绝继续。command 名用动词-名词(如 schedule-meeting),输入优先语义化标识(name/email/slug),注明内部 fan-out 与是否 mutation。 Phase 3 Command Stub:按 Typer 模板为每个 command 生成 Python stub。必须含 --output(默认 table,可选 json,非 TTY 自动切 json)、--fields、--limit/--page-token、mutation 的 --dry-run、输入校验(拒绝 control chars、路径穿越、? # %)、结构化 error JSON(含 suggestion)、语义化退出码(0/1/2/3/4/124)、schema 子命令;业务逻辑用注释占位。禁止交互式 prompt。 Phase 4 SKILL.md:编写配套 agent guide,包含 Invariants、Common Workflows(≥3 个完整案例)、Authentication、Rate Limits & Pagination、Examples,放在 CLI 仓库根。 Phase 5 Self-Audit:按 11 维 rubric 打分(每维 0/1/2,总分 22),总分 < 18 不通过,须回到对应 phase 修复;反模式每命中一条扣 2 分。audit-rubric 可独立调用,用于给现有 CLI 打分。

使用方式:按 references 与 assets 模板执行;Phase 3 参考 example-hello-cli。注意:不要追求一键自动转换,OpenAPI 多变(auth、嵌套 ref、polymorphic schema),需手工设计每个 command;Type hints 是 Typer 的关键。