agent-runners/plugins.schema.json at main · sidebutton/agent-runners · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/sidebutton/agent-runners/blob/main/plugins.schema.json",
  "title": "Agent runners plugins catalog",
  "description": "Catalog of installable SideButton agent plugins. A plugin is a small package (plugin.json + handlers) that the SideButton MCP server loads from ~/.sidebutton/plugins/ and exposes as MCP tools. The install step base/19b-plugins.sh resolves a slug to its public git repo from this file and runs `sidebutton plugin install`. The portal vendors this file as the single source of truth for plugin display metadata; agent-runners is the source of truth.",
  "type": "object",
  "required": ["version", "plugins"],
  "properties": {
    "$schema": { "type": "string" },
    "version": {
      "type": "integer",
      "minimum": 1,
      "description": "Manifest format version. Bump when the shape of an entry changes in a non-additive way."
    },
    "plugins": {
      "type": "array",
      "items": { "$ref": "#/$defs/plugin" }
    }
  },
  "$defs": {
    "plugin": {
      "type": "object",
      "required": ["slug", "name", "description", "repo"],
      "properties": {
        "slug": {
          "type": "string",
          "pattern": "^[a-z0-9][a-z0-9-]*$",
          "description": "Stable id. base/19b-plugins.sh uses the install detail (repo/ref) here to install the slugs passed in SIDEBUTTON_PLUGINS. Matches the plugin.json `name` of the installed plugin."
        },
        "name": { "type": "string", "description": "Display name shown on the fleet list + agent detail." },
        "description": { "type": "string", "description": "One-line description shown in the agent detail plugins section." },
        "repo": {
          "type": "string",
          "pattern": "^[^/]+/[^/]+$",
          "description": "Public GitHub repo (owner/name) the install step clones anonymously."
        },
        "ref": {
          "type": "string",
          "description": "Branch or tag to clone. Defaults to 'main' when omitted.",
          "default": "main"
        },
        "submodules": {
          "type": "boolean",
          "description": "Clone with --recurse-submodules (e.g. writing-quality vendors humanizer + stop-slop). Defaults to false.",
          "default": false
        },
        "system_deps": {
          "type": "array",
          "items": { "type": "string" },
          "description": "apt packages the plugin needs at runtime (e.g. ['ffmpeg'] for screen-record). Installed as root before the plugin copy. Defaults to [].",
          "default": []
        },
        "default_roles": {
          "type": "array",
          "items": { "type": "string" },
          "description": "Roles this plugin is pre-checked for in the wizard's Step-2 plugin picker. Use [\"*\"] for all roles. The portal's pluginsForRoles() selects a plugin when its default_roles contain \"*\" or intersect the chosen roles. Defaults to [] (never auto-selected).",
          "default": []
        }
      },
      "additionalProperties": false
    }
  }
}