Expand description
Plugins as clients see them: what a chat can use, where each plugin comes from, whether it is on, which settings it still needs, and what went wrong loading it.
A plugin is a folder with a byob-plugin.json (tools, skills, subagents, MCP servers,
settings). It lives in one of three scopes; the same id resolves chat > workspace >
global, and the less specific copy is listed with PluginInfo::shadowed_by:
- chat (scratch):
<data>/chats/<chat>/plugins/<id>; what the model made in this chat withmake_tooland friends. Never asked about; gone with the chat. - workspace:
<workspace>/.byob/plugins/<id>, committed with the repo. - global:
<config>/plugins/<id>(plussettings.jsonplugin_dirsand--plugin).
The engine sends ServerMsg::Extensions for the chat a
client looks at after ServerMsg::ChatOpened, and again
whenever something changes (a reload, a switch, a setting, a server connecting). Setting
values never leave the engine: clients only learn whether each one is set.
Extensions::slash lists what a message may start with (/name args): the engine
expands it when the turn starts (see SlashKind).
Structs§
- Backend
Info - A plugin’s long-lived backend process (13.2+; see
docs/plugins-backend.md). - Extensions
- Every plugin the chat in view can see (also the new chat a client is about to start).
- Plugin
Card - A “plugin card” on a step that changed a plugin ([
crate::Step::plugin]). - Plugin
Info - One plugin a chat can see.
- Plugin
Load Error - A plugin folder that couldn’t load at all (bad manifest, duplicate id).
- Plugin
Setting - A value a plugin asks the user for (an API key, a folder). The value itself never reaches clients.
- Plugin
Test - The result of running a tool once with test arguments (
make_tool’stry_args). - Renderer
Decl - A plugin’s renderer for one content type:
rendererisweb(the web surface),text(the source) ornative:<id>(one of the client’s in-tree renderers). A client that doesn’t have it shows the text source. - Server
Info - One of a plugin’s MCP servers.
- Slash
Item - One entry of the
/menu. - Starter
Decl - A suggestion for an empty chat:
titleon the button,promptsent (or put in the composer).
Enums§
- Plugin
Action - What a step did to a plugin.
- Plugin
Origin - Who wrote a plugin.
- Plugin
Scope - Where a plugin lives (see the module docs).
- Server
State - The state of one of a plugin’s MCP servers.
- Slash
Kind - What a
/nameat the start of a message is.
Constants§
- MAX_
SETTING_ VALUE_ CHARS - Most characters of a plugin setting’s value.
- MAX_
TRUSTED_ AT_ ONCE - Most plugins one
crate::ClientMsg::TrustPluginsmay name.