ツールの作成
Add Toolをクリック
Add Toolをクリックします。以下の項目を入力するモーダルが表示されます:
- Slug — URL用の識別子(例:
post-message)。APIエンドポイントで使用されます。 - Name — 人間が読みやすい名前(例:「Post Message」)。
- Description — ツールの機能の説明。
ツールエディタ
ツールエディタは、リサイズ可能なマルチパネルのワークスペースです:コードエディタ
Monacoベースのエディタ(VS Codeと同じエンジン)で、TypeScriptとPythonのシンタックスハイライト、自動補完、エラーマーカーを備えています。
テストパネル
JSON入力を入力し、ライブSandboxでツールを実行します。エディタを離れることなく、出力、エラー、ログを確認できます。
設定パネル
ツールのSlug、名前、説明を編集します。コードからメタデータの自動生成をトリガーできます。
AI Copilot
コードの生成、実行出力に基づく修正の提案、テスト入力の更新が可能な組み込みのチャットアシスタントです。
キーボードショートカット
| ショートカット | アクション |
|---|---|
Cmd/Ctrl + S | ツールを保存 |
Cmd/Ctrl + Enter | 現在のテスト入力でツールを実行 |
Cmd/Ctrl + B | AI Copilotサイドバーの表示切替 |
Cmd/Ctrl + , | 設定パネルの表示切替 |
Cmd/Ctrl + . | APIパネルの表示切替 |
Escape | アクティブなパネルまたはモーダルを閉じる |
TypeScriptでのツール作成
TypeScriptのツールはスキーマ定義にZodを使用します。inputとoutputのスキーマ、および非同期のrun関数をエクスポートします:
"zod"からzをインポートします。Sandboxにプリインストールされています。inputとoutputをZodスキーマとしてエクスポートします。バリデーションとAPIのJSON Schema生成に使用されます。runをエントリーポイントとしてエクスポートします。検証済みの入力を受け取り、出力スキーマに一致するオブジェクトを返す必要があります。- ToolSetのPackagesタブに登録されているパッケージを
importできます。 - 環境変数は
process.env経由でアクセスできます。
Pythonでのツール作成
Pythonのツールはスキーマ定義にPydanticを使用します。InputとOutputモデル、およびrun関数を定義します:
InputとOutputをPydanticのBaseModelサブクラスとして定義します。runをエントリーポイントとして定義します。検証済みの入力を受け取り、Outputモデルのインスタンスを返す必要があります。- ToolSetのPackagesタブに登録されているパッケージを
importできます。 - 環境変数は
os.environ経由でアクセスできます。
入力・出力スキーマ
スキーマには2つの目的があります:- バリデーション — Sandboxは実行前に入力を、実行後に出力を検証します。
- ドキュメンテーション — スキーマはAPIおよびMCPエンドポイントを通じて公開され、AIエージェントがツールの期待する入出力を理解できるようにします。
.describe()(Zod)またはField(description=...)(Pydantic)を使用して、明確な説明を提供してください。これらの説明はAPIドキュメントに表示され、AIエージェントがツールの呼び出し方法を理解するために使用されます。
メタデータの自動生成
設定パネルのAuto Generateをクリックすると、以下が自動的に抽出されます:- Slug — コード内の関数名やスキーマ名から導出されます。
- Name — コードから推定される人間が読みやすい名前。
- Description — ツールの機能の要約。
AI Copilot
AI Copilotサイドバーは、ツールのコード、言語、実行出力をコンテキストとして認識するチャットインターフェースを提供します。以下の用途に使用できます:- コード生成 — ツールに行わせたい処理を記述すると、Copilotが実装を作成します。
- エラーのデバッグ — テスト実行が失敗した後、Copilotにエラーの分析と修正の提案を依頼できます。
- コードの適用 — Copilotが生成したコードをエディタに直接反映し、自動保存できます。
- テスト入力の更新 — Copilotがテストパネルに適用するJSONテスト入力を提案できます。
Cmd/Ctrl + Bまたはサイドバーのボットアイコンで行います。
APIパネル
APIパネル(Cmd/Ctrl + .)を開くと、以下を確認できます:
- このツールを実行するためのREST APIエンドポイントURL。
- MCPエンドポイントURL(ToolSetでMCPが有効な場合)。
curlコマンドとSDK使用例のサンプル。- JSON Schema形式のツールの入力スキーマ。
保存と削除
- 保存 — Saveボタンをクリックするか、
Cmd/Ctrl + Sを押します。変更はドラフト状態に保存され、公開済みバージョンには影響しません。 - 削除 — ヘッダーのDeleteボタンをクリックします。確認ダイアログが表示されます。ツールを削除するとドラフト状態から削除されます。公開済みバージョンに含まれていた場合、それらのスナップショットは変更されません。
ベストプラクティス
- ツールを単機能に保つ。 各ツールは1つのことを適切に行うべきです。関連するツールをグループ化するにはToolSetを使用します。
- 分かりやすいスキーマを書く。 適切なフィールド説明は、AIエージェントがツールを正しく呼び出すのに役立ちます。
- 公開前にテストする。 新しいバージョンを公開する前に、テストパネルでさまざまな入力による動作を確認します。
- シークレットには環境変数を使用する。 APIキーやトークンをツールコードにハードコードしないでください。ToolSetのEnvironmentsタブに保存します。
- 反復にCopilotを活用する。 テスト実行が失敗した後、Copilotはエラー出力にアクセスでき、的確な修正を提案できます。
Jinba Toolbox