ツールを構築して構成する

ビジネス サービスの公式 API ドキュメントと、アカウントで実行が許可されているタスクから始めます。限定的で詳細に説明された 1 つのツールは、任意の URL とメソッドを受け入れる汎用ツールよりもテストが簡単です。

リクエストを定義する#

ツールに安定した名前を付け、その目的、重要な制限、データを変更するかどうかを説明する説明を付けます。文書化された HTTP メソッドとエンドポイントを選択します。プレースホルダーは、操作で実際に許可される変数パス要素にのみ使用してください。

架空のレコード検索の場合、パスにレコード識別子が含まれる場合があります。ホスト名とアカウント領域は、オープンエンドのモデル入力ではなく、構成された接続の一部のままにする必要があります。

入力の定義とマッピング#

入力スキーマを使用して、各フィールド、そのタイプ、必要なステータス、および有効な値を記述します。架空のルックアップの簡単なスキーマは次のとおりです。

{
  "type": "object",
  "properties": {
    "record_id": {
      "type": "string",
      "description": "The verified identifier of the record to read"
    }
  },
  "required": ["record_id"],
  "additionalProperties": false
}

引数を文書化されたパス、クエリ、または本文フィールドにマップします。必須フィールドの欠落や予期しない追加の引数が明らかに失敗することを確認してください。プロンプト、サンプル スキーマ、またはハードコーディングされたツール ヘッダーではなく、サポートされているサーバー接続で認証を維持します。

出力を整形する#

応答マッピングまたは変換は、サービス応答全体ではなく、ワークフローに必要なフィールドを返すことができます。変換された出力を元のテスト結果と比較して検証します。結果が完全であるかどうかを理解するために必要なレコード識別子、ページネーション情報、またはエラーの詳細は削除しないでください。

動作設定を見直す#

ツール構成は、タイムアウト、キャッシュ、および再試行の設定をサポートしています。キャッシュは、古いデータが許容される場合にのみ使用してください。キャッシュされた読み取りは、書き込みが完了したばかりであることの最終的な証拠としては不適切です。非冪等書き込みを再試行すると重複が作成される可能性があるため、API の文書化された保証から再試行動作を選択してください。

実際のパスをテストする#

正しい入力、無効な入力、空の結果、権限の失敗、および制限付きの成功した呼び出しを確認します。テスト診断には機密リクエスト情報が含まれる場合があります。承認された管理者のルートを通じてのみ検査し、共有する前に編集してください。見る テスト クライアントがツールを使用する前に。