Tool schemas

📝 JSON Schema 与工具调用学习笔记

一、 JSON Schema 核心概念

• 定义： JSON Schema 是一种数据验证规范 (Data Validation Specification)。
• 作用： 它是一套用于验证任何 JSON 数据的规则，不局限于语言模型或工具调用。
• 在 LLM 中的用途： 语言模型社区利用它作为一种便捷的方式，向模型（如 Claude）描述可用的工具及其所需参数。

二、 工具配置结构

工具配置对象包含以下关键部分：

• 名称 (Name)： 工具的唯一标识（例如：get_weather）。
• 工具描述 (Description)： 告知模型工具的功能、何时使用以及返回的数据类型。
• 最佳实践： 描述应详细，建议 3-4 句话。
• 输入模式 (Input Schema)： 这是实际的 JSON Schema 规范，用于描述函数所需的参数。
• 参数描述： 必须详细说明该参数控制的内容及其对函数调用的影响（建议 3-4 句话）。

三、 实践技巧与最佳实践

• 生成 Schema 的技巧：
• 可以利用 Claude 等 LLM 和 Anthropic API 文档作为提示 (prompt)，要求它们根据函数定义生成高质量的 JSON Schema 规范。
• 代码命名约定：
• 建议将工具函数的名称与对应的 Schema 变量名匹配，例如：get_current_date_time_schema。
• 类型安全：
• 在代码中，应使用 ToolParam (从 anthropic. types 导入) 来包裹整个字典，以防止后续出现类型错误。

Takeaways

• JSON Schema 是一种数据验证规范，在 LLM 中用于描述可用的工具及其所需参数。
• 工具配置结构必须包含名称、详细的功能描述以及实际的输入模式（Input Schema）。
• 实践中，可以利用 LLM 根据函数定义自动生成高质量的 JSON Schema 规范。
• 为确保代码的类型安全，应使用 ToolParam 等特定类型包裹整个字典。