SuperAPI AI 工具集

script-best-practices

编程与开发

查看项目

更新于 10-16 00:29

技能介绍

用途:为在技能中捆绑可执行脚本提供规范,明确何时应捆绑脚本、如何编写与组织脚本,以及在 SKILL.md 中如何说明脚本用法。

主要能力与要点: 何时捆绑脚本:同一代码会被反复重写、需要确定性可靠性、需要复杂校验,或生成代码的 token 成本高于执行成本时。 错误处理:显式处理错误,而非直接抛给 Claude。示例中捕获 FileNotFoundError 时创建文件,捕获 PermissionError 时打印错误并返回 None。 常量注释:每个魔法数字需说明理由,例如 TIMEOUT = 30、MAX_RETRIES = 3、BATCH_SIZE = 100 均附注原因。 在 SKILL.md 中明确意图:区分“执行脚本”(运行 scripts/analyze.py 提取 PDF 表单字段)与“仅作参考阅读”(查看 scripts/analyze.py 的提取算法,不要直接运行)。 脚本组织:目录结构为 skill-name/ 下含 SKILL.md 与 scripts/,scripts/ 内包含主入口 analyze.py、校验工具 validate.py 以及 helpers/ 共享工具。 依赖:显式列出依赖,如 pip install pdfplumber python-docx,或使用 pip install -r scripts/requirements.txt。 退出码:使用一致退出码,如 EXIT_SUCCESS = 0、EXIT_INVALID_INPUT = 1、EXIT_FILE_NOT_FOUND = 2、EXIT_PERMISSION_ERROR = 3。 输出格式:输出应可解析,推荐用 json.dumps 输出结构化结果,而非非结构化文本。 幂等性:脚本应可安全重复运行,例如用 os.makedirs(path, exist_ok=True) 确保目录存在,用 write_if_changed 仅在内容变化时写入。

使用方式:作为编写技能脚本时的参考规范,按上述模式组织代码、声明依赖与说明执行意图。 限制:资料未说明适用平台、许可、价格或具体运行时版本。