Jinba Toolbox
Guides

Import / Export

ToolSetをZIPファイルでインポート・エクスポートする方法

概要

ToolSetをZIPファイルとしてエクスポート・インポートできます。ローカルエディタで開発し、ZIPでインポートするワークフローに便利です。

ZIPファイル構造

my-toolset/
├── toolset.yml
└── tools/
    ├── tool-a/
    │   ├── tool.yml
    │   └── main.py
    └── tool-b/
        ├── tool.yml
        └── main.py

ファイル形式

toolset.yml

name: My ToolSet
description: ツールセットの説明
language: python  # python or typescript
packages:
  - name: requests
    version: "2.31.0"
  - name: beautifulsoup4
env:
  - key: API_KEY
    secret: true      # Exportで値が含まれない
  - key: LOG_LEVEL
    value: debug
フィールド説明
name表示名(必須)
languagepython または typescript(必須)
packagesインストールするパッケージ
env環境変数。secret: trueの変数はExport時にキーのみ

slugはディレクトリ名から自動決定されます。

tool.yml

name: My Tool
description: ツールの説明

slugはディレクトリ名から自動決定されます。

コードファイル

main.py(Python)または main.ts(TypeScript)にコードを記述します。

from pydantic import BaseModel

class Input(BaseModel):
    query: str

class Output(BaseModel):
    result: str

def run(input: Input) -> Output:
    return Output(result=input.query.upper())

Input/Outputスキーマはインポート時に自動抽出されます。

操作方法

Export

ToolSet画面の「Export」ボタンをクリックすると、{slug}.zipがダウンロードされます。

Import

  1. ToolSet画面の「Import」ボタンをクリック
  2. ZIPファイルを選択
  3. 「Import」を実行

「Overwrite existing tools」を有効にすると、同じslugのToolを上書きします。

エラー

エラー原因
Invalid ZIP: no root directory foundtoolset.ymlが見つからない
name and language are requiredtoolset.ymlの必須フィールドが不足
tool.yml not found for toolツールにtool.ymlがない
main.{ext} not found for toolツールにコードファイルがない

On this page