SuperAPI AI 工具集

client-interface-guidelines

编程与开发

查看项目

更新于 10-15 10:33

技能介绍

Client Interface Guidelines 是一个用于设计或评审“机器优先”命令行客户端界面的技能,主要服务于智能体(agent)执行场景。它适用于创建或改进那些需要稳定 JSON 输出、可被智能体可靠调用的 CLI/客户端工具。

用途 该技能被定位为智能体原生 CLI/客户端工具的默认把关标准。其设计取向是优先保证机器可靠性,把操作者的人工检查视为次要的调试与状态层,而不是与机器接口对等的界面模式。

主要能力 技能提供了一套工作流与参考文件体系,用于指导从契约设计到测试验证的全过程:

  • 阅读 references/00-how-to-use-this-skill.md 了解使用方法。
  • 从 references/09-agent-first-contract.md 开始,建立智能体优先契约。
  • 应用 references/10-agent-must-should-checklist.md 的必须/应当检查清单。
  • 使用 references/11-agent-test-matrix-template.md 进行验证。
  • 当 CLI 需要在本地设备、远程 beta、云端构建或其他交付路线之间选择时,使用 references/12-delivery-route-selection.md。
  • 使用 references/02 至 07 获取详细指导。
  • 可选运行 references/08-quick-review-checklist.md 做完整覆盖检查。

参考文件清单 references/00-how-to-use-this-skill.md、references/01-philosophy.md、references/02-basics-help-docs.md、references/03-output-errors.md、references/04-arguments-interactivity-subcommands.md、references/05-robustness-future-signals.md、references/06-configuration-environment.md、references/07-naming-distribution-analytics.md、references/08-quick-review-checklist.md、references/09-agent-first-contract.md、references/10-agent-must-should-checklist.md、references/11-agent-test-matrix-template.md、references/12-delivery-route-selection.md。

不可妥协项

  • 稳定的机器可读契约与 schema 版本化。
  • 支持 --no-input 的非交互运行。
  • 带稳定错误码并映射退出码的结构化错误。
  • 严格的 stdout/stderr 分离。
  • 安全的密钥处理,不通过 flag/env 传入密钥。
  • 可增量演进的接口,并带明确的弃用路径。
  • 除非有充分理由,否则默认以 JSON 作为行为契约。

适用场景 适合需要被智能体稳定调用的 CLI/客户端工具的设计与评审,尤其是要求结构化输出、非交互执行、可预测错误处理和清晰交付路线选择的场景。

限制 资料未提供该技能的具体安装命令、收费方式、价格、平台支持范围或实际使用效果等信息,这些内容暂未提供。