Jinba Toolbox
Guides

Import / Export

How to import and export ToolSets as ZIP files

Overview

Export and import ToolSets as ZIP files. Convenient for developing with local editors and importing via ZIP.

ZIP File Structure

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

File Formats

toolset.yml

name: My ToolSet
description: ToolSet description
language: python  # python or typescript
packages:
  - name: requests
    version: "2.31.0"
  - name: beautifulsoup4
env:
  - key: API_KEY
    secret: true      # Value excluded on export
  - key: LOG_LEVEL
    value: debug
FieldDescription
nameDisplay name (required)
languagepython or typescript (required)
packagesPackages to install
envEnvironment variables. secret: true exports key only

Slug is determined from the directory name.

tool.yml

name: My Tool
description: Tool description

Slug is determined from the directory name.

Code File

Write code in main.py (Python) or 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 schemas are automatically extracted on import.

Operations

Export

Click the "Export" button on the ToolSet screen to download {slug}.zip.

Import

  1. Click the "Import" button on the ToolSet screen
  2. Select a ZIP file
  3. Execute "Import"

Enable "Overwrite existing tools" to overwrite tools with the same slug.

Errors

ErrorCause
Invalid ZIP: no root directory foundtoolset.yml not found
name and language are requiredRequired fields missing in toolset.yml
tool.yml not found for toolTool missing tool.yml
main.{ext} not found for toolTool missing code file

On this page