Genbase

kit.yaml Reference

Detailed specification for the kit.yaml manifest file used to define Genbase Kits.

kit.yaml Reference

The kit.yaml file is the manifest for your Genbase Kit. It's a YAML file located at the root of your Kit's directory structure that defines metadata, configuration, capabilities, and resources. Genbase parses this file to understand how to install, configure, and utilize your Kit.

Top-Level Fields

These fields define the fundamental identity and characteristics of the Kit.

# --- Required Metadata ---
docVersion: v1           # Specification version (currently only "v1" is supported)
id: "my-unique-kit-id"   # Unique identifier for the kit within the owner's scope (lowercase, kebab-case recommended)
version: "1.0.0"         # Semantic Version (MAJOR.MINOR.PATCH)
name: "My Awesome Kit"   # Human-readable name for display
owner: "my-org"          # Namespace/Owner identifier (lowercase, kebab-case recommended)
 
# --- Optional Metadata ---
description: "A brief description of what this kit does." # Optional description for UI/Registry
 
# --- Dependencies & Environment ---
dependencies:            # Optional: List of Python packages required by tools
  - requests
  - beautifulsoup4
environment:             # Optional: List of environment variables the kit expects
  - name: "API_KEY"
    description: "API Key for the external service"
    required: true         # Default: false
  - name: "SERVICE_URL"
    description: "URL of the service endpoint"
    required: false
    default: "https://api.example.com" # Optional default value
 
# --- Runtime & Execution ---
image: "python:3.11-slim" # Optional: Base Docker image for tool execution (default: python:3.11-slim)
ports:                   # Optional: Ports to map from the tool container to the host
  - name: "WEB_UI"         # Name used for environment variable (PORT_WEB_UI)
    port: 8080             # Port inside the container
 
# --- Core Components (Detailed Below) ---
agents: [ ... ]          # Optional: Definitions for custom agents
profiles: { ... }        # Optional: Definitions for interaction profiles/workflows
provide: { ... }         # Optional: Definitions for resources provided to other modules
workspace: { ... }       # Optional: Definitions for initial workspace files & ignores

Detailed Sections

Validation

Genbase validates the kit.yaml file when a Kit is installed or uploaded. Ensure your YAML is well-formed and adheres to this specification. Referencing non-existent files (in instructions, workspace.files, tools) will likely cause errors during Module creation or Tool execution.

On this page