加载中
加载中

在创建好您的工具函数之后,下一步是编写一个JSON schema来描述它。这个schema会告诉Claude您的函数需要什么参数,以及如何正确使用它。虽然这个配置乍看之下可能令人生畏,但一旦您理解了这个过程,它实际上非常简单。

理解JSON Schema

JSON Schema并不是专门为AI工具发明的东西——它作为一种验证数据的标准方式已经存在多年了。这个schema有两个主要部分:顶部的名称和描述(帮助Claude理解何时使用该工具),以及描述函数参数的实际schema。

一个get_weather的toolSpec,顶部框出了它的名称和描述,下方框出了要求有"location"的inputSchema。

顶部部分包含工具的名称和描述,这有助于Claude理解何时使用它。底部部分是详细描述您函数参数的实际schema。

创建JSON Schema:分步指南

这是为任何函数创建JSON schema的最简单方法:

步骤1:用示例数据编写一个字典

取您的函数,用示例数据创建一个包含所有关键字参数的字典。例如,如果您有这样一个函数:

python
def process_data(ids, profile, primary_id, value):
    pass

创建一个带示例值的字典:

process_data的字典:"ids"是一个包含1的列表,"profile"的"active"为True,"primary_id"为"abc","value"为20。

步骤2:转换为JSON

将您的Python字典转换为正确的JSON格式。主要区别是将Python的True改为JSON的true。

步骤1的字典转为JSON后,值保持不变,ids为1,primary_id为"abc",value为20,只是"active"现在是小写的true。

步骤3:使用在线转换器

搜索"JSON to JSON Schema converter",使用其中一个免费的在线工具。粘贴您的JSON数据,让它自动生成schema。

在线JSON到JSON Schema转换器:粘贴进去的示例JSON、一个Generate Schema按钮,以及下方推断出的schema。

该工具会分析您的示例数据并创建一个合适的schema结构。请从输出中删除任何$schema声明——您不需要它们。

步骤4:添加描述

最重要的一步是为每个属性添加详细的描述。这些描述可以帮助Claude准确理解每个参数的作用以及如何使用它。

JSON schema中,数字数组ids和字符串primary_id各自新增了一个设为三个点的"description"键。

编写良好的描述

在为您的工具和属性编写描述时,请遵循以下最佳实践:

  • 说明该工具的作用、何时使用它以及它返回什么
  • 工具描述力求保持在3到4句话
  • 为每个属性提供超级详细的描述
  • 如果您卡住了,可以将您的函数粘贴给Claude,让它为您写描述

这是一个描述良好的工具schema示例:

get_weather的JSON Schema,返回温度、天气状况和湿度,要求有一个"location",例如"London,UK"。

请注意描述是如何清晰地说明这个天气工具的作用、何时使用它、它返回什么数据,并提供有效location格式的具体示例的。

整合到一起

您最终的JSON schema应该看起来像这样的结构,toolSpec中包含名称、描述,以及带有详细参数规格的inputSchema:

get_weather的toolSpec schema:名称、一段多句描述,以及带有必需location字符串的inputSchema。

这个schema充当了您的代码与Claude之间的契约,确保当Claude决定使用您的工具时,它确切知道要提供什么信息以及以什么格式提供。正是这种清晰的沟通,使工具使用变得可靠而有效。