加载中

创建好工具函数后,下一步就是编写一个 JSON schema 来描述它。这个 schema 会告诉 Claude 您的函数期望什么参数,以及如何正确使用它。虽然这个配置一开始看起来可能令人望而生畏,但一旦您理解了这个过程,其实非常简单直接。

理解 JSON Schema

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

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

创建 JSON Schema:分步指南

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

步骤 1:编写一个包含示例数据的字典

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

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

创建一个包含示例值的字典:

步骤 2:转换为 JSON

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

步骤 3:使用在线转换工具

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

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

步骤 4:添加描述

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

编写好的描述

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

  • 解释该工具的作用、何时使用以及返回什么
  • 工具描述力求 3-4 句话
  • 为每个属性提供超详细的描述
  • 如果您不知道怎么写,可以将您的函数粘贴给 Claude,让它为您编写描述

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

请注意该描述是如何清楚地解释天气工具的作用、何时使用、返回什么数据,并提供了有效位置格式的具体示例。

整合所有内容

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

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