Metadata Format Reference

Technical specification for PegBoard tool metadata files.

Overview

Every tool in your workspace has a corresponding metadata.json file that stores its name, description, and timestamps. These files are stored in {{app_data_dir}}/workspaces/{{software_type}}/{{tool_id}}/ and can be edited manually or programmatically.

Schema

Basic Structure

{
  "name": "My Tool",
  "description": "Tool description",
  "software_type": "blender",
  "created_at": "2025-11-02T12:34:56.789Z",
  "updated_at": "2025-11-02T12:34:56.789Z"
}

Field Definitions

name

String (required)

Display name of the tool shown in PegBoard and loaders.

description

String (optional)

Description of what the tool does.

software_type

String (required)

Target software: "blender", "revit", "rhino", or "sketchup"

created_at

String (required)

RFC3339 timestamp when the tool was created.

updated_at

String (required)

RFC3339 timestamp when the tool was last modified.

Note: The tool ID is not stored in metadata.json. It is derived from the folder name (UUID format).

File Structure

Tools are stored in workspace folders with the following structure:

{{app_data_dir}}/workspaces/

blender/

{{tool_id}}/

metadata.json

tool.py

sketchup/

{{tool_id}}/

metadata.json

tool.rb

rhino/

{{tool_id}}/

metadata.json

tool.py

revit/

{{tool_id}}/

metadata.json

tool.py

Complete Example

{
  "name": "Batch Export Layers",
  "description": "Export each layer to separate FBX file",
  "software_type": "blender",
  "created_at": "2025-11-02T10:30:00.000Z",
  "updated_at": "2025-11-02T10:30:00.000Z"
}

Back to Advanced SSO Setup