Skip to content

Maintain bundled plugins

Bundled plugins use the same public SDK and packaging tools as external plugins. Inclusion in the catalog does not bypass trust or automatically enable them.

Keep implementation, selectors, manifest, assets, tests, and README in the plugin directory. Import only public SDK types and helpers rather than runtime or adapter internals.

Declare the minimum capabilities. Preserve ID and compatible settings/storage across updates, and make cancellation side-effect-free.

Terminal window
pnpm build
pnpm catalog:build

The root build compiles packages/plugins and builds the catalog. catalog:build prepares the tooling and catalog when working on that path directly.

Use node packages/plugin-tools/cli.mjs pack plugins/<id> to produce a distributable ZIP. Building updates the manifest integrity hash; review expected hash changes when code or SDK output changes.

Confirm new catalog entries install disabled and that updates require explicit action and fresh trust. Test retained compatible settings/storage, repeated enable/disable, and cleanup.

Run the plugin’s tests, architecture checks, and relevant fixture acceptance. Update both the user-facing bundled-plugin article and developer example index if the feature or permission set changes.