SuperAPI AI 工具集

agent-tool-design

智能体与模型

查看项目

更新于 10-16 02:36

技能介绍

用途:为智能体可调用的工具提供设计规范,使工具被调用时更可靠、可重试、易解析。核心内容为「智能体工具契约」的 5 项原则。

主要能力: 一、可预测签名。参数必须带类型与名称,明确区分必填与可选,避免位置参数带来的歧义,例如 function searchCode({ query, limit = 20, type = 'semantic' })。 二、丰富错误。错误需包含机器可读的错误码、人类可读的消息与调试上下文,例如抛出 { code: 'FILE_NOT_FOUND', message, context },而非仅 throw new Error('not found')。 三、节省 token 的输出。只返回结构化最小数据,不含散文式说明与冗余包装,例如 return { files: [...], total: 2 },而非带 status、message、metadata 的成功包络。判断标准是:若输出含智能体需要重读来提取事实的散文,即为过于冗长。 四、幂等性。工具需可安全重试,重复调用与单次调用结果一致,采用 upsert 语义、fs.mkdirSync(path, { recursive: true }) 等模式,避免 db.insert 的重复键错误与 mkdir 的 EEXIST 错误。 五、优雅降级。部分成功优于整体失败,返回 { succeeded, failed, partial: true },而不是因单个文件失败让整批任务抛错。

资料还给出反模式表(冗长状态包装、位置参数、吞掉异常、非幂等写操作、部分输入整体失败、读操作带副作用、仅字符串错误、返回结构无类型)及修复方式;上线前的审查清单,涵盖命名参数、必填可选显式化、错误路径统一返回 { code, message, context }、输出无散文、可重试、部分失败返回部分结果、以 JSDoc 或 TypeScript 类型记录返回结构、估算输出 token 预算(标准工具少于 500 tokens)。铁律包括:始终使用命名参数;始终提供机器可读错误码;绝不读写混用同一工具;始终按幂等设计;部分失败始终返回部分结果。

使用方式:该技能由 tool-creator 技能在设计新工具时使用,由 code-reviewer 代理在工具 PR 中审查,与 dynamic-api-integration 技能配合、与 agent-evaluation 技能互补。另要求遵循记忆协议:开始前阅读 .claude/context/memory/learnings.md,完成后按新增模式、发现问题、做出决策分别写入 learnings.md、issues.md、decisions.md,并假定中断随时发生。

限制:资料未提供该技能的安装命令、版本、许可、收费与支持平台等信息,暂未提供。