Settings fields

bb 0.43.3·SDK 0.4.104·pinned e865697 (desktop-v0.43.3)

stable Plugin settings page #1 in group Show on the zone map

Declares the settings your plugin needs as plain data; bb renders the form for them on the plugin's settings page and stores the values. With this, a plugin can:

What it gives you

• Declare each field's type (text, number, toggle, choice, or project) with a label and an optional default
• Get the form, its validation, and autosaving without writing any UI
• Validate each proposed value with a synchronous, non-transforming Standard Schema through experimental_schema; Zod schemas qualify
• Render multi-line text with experimental_multiline
• Mark a text field secret: bb stores it in a protected file on the server and never sends it to the browser
• Read values from server code, update them with experimental_set, or read non-secret values from plugin UI with useSettings()

API

Each symbol links to the pinned commit it was read at.

• PluginSettings interface
• PluginSettingsHandle interface
• PluginSettingDescriptor type
• PluginSettingsState interface

Used by

Custom instructions, GitHub, Provider retry, Workflows

Brief for agent…as a bb mentionAdd to set

The brief is Markdown, written for a coding agent: what the capability is, where it registers, every SDK symbol with a pinned permalink, the rules that bite, and what done means.