SuperAPI AI 工具集

tool-use-schema-design

设计与创作

查看项目

更新于 10-15 19:50

技能介绍

用途:为函数调用型智能体设计工具 schema(工具定义)。资料强调工具 schema 本身就是提示词,糟糕的 schema 比糟糕的提示词更容易导致错误调用。适用于为 Claude、GPT、Gemini、Bedrock、MCP server 定义工具,或模型出现参数错误、调用顺序错误、不调用工具、新增工具后智能体退化等场景。

主要能力与规则:一工具一职责,描述里出现“或”就应拆分;名称是最强信号,采用动词+名词+范围,如 get_customer_by_id,避免 fetch;每个参数都要有描述、示例和约束;返回结构也是 schema 的一部分,需有文档、类型且稳定;错误是一等公民,应定义类型化错误码而非自由字符串,便于模型确定性恢复。

设计决策:若已有工具能完成则扩展其描述而非新增;不可逆操作需显式确认参数或拆为 propose_X 与 commit_X;参数≥4 个或含可选参数时考虑按用例拆分;返回超过一页数据时加分页与摘要模式;可能被循环调用时在描述中加硬限制并在服务端强制。

命名模式:动作使用 verb_noun(create_invoice、cancel_order);查找使用 get_noun_by_key(get_user_by_email);集合使用 list_noun 并分页;模糊查询使用 search_noun。避免 do_thing、helper、util、process、handle。

参数规则:封闭集合用 enum;歧义处用 ID 而非名称;日期用 ISO 8601 UTC;不用魔法哨兵值;明确必填与可选,默认值要显式记录。

反模式:万能工具、自由文本 payload、两个 80% 重叠的工具、返回 HTML 或标记而非结构化数据、静默失败、描述中无示例。

限制:资料未提供具体安装命令、收费、价格或平台支持细节;相关参考文件(parameter-patterns.md、error-shapes.md、mcp-notes.md)与关联技能仅被提及,未展开内容。