JSON Schema for tools

🛠️ 工具使用：JSON Schema 学习笔记

一、核心概念

• JSON Schema 定义: 一种通用的数据验证技术，用于描述工具函数（Tool Function）所期望接收的参数（arguments）。
• 作用: 将工具函数的结构和参数信息发送给 Claude，帮助 Claude 理解如何使用该函数。
• 重要性: JSON Schema 不仅限于 LLM 或工具使用，它是一种广泛应用的数据描述标准。

二、创建 JSON Schema 的四步流程

假设函数 process_data 接收四个参数：IDs, profile, primary_ID, 和 value。

• 创建参数字典 (Dictionary):
• 以函数的所有关键字参数为键（keys）。
• 为每个参数提供包含预期数据类型的样本数据（sample data）。
• 转换为 JSON 字符串:
• 将步骤一的字典转换为 JSON 格式。
• 注意: Python 的布尔值 True 必须转换为 JSON 的小写 true。
• 使用转换工具:
• 利用在线工具（如 "JSON to JSON Schema converter"）将 JSON 数据自动转换为 JSON Schema 结构。
• 注意: 最终输出中通常需要删除 $schema 声明。
• 添加描述 (Description):
• 在 properties 对象中，为每个参数添加详细的描述，说明该参数的功能和用途。
• 在工具的整体描述中，提供详细信息。

三、最佳实践 (Best Practices)

• 工具整体描述:
• 应清晰说明工具的功能。
• 说明何时应该使用该工具（when to use）。
• 说明工具返回的数据类型。
• 建议描述长度为三到四句话。
• 描述生成技巧:
• 如果难以撰写描述，可以直接将函数代码复制粘贴给 Claude，要求它生成参数描述。

四、后续步骤

• 完成 JSON Schema 的编写后，下一步是将该 Schema 与调用 Claude 的请求一起发送，使 Claude 了解该工具的可用性。

Takeaways

• JSON Schema 是一种数据验证技术，用于描述工具函数（Tool Function）所期望接收的参数结构给 Claude。
• 创建 JSON Schema 的核心流程包括：构建参数字典 → 转换为 JSON 字符串 → 使用转换工具 → 添加详细描述。
• 工具描述必须清晰，应包含工具的功能、何时使用该工具以及工具返回的数据类型。
• 完成 JSON Schema 编写后，下一步是将该 Schema 与调用 Claude 的请求一同发送，以告知 Claude 工具可用性。