怎样写「改配送地址」的参数、失败码和副作用注释,才不会把「查地址」那一轮做成写入?要细到什么程度才够?
题目
怎样写「改配送地址」的参数、失败码和副作用注释,才不会把「查地址」那一轮做成写入?要细到什么程度才够?
参考答案
点击展开参考答案
- 读和写必须在名字、参数和描述上无法对调,并且缺必填项时宁可调用失败,也不要靠默认值改掉生产地址。
- 写工具应要求已核实的
order_id、完整地址结构、以及显式确认;描述写清「只在用户明确要求修改且新地址已完整时使用;查询请用只读工具」。 - 错误返回要可执行,例如
ADDRESS_INCOMPLETE、ORDER_NOT_FOUND、NOT_ELIGIBLE,而不是「出错了」,这样下一轮会补参而不是改点更危险的工具。 - 先定副作用等级(改地址是难以当场回滚的履约动作),再定最小参数集(邮编不能让模型瞎填),再定禁用窗口(已发货、已妥投)。
- JSON Schema 用 required 和枚举卡住行政区划,自由文本只留门牌。