58 KiB
Paperclip Plugin System Specification
Status: proposed complete spec for the post-V1 plugin system
This document is the complete specification for Paperclip's plugin and extension architecture. It expands the brief plugin notes in doc/SPEC.md and should be read alongside the comparative analysis in doc/plugins/ideas-from-opencode.md.
This is not part of the V1 implementation contract in doc/SPEC-implementation.md. It is the full target architecture for the plugin system that should follow V1.
Current implementation caveats
The code in this repo now includes an early plugin runtime and admin UI, but it does not yet deliver the full deployment model described in this spec.
Today, the practical deployment model is:
- single-tenant
- self-hosted
- single-node or otherwise filesystem-persistent
Current limitations to keep in mind:
- Plugin UI bundles currently run as same-origin JavaScript inside the main Paperclip app. Treat plugin UI as trusted code, not a sandboxed frontend capability boundary.
- Manifest capabilities currently gate worker-side host RPC calls. They do not prevent plugin UI code from calling ordinary Paperclip HTTP APIs directly.
- Runtime installs assume a writable local filesystem for the plugin package directory and plugin data directory.
- Runtime npm installs assume
npmis available in the running environment and that the host can reach the configured package registry. - Published npm packages are the intended install artifact for deployed plugins.
- The repo example plugins under
packages/plugins/examples/are development conveniences. They work from a source checkout and should not be assumed to exist in a generic published build unless they are explicitly shipped with that build. - Dynamic plugin install is not yet cloud-ready for horizontally scaled or ephemeral deployments. There is no shared artifact store, install coordination, or cross-node distribution layer yet.
- The current runtime does not yet ship a real host-provided plugin UI component kit, and it does not support plugin asset uploads/reads. Treat those as future-scope ideas in this spec, not current implementation promises.
In practice, that means the current implementation is a good fit for local development and self-hosted persistent deployments, but not yet for multi-instance cloud plugin distribution.
1. Scope
This spec covers:
- plugin packaging and installation
- runtime model
- trust model
- capability system
- UI extension surfaces
- plugin settings UI
- agent tool contributions
- event, job, and webhook surfaces
- plugin-to-plugin communication
- local tooling approach for workspace plugins
- Postgres persistence for extensions
- uninstall and data lifecycle
- plugin observability
- plugin development and testing
- operator workflows
- hot plugin lifecycle (no server restart)
- SDK versioning and compatibility rules
This spec does not cover:
- a public marketplace
- cloud/SaaS multi-tenancy
- arbitrary third-party schema migrations in the first plugin version
- iframe-sandboxed plugin UI in the first plugin version (plugins render as ES modules in host extension slots)
2. Core Assumptions
Paperclip plugin design is based on the following assumptions:
- Paperclip is single-tenant and self-hosted.
- Plugin installation is global to the instance.
- "Companies" remain core Paperclip business objects, but they are not plugin trust boundaries.
- Board governance, approval gates, budget hard-stops, and core task invariants remain owned by Paperclip core.
- Projects already have a real workspace model via
project_workspaces, and local/runtime plugins should build on that instead of inventing a separate workspace abstraction.
3. Goals
The plugin system must:
- Let operators install global instance-wide plugins.
- Let plugins add major capabilities without editing Paperclip core.
- Keep core governance and auditing intact.
- Support both local/runtime plugins and external SaaS connectors.
- Support future plugin categories such as:
- new agent adapters
- revenue tracking
- knowledge base
- issue tracker sync
- metrics/dashboards
- file/project tooling
- Use simple, explicit, typed contracts.
- Keep failures isolated so one plugin does not crash the entire instance.
4. Non-Goals
The first plugin system must not:
- Allow arbitrary plugins to override core routes or core invariants.
- Allow arbitrary plugins to mutate approval, auth, issue checkout, or budget enforcement logic.
- Allow arbitrary third-party plugins to run free-form DB migrations.
- Depend on project-local plugin folders such as
.paperclip/plugins. - Depend on automatic install-and-execute behavior at server startup from arbitrary config files.
5. Terminology
5.1 Instance
The single Paperclip deployment an operator installs and controls.
5.2 Company
A first-class Paperclip business object inside the instance.
5.3 Project Workspace
A workspace attached to a project through project_workspaces.
Plugins resolve workspace paths from this model to locate local directories for file, terminal, git, and process operations.
5.4 Platform Module
A trusted in-process extension loaded directly by Paperclip core.
Examples:
- agent adapters
- storage providers
- secret providers
- run-log backends
5.5 Plugin
An installable instance-wide extension package loaded through the Paperclip plugin runtime.
Examples:
- Linear sync
- GitHub Issues sync
- Grafana widgets
- Stripe revenue sync
- file browser
- terminal
- git workflow
5.6 Plugin Worker
The runtime process used for a plugin. In this spec, third-party plugins run out-of-process by default.
5.7 Capability
A named permission the host grants to a plugin. Plugins may only call host APIs that are covered by granted capabilities.
6. Extension Classes
Paperclip has two extension classes.
6.1 Platform Modules
Platform modules are:
- trusted
- in-process
- host-integrated
- low-level
They use explicit registries, not the general plugin worker protocol.
Platform module surfaces:
registerAgentAdapter()registerStorageProvider()registerSecretProvider()registerRunLogStore()
Platform modules are the right place for:
- new agent adapter packages
- new storage backends
- new secret backends
- other host-internal systems that need direct process or DB integration
6.2 Plugins
Plugins are:
- globally installed per instance
- loaded through the plugin runtime
- additive
- capability-gated
- isolated from core via a stable SDK and host protocol
Plugin categories:
connectorworkspaceautomationui
A plugin may declare more than one category.
7. Project Workspaces
Paperclip already has a concrete workspace model:
- projects expose
workspaces - projects expose
primaryWorkspace - the database contains
project_workspaces - project routes already manage workspaces
Plugins that need local tooling (file browsing, git, terminals, process tracking) can resolve workspace paths through the project workspace APIs and then operate on the filesystem, spawn processes, and run git commands directly. The host does not wrap these operations — plugins own their own implementations.
8. Installation Model
Plugin installation is global and operator-driven.
There is no per-company install table and no per-company enable/disable switch.
If a plugin needs business-object-specific mappings, those are stored as plugin configuration or plugin state.
Examples:
- one global Linear plugin install
- mappings from company A to Linear team X and company B to Linear team Y
- one global git plugin install
- per-project workspace state stored under
project_workspace
8.1 On-Disk Layout
Plugins live under the Paperclip instance directory.
Suggested layout:
~/.paperclip/instances/default/plugins/package.json~/.paperclip/instances/default/plugins/node_modules/~/.paperclip/instances/default/plugins/.cache/~/.paperclip/instances/default/data/plugins/<plugin-id>/
The package install directory and the plugin data directory are separate.
This on-disk model is the reason the current implementation expects a persistent writable host filesystem. Cloud-safe artifact replication is future work.
8.2 Operator Commands
Paperclip should add CLI commands:
pnpm paperclipai plugin listpnpm paperclipai plugin install <package[@version]>pnpm paperclipai plugin uninstall <plugin-id>pnpm paperclipai plugin upgrade <plugin-id> [version]pnpm paperclipai plugin doctor <plugin-id>
These commands are instance-level operations.
8.3 Install Process
The install process is:
- Resolve npm package and version.
- Install into the instance plugin directory.
- Read and validate plugin manifest.
- Reject incompatible plugin API versions.
- Display requested capabilities to the operator.
- Persist install record in Postgres.
- Start plugin worker and run health/validation.
- Mark plugin
readyorerror.
For the current implementation, this install flow should be read as a single-host workflow. A successful install writes packages to the local host, and other app nodes will not automatically receive that plugin unless a future shared distribution mechanism is added.
9. Load Order And Precedence
Load order must be deterministic.
- core platform modules
- built-in first-party plugins
- installed plugins sorted by:
- explicit operator-configured order if present
- otherwise manifest
id
Rules:
- plugin contributions are additive by default
- plugins may not override core routes or core actions by name collision
- UI slot IDs are automatically namespaced by plugin ID (e.g.
@paperclip/plugin-linear:sync-health-widget), so cross-plugin collisions are structurally impossible - if a single plugin declares duplicate slot IDs within its own manifest, the host must reject at install time
10. Package Contract
Each plugin package must export a manifest, a worker entrypoint, and optionally a UI bundle.
Suggested package layout:
dist/manifest.jsdist/worker.jsdist/ui/(optional, contains the plugin's frontend bundle)
Suggested package.json keys:
{
"name": "@paperclip/plugin-linear",
"version": "0.1.0",
"paperclipPlugin": {
"manifest": "./dist/manifest.js",
"worker": "./dist/worker.js",
"ui": "./dist/ui/"
}
}
10.1 Manifest Shape
Normative manifest shape:
export interface PaperclipPluginManifestV1 {
id: string;
apiVersion: 1;
version: string;
displayName: string;
description: string;
categories: Array<"connector" | "workspace" | "automation" | "ui">;
minimumPaperclipVersion?: string;
capabilities: string[];
entrypoints: {
worker: string;
ui?: string;
};
instanceConfigSchema?: JsonSchema;
jobs?: PluginJobDeclaration[];
webhooks?: PluginWebhookDeclaration[];
tools?: Array<{
name: string;
displayName: string;
description: string;
parametersSchema: JsonSchema;
}>;
ui?: {
slots: Array<{
type: "page" | "detailTab" | "dashboardWidget" | "sidebar" | "settingsPage";
id: string;
displayName: string;
/** Which export name in the UI bundle provides this component */
exportName: string;
/** For detailTab: which entity types this tab appears on */
entityTypes?: Array<"project" | "issue" | "agent" | "goal" | "run">;
}>;
};
}
Rules:
idmust be globally uniqueidshould normally equal the npm package nameapiVersionmust match the host-supported plugin API versioncapabilitiesmust be static and install-time visible- config schema must be JSON Schema compatible
entrypoints.uipoints to the directory containing the built UI bundleui.slotsdeclares which extension slots the plugin fills, so the host knows what to mount without loading the bundle eagerly; each slot references anexportNamefrom the UI bundle
11. Agent Tools
Plugins may contribute tools that Paperclip agents can use during runs.
11.1 Tool Declaration
Plugins declare tools in their manifest:
tools?: Array<{
name: string;
displayName: string;
description: string;
parametersSchema: JsonSchema;
}>;
Tool names are automatically namespaced by plugin ID at runtime (e.g. linear:search-issues), so plugins cannot shadow core tools or each other's tools.
11.2 Tool Execution
When an agent invokes a plugin tool during a run, the host routes the call to the plugin worker via a executeTool RPC method:
executeTool(input)— receives tool name, parsed parameters, and run context (agent ID, run ID, company ID, project ID)
The worker executes the tool logic and returns a typed result. The host enforces capability gates — a plugin must declare agent.tools.register to contribute tools, and individual tools may require additional capabilities (e.g. http.outbound for tools that call external APIs).
11.3 Tool Availability
By default, plugin tools are available to all agents. The operator may restrict tool availability per agent or per project through plugin configuration.
Plugin tools appear in the agent's tool list alongside core tools but are visually distinguished in the UI as plugin-contributed.
11.4 Constraints
- Plugin tools must not override or shadow core tools by name.
- Plugin tools must be idempotent where possible.
- Tool execution is subject to the same timeout and resource limits as other plugin worker calls.
- Tool results are included in run logs.
12. Runtime Model
12.1 Process Model
Third-party plugins run out-of-process by default.
Default runtime:
- Paperclip server starts one worker process per installed plugin
- the worker process is a Node process
- host and worker communicate over JSON-RPC on stdio
This design provides:
- failure isolation
- clearer logging boundaries
- easier resource limits
- a cleaner trust boundary than arbitrary in-process execution
12.2 Host Responsibilities
The host is responsible for:
- package install
- manifest validation
- capability enforcement
- process supervision
- job scheduling
- webhook routing
- activity log writes
- secret resolution
- UI route registration
12.3 Worker Responsibilities
The plugin worker is responsible for:
- validating its own config
- handling domain events
- handling scheduled jobs
- handling webhooks
- serving data and handling actions for the plugin's own UI via
getDataandperformAction - invoking host services through the SDK
- reporting health information
12.4 Failure Policy
If a worker fails:
- mark plugin status
error - surface error in plugin health UI
- keep the rest of the instance running
- retry start with bounded backoff
- do not drop other plugins or core services
12.5 Graceful Shutdown Policy
When the host needs to stop a plugin worker (for upgrade, uninstall, or instance shutdown):
- The host sends
shutdown()to the worker. - The worker has 10 seconds to finish in-flight work and exit cleanly.
- If the worker does not exit within the deadline, the host sends SIGTERM.
- If the worker does not exit within 5 seconds after SIGTERM, the host sends SIGKILL.
- Any in-flight job runs are marked
cancelledwith a note indicating forced shutdown. - Any in-flight
getDataorperformActioncalls return an error to the bridge.
The shutdown deadline should be configurable per-plugin in plugin config for plugins that need longer drain periods.
13. Host-Worker Protocol
The host must support the following worker RPC methods.
Required methods:
initialize(input)health()shutdown()
Optional methods:
validateConfig(input)configChanged(input)onEvent(input)runJob(input)handleWebhook(input)getData(input)performAction(input)executeTool(input)
13.1 initialize
Called once on worker startup.
Input includes:
- plugin manifest
- resolved plugin config
- instance info
- host API version
13.2 health
Returns:
- status
- current error if any
- optional plugin-reported diagnostics
13.3 validateConfig
Runs after config changes and startup.
Returns:
ok- warnings
- errors
13.4 configChanged
Called when the operator updates the plugin's instance config at runtime.
Input includes:
- new resolved config
If the worker implements this method, it applies the new config without restarting. If the worker does not implement this method, the host restarts the worker process with the new config (graceful shutdown then restart).
13.5 onEvent
Receives one typed Paperclip domain event.
Delivery semantics:
- at least once
- plugin must be idempotent
- no global ordering guarantee across all event types
- per-entity ordering is best effort but not guaranteed after retries
13.6 runJob
Runs a declared scheduled job.
The host provides:
- job key
- trigger source
- run id
- schedule metadata
13.7 handleWebhook
Receives inbound webhook payload routed by the host.
The host provides:
- endpoint key
- headers
- raw body
- parsed body if applicable
- request id
13.8 getData
Returns plugin data requested by the plugin's own UI components.
The plugin UI calls the host bridge, which forwards the request to the worker. The worker returns typed JSON that the plugin's own frontend components render.
Input includes:
- data key (plugin-defined, e.g.
"sync-health","issue-detail") - context (company id, project id, entity id, etc.)
- optional query parameters
13.9 performAction
Runs an explicit plugin action initiated by the board UI.
Examples:
- "resync now"
- "link GitHub issue"
- "create branch from issue"
- "restart process"
13.10 executeTool
Runs a plugin-contributed agent tool during a run.
The host provides:
- tool name (without plugin namespace prefix)
- parsed parameters matching the tool's declared schema
- run context: agent ID, run ID, company ID, project ID
The worker executes the tool and returns a typed result (string content, structured data, or error).
14. SDK Surface
Plugins do not talk to the DB directly. Plugins do not read raw secret material from persisted config.
The SDK exposed to workers must provide typed host clients.
Required SDK clients:
ctx.configctx.eventsctx.jobsctx.httpctx.secretsctx.assetsctx.activityctx.statectx.entitiesctx.projectsctx.issuesctx.agentsctx.goalsctx.datactx.actionsctx.toolsctx.logger
ctx.data and ctx.actions register handlers that the plugin's own UI calls through the host bridge. ctx.data.register(key, handler) backs usePluginData(key) on the frontend. ctx.actions.register(key, handler) backs usePluginAction(key).
Plugins that need filesystem, git, terminal, or process operations handle those directly using standard Node APIs or libraries. The host provides project workspace metadata through ctx.projects so plugins can resolve workspace paths, but the host does not proxy low-level OS operations.
14.1 Example SDK Shape
/** Top-level helper for defining a plugin with type checking */
export function definePlugin(definition: PluginDefinition): PaperclipPlugin;
/** Re-exported from Zod for config schema definitions */
export { z } from "zod";
export interface PluginContext {
manifest: PaperclipPluginManifestV1;
config: {
get(): Promise<Record<string, unknown>>;
};
events: {
on(name: string, fn: (event: unknown) => Promise<void>): void;
on(name: string, filter: EventFilter, fn: (event: unknown) => Promise<void>): void;
emit(name: string, payload: unknown): Promise<void>;
};
jobs: {
register(key: string, input: { cron: string }, fn: (job: PluginJobContext) => Promise<void>): void;
};
state: {
get(input: ScopeKey): Promise<unknown | null>;
set(input: ScopeKey, value: unknown): Promise<void>;
delete(input: ScopeKey): Promise<void>;
};
entities: {
upsert(input: PluginEntityUpsert): Promise<void>;
list(input: PluginEntityQuery): Promise<PluginEntityRecord[]>;
};
data: {
register(key: string, handler: (params: Record<string, unknown>) => Promise<unknown>): void;
};
actions: {
register(key: string, handler: (params: Record<string, unknown>) => Promise<unknown>): void;
};
tools: {
register(name: string, input: PluginToolDeclaration, fn: (params: unknown, runCtx: ToolRunContext) => Promise<ToolResult>): void;
};
logger: {
info(message: string, meta?: Record<string, unknown>): void;
warn(message: string, meta?: Record<string, unknown>): void;
error(message: string, meta?: Record<string, unknown>): void;
debug(message: string, meta?: Record<string, unknown>): void;
};
}
export interface EventFilter {
projectId?: string;
companyId?: string;
agentId?: string;
[key: string]: unknown;
}
15. Capability Model
Capabilities are mandatory and static. Every plugin declares them up front.
The host enforces capabilities in the SDK layer and refuses calls outside the granted set.
15.1 Capability Categories
Data Read
companies.readprojects.readproject.workspaces.readissues.readissue.comments.readagents.readgoals.readactivity.readcosts.read
Data Write
issues.createissues.updateissue.comments.createassets.writeassets.readactivity.log.writemetrics.write
Plugin State
plugin.state.readplugin.state.write
Runtime / Integration
events.subscribeevents.emitjobs.schedulewebhooks.receivehttp.outboundsecrets.read-ref
Agent Tools
agent.tools.register
UI
instance.settings.registerui.sidebar.registerui.page.registerui.detailTab.registerui.dashboardWidget.registerui.action.register
15.2 Forbidden Capabilities
The host must not expose capabilities for:
- approval decisions
- budget override
- auth bypass
- issue checkout lock override
- direct DB access
15.3 Upgrade Rules
If a plugin upgrade adds capabilities:
- the host must mark the plugin
upgrade_pending - the operator must explicitly approve the new capability set
- the new version does not become
readyuntil approval completes
16. Event System
The host must emit typed domain events that plugins may subscribe to.
Minimum event set:
company.createdcompany.updatedproject.createdproject.updatedproject.workspace_createdproject.workspace_updatedproject.workspace_deletedissue.createdissue.updatedissue.comment.createdagent.createdagent.updatedagent.status_changedagent.run.startedagent.run.finishedagent.run.failedagent.run.cancelledapproval.createdapproval.decidedcost_event.createdactivity.logged
Each event must include:
- event id
- event type
- occurred at
- actor metadata when applicable
- primary entity metadata
- typed payload
16.1 Event Filtering
Plugins may provide an optional filter when subscribing to events. The filter is evaluated by the host before dispatching to the worker, so filtered-out events never cross the process boundary.
Supported filter fields:
projectId— only receive events for a specific projectcompanyId— only receive events for a specific companyagentId— only receive events for a specific agent
Filters are optional. If omitted, the plugin receives all events of the subscribed type. Filters may be combined (e.g. filter by both company and project).
16.2 Plugin-to-Plugin Events
Plugins may emit custom events using ctx.events.emit(name, payload). Plugin-emitted events use a namespaced event type: plugin.<pluginId>.<eventName>.
Other plugins may subscribe to these events using the same ctx.events.on() API:
ctx.events.on("plugin.@paperclip/plugin-git.push-detected", async (event) => {
// react to the git plugin detecting a push
});
Rules:
- Plugin events require the
events.emitcapability. - Plugin events are not core domain events — they do not appear in the core activity log unless the emitting plugin explicitly logs them.
- Plugin events follow the same at-least-once delivery semantics as core events.
- The host must not allow plugins to emit events in the core namespace (events without the
plugin.prefix).
17. Scheduled Jobs
Plugins may declare scheduled jobs in their manifest.
Job rules:
- Each job has a stable
job_key. - The host is the scheduler of record.
- The host prevents overlapping execution of the same plugin/job combination unless explicitly allowed later.
- Every job run is recorded in Postgres.
- Failed jobs are retryable.
18. Webhooks
Plugins may declare webhook endpoints in their manifest.
Webhook route shape:
POST /api/plugins/:pluginId/webhooks/:endpointKey
Rules:
- The host owns the public route.
- The worker receives the request body through
handleWebhook. - Signature verification happens in plugin code using secret refs resolved by the host.
- Every delivery is recorded.
- Webhook handling must be idempotent.
19. UI Extension Model
Plugins ship their own frontend UI as a bundled React module. The host loads plugin UI into designated extension slots and provides a bridge for the plugin frontend to communicate with its own worker backend and with host APIs.
How Plugin UI Publishing Works In Practice
A plugin's dist/ui/ directory contains a built React bundle. The host serves this bundle and loads it into the page when the user navigates to a plugin surface (a plugin page, a detail tab, a dashboard widget, etc.).
The host provides, the plugin renders:
- The host defines extension slots — designated mount points in the UI where plugin components can appear (pages, tabs, widgets, sidebar entries, action bars).
- The plugin's UI bundle exports named components for each slot it wants to fill.
- The host mounts the plugin component into the slot, passing it a host bridge object.
- The plugin component uses the bridge to fetch data from its own worker (via
getData), call actions (viaperformAction), read host context (current company, project, entity), and use shared host UI primitives (design tokens, common components).
Concrete example: a Linear plugin ships a dashboard widget.
The plugin's UI bundle exports:
// dist/ui/index.tsx
import { usePluginData, usePluginAction, MetricCard, StatusBadge } from "@paperclipai/plugin-sdk/ui";
export function DashboardWidget({ context }: PluginWidgetProps) {
const { data, loading } = usePluginData("sync-health", { companyId: context.companyId });
const resync = usePluginAction("resync");
if (loading) return <Spinner />;
return (
<div>
<MetricCard label="Synced Issues" value={data.syncedCount} trend={data.trend} />
{data.mappings.map(m => (
<StatusBadge key={m.id} label={m.label} status={m.status} />
))}
<button onClick={() => resync({ companyId: context.companyId })}>Resync Now</button>
</div>
);
}
What happens at runtime:
- User opens the dashboard. The host sees that the Linear plugin registered a
DashboardWidgetexport. - The host mounts the plugin's
DashboardWidgetcomponent into the dashboard widget slot, passingcontext(current company, user, etc.) and the bridge. usePluginData("sync-health", ...)calls through the bridge → host → plugin worker'sgetDataRPC → returns JSON → the plugin component renders it however it wants.- When the user clicks "Resync Now",
usePluginAction("resync")calls through the bridge → host → plugin worker'sperformActionRPC.
What the host controls:
- The host decides where plugin components appear (which slots exist and when they mount).
- The host provides the bridge — plugin UI cannot make arbitrary network requests or access host internals directly.
- The host enforces capability gates — if a plugin's worker does not have a capability, the bridge rejects the call even if the UI requests it.
- The host provides design tokens and shared components via
@paperclipai/plugin-sdk/uiso plugins can match the host's visual language without being forced to.
What the plugin controls:
- The plugin decides how to render its data — it owns its React components, layout, interactions, and state management.
- The plugin decides what data to fetch and what actions to expose.
- The plugin can use any React patterns (hooks, context, third-party component libraries) inside its bundle.
19.0.1 Plugin UI SDK (@paperclipai/plugin-sdk/ui)
The SDK includes a ui subpath export that plugin frontends import. This subpath provides:
- Bridge hooks:
usePluginData(key, params),usePluginAction(key),useHostContext() - Design tokens: colors, spacing, typography, shadows matching the host theme
- Shared components:
MetricCard,StatusBadge,DataTable,LogView,ActionBar,Spinner, etc. - Type definitions:
PluginPageProps,PluginWidgetProps,PluginDetailTabProps
Plugins are encouraged but not required to use the shared components. A plugin may render entirely custom UI as long as it communicates through the bridge.
19.0.2 Bundle Isolation
Plugin UI bundles are loaded as standard ES modules, not iframed. This gives plugins full rendering performance and access to the host's design tokens.
Isolation rules:
- Plugin bundles must not import from host internals. They may only import from
@paperclipai/plugin-sdk/uiand their own dependencies. - Plugin bundles must not access
window.fetchorXMLHttpRequestdirectly for host API calls. All host communication goes through the bridge. - The host may enforce Content Security Policy rules that restrict plugin network access to the bridge endpoint only.
- Plugin bundles must be statically analyzable — no dynamic
import()of URLs outside the plugin's own bundle.
If stronger isolation is needed later, the host can move to iframe-based mounting for untrusted plugins without changing the plugin's source code (the bridge API stays the same).
19.0.3 Bundle Serving
Plugin UI bundles must be pre-built ESM. The host does not compile or transform plugin UI code at runtime.
The host serves the plugin's dist/ui/ directory as static assets under a namespaced path:
/_plugins/:pluginId/ui/*
When the host renders an extension slot, it dynamically imports the plugin's UI entry module from this path, resolves the named export declared in ui.slots[].exportName, and mounts it into the slot.
In development, the host may support a devUiUrl override in plugin config that points to a local dev server (e.g. Vite) so plugin authors can use hot-reload during development without rebuilding.
19.1 Global Operator Routes
/settings/plugins/settings/plugins/:pluginId
These routes are instance-level.
19.2 Company-Context Routes
/:companyPrefix/plugins/:pluginId
These routes exist because the board UI is organized around companies even though plugin installation is global.
19.3 Detail Tabs
Plugins may add tabs to:
- project detail
- issue detail
- agent detail
- goal detail
- run detail
Recommended route pattern:
/:companyPrefix/<entity>/:id?tab=<plugin-tab-id>
19.4 Dashboard Widgets
Plugins may add cards or sections to the dashboard.
19.5 Sidebar Entries
Plugins may add sidebar links to:
- global plugin settings
- company-context plugin pages
19.6 Shared Components In @paperclipai/plugin-sdk/ui
The host SDK ships shared components that plugins can import to quickly build UIs that match the host's look and feel. These are convenience building blocks, not a requirement.
| Component | What it renders | Typical use |
|---|---|---|
MetricCard |
Single number with label, optional trend/sparkline | KPIs, counts, rates |
StatusBadge |
Inline status indicator (ok/warning/error/info) | Sync health, connection status |
DataTable |
Rows and columns with optional sorting and pagination | Issue lists, job history, process lists |
TimeseriesChart |
Line or bar chart with timestamped data points | Revenue trends, sync volume, error rates |
MarkdownBlock |
Rendered markdown text | Descriptions, help text, notes |
KeyValueList |
Label/value pairs in a definition-list layout | Entity metadata, config summary |
ActionBar |
Row of buttons wired to usePluginAction |
Resync, create branch, restart process |
LogView |
Scrollable log output with timestamps | Webhook deliveries, job output, process logs |
JsonTree |
Collapsible JSON tree for debugging | Raw API responses, plugin state inspection |
Spinner |
Loading indicator | Data fetch states |
Plugins may also use entirely custom components. The shared components exist to reduce boilerplate and keep visual consistency, not to limit what plugins can render.
19.7 Error Propagation Through The Bridge
The bridge hooks must return structured errors so plugin UI can handle failures gracefully.
usePluginData returns:
{
data: T | null;
loading: boolean;
error: PluginBridgeError | null;
}
usePluginAction returns an async function that either resolves with the result or throws a PluginBridgeError.
PluginBridgeError shape:
interface PluginBridgeError {
code: "WORKER_UNAVAILABLE" | "CAPABILITY_DENIED" | "WORKER_ERROR" | "TIMEOUT" | "UNKNOWN";
message: string;
/** Original error details from the worker, if available */
details?: unknown;
}
Error codes:
WORKER_UNAVAILABLE— the plugin worker is not running (crashed, shutting down, not yet started)CAPABILITY_DENIED— the plugin does not have the required capability for this operationWORKER_ERROR— the worker returned an error from itsgetDataorperformActionhandlerTIMEOUT— the worker did not respond within the configured timeoutUNKNOWN— unexpected bridge-level failure
The @paperclipai/plugin-sdk/ui subpath should also export an ErrorBoundary component that plugin authors can use to catch rendering errors without crashing the host page.
19.8 Plugin Settings UI
Each plugin that declares an instanceConfigSchema in its manifest gets an auto-generated settings form at /settings/plugins/:pluginId. The host renders the form from the JSON Schema.
The auto-generated form supports:
- text inputs, number inputs, toggles, select dropdowns derived from schema types and enums
- nested objects rendered as fieldsets
- arrays rendered as repeatable field groups with add/remove controls
- secret ref fields: any schema property annotated with
"format": "secret-ref"renders as a secret picker that resolves through the Paperclip secret provider system rather than a plain text input - validation messages derived from schema constraints (
required,minLength,pattern,minimum, etc.) - a "Test Connection" action if the plugin declares a
validateConfigRPC method — the host calls it and displays the result inline
For plugins that need richer settings UX beyond what JSON Schema can express, the plugin may declare a settingsPage slot in ui.slots. When present, the host renders the plugin's own React component instead of the auto-generated form. The plugin component communicates with its worker through the standard bridge to read and write config.
Both approaches coexist: a plugin can use the auto-generated form for simple config and add a custom settings page slot for advanced configuration or operational dashboards.
20. Local Tooling
Plugins that need filesystem, git, terminal, or process operations implement those directly. The host does not wrap or proxy these operations.
The host provides workspace metadata through ctx.projects (list workspaces, get primary workspace, resolve workspace from issue or agent/run). Plugins use this metadata to resolve local paths and then operate on the filesystem, spawn processes, shell out to git, or open PTY sessions using standard Node APIs or any libraries they choose.
This keeps the host lean — it does not need to maintain a parallel API surface for every OS-level operation a plugin might need. Plugins own their own logic for file browsing, git workflows, terminal sessions, and process management.
21. Persistence And Postgres
21.1 Database Principles
- Core Paperclip data stays in first-party tables.
- Most plugin-owned data starts in generic extension tables.
- Plugin data should scope to existing Paperclip objects before new tables are introduced.
- Arbitrary third-party schema migrations are out of scope for the first plugin system.
21.2 Core Table Reuse
If data becomes part of the actual Paperclip product model, it should become a first-party table.
Examples:
project_workspacesis already first-party- if Paperclip later decides git state is core product data, it should become a first-party table too
21.3 Required Tables
plugins
iduuid pkplugin_keytext unique not nullpackage_nametext not nullversiontext not nullapi_versionint not nullcategoriestext[] not nullmanifest_jsonjsonb not nullstatusenum:installed | ready | error | upgrade_pendinginstall_orderint nullinstalled_attimestamptz not nullupdated_attimestamptz not nulllast_errortext null
Indexes:
- unique
plugin_key status
plugin_config
iduuid pkplugin_iduuid fkplugins.idunique not nullconfig_jsonjsonb not nullcreated_attimestamptz not nullupdated_attimestamptz not nulllast_errortext null
plugin_state
iduuid pkplugin_iduuid fkplugins.idnot nullscope_kindenum:instance | company | project | project_workspace | agent | issue | goal | runscope_iduuid/text nullnamespacetext not nullstate_keytext not nullvalue_jsonjsonb not nullupdated_attimestamptz not null
Constraints:
- unique
(plugin_id, scope_kind, scope_id, namespace, state_key)
Examples:
- Linear external IDs keyed by
issue - GitHub sync cursors keyed by
project - file browser preferences keyed by
project_workspace - git branch metadata keyed by
project_workspace - process metadata keyed by
project_workspaceorrun
plugin_jobs
iduuid pkplugin_iduuid fkplugins.idnot nullscope_kindenum nullablescope_iduuid/text nulljob_keytext not nullscheduletext nullstatusenum:idle | queued | running | errornext_run_attimestamptz nulllast_started_attimestamptz nulllast_finished_attimestamptz nulllast_succeeded_attimestamptz nulllast_errortext null
Constraints:
- unique
(plugin_id, scope_kind, scope_id, job_key)
plugin_job_runs
iduuid pkplugin_job_iduuid fkplugin_jobs.idnot nullplugin_iduuid fkplugins.idnot nullstatusenum:queued | running | succeeded | failed | cancelledtriggerenum:schedule | manual | retrystarted_attimestamptz nullfinished_attimestamptz nullerrortext nulldetails_jsonjsonb null
Indexes:
(plugin_id, started_at desc)(plugin_job_id, started_at desc)
plugin_webhook_deliveries
iduuid pkplugin_iduuid fkplugins.idnot nullscope_kindenum nullablescope_iduuid/text nullendpoint_keytext not nullstatusenum:received | processed | failed | ignoredrequest_idtext nullheaders_jsonjsonb nullbody_jsonjsonb nullreceived_attimestamptz not nullhandled_attimestamptz nullresponse_codeint nullerrortext null
Indexes:
(plugin_id, received_at desc)(plugin_id, endpoint_key, received_at desc)
plugin_entities (optional but recommended)
iduuid pkplugin_iduuid fkplugins.idnot nullentity_typetext not nullscope_kindenum not nullscope_iduuid/text nullexternal_idtext nulltitletext nullstatustext nulldata_jsonjsonb not nullcreated_attimestamptz not nullupdated_attimestamptz not null
Indexes:
(plugin_id, entity_type, external_id)unique whenexternal_idis not null(plugin_id, scope_kind, scope_id, entity_type)
Use cases:
- imported Linear issues
- imported GitHub issues
- plugin-owned process records
- plugin-owned external metric bindings
21.4 Activity Log Changes
The activity log should extend actor_type to include plugin.
New actor enum:
agentusersystemplugin
Plugin-originated mutations should write:
actor_type = pluginactor_id = <plugin-id>
21.5 Plugin Migrations
The first plugin system does not allow arbitrary third-party migrations.
Later, if custom tables become necessary, the system may add a trusted-module-only migration path.
22. Secrets
Plugin config must never persist raw secret values.
Rules:
- Plugin config stores secret refs only.
- Secret refs resolve through the existing Paperclip secret provider system.
- Plugin workers receive resolved secrets only at execution time.
- Secret values must never be written to:
- plugin config JSON
- activity logs
- webhook delivery rows
- error messages
23. Auditing
All plugin-originated mutating actions must be auditable.
Minimum requirements:
- activity log entry for every mutation
- job run history
- webhook delivery history
- plugin health page
- install/upgrade history in
plugins
24. Operator UX
24.1 Global Settings
Global plugin settings page must show:
- installed plugins
- versions
- status
- requested capabilities
- current errors
- install/upgrade/remove actions
24.2 Plugin Settings Page
Each plugin may expose:
- config form derived from
instanceConfigSchema - health details
- recent job history
- recent webhook history
- capability list
Route:
/settings/plugins/:pluginId
24.3 Company-Context Plugin Page
Each plugin may expose a company-context main page:
/:companyPrefix/plugins/:pluginId
This page is where board users do most day-to-day work.
25. Uninstall And Data Lifecycle
When a plugin is uninstalled, the host must handle plugin-owned data explicitly.
25.1 Uninstall Process
- The host sends
shutdown()to the worker and follows the graceful shutdown policy. - The host marks the plugin status
uninstalledin thepluginstable (soft delete). - Plugin-owned data (
plugin_state,plugin_entities,plugin_jobs,plugin_job_runs,plugin_webhook_deliveries,plugin_config) is retained for a configurable grace period (default: 30 days). - During the grace period, the operator can reinstall the same plugin and recover its state.
- After the grace period, the host purges all plugin-owned data for the uninstalled plugin.
- The operator may force-purge immediately via CLI:
pnpm paperclipai plugin purge <plugin-id>.
25.2 Upgrade Data Considerations
Plugin upgrades do not automatically migrate plugin state. If a plugin's value_json shape changes between versions:
- The plugin worker is responsible for migrating its own state on first access after upgrade.
- The host does not run plugin-defined schema migrations.
- Plugins should version their state keys or use a schema version field inside
value_jsonto detect and handle format changes.
25.3 Upgrade Lifecycle
When upgrading a plugin:
- The host sends
shutdown()to the old worker. - The host waits for the old worker to drain in-flight work (respecting the shutdown deadline).
- Any in-flight jobs that do not complete within the deadline are marked
cancelled. - The host installs the new version and starts the new worker.
- If the new version adds capabilities, the plugin enters
upgrade_pendingand the operator must approve before the new worker becomesready.
25.4 Hot Plugin Lifecycle
Plugin install, uninstall, upgrade, and config changes must take effect without restarting the Paperclip server. This is a normative requirement, not optional.
The architecture already supports this — plugins run as out-of-process workers with dynamic ESM imports, IPC bridges, and host-managed routing tables. This section makes the requirement explicit so implementations do not regress.
25.4.1 Hot Install
When a plugin is installed at runtime:
- The host resolves and validates the manifest without stopping existing services.
- The host spawns a new worker process for the plugin.
- The host registers the plugin's event subscriptions, job schedules, webhook endpoints, and agent tool declarations in the live routing tables.
- The host loads the plugin's UI bundle path into the extension slot registry so the frontend can discover it on the next navigation or via a live notification.
- The plugin enters
readystatus (orupgrade_pendingif capability approval is required).
No other plugin or host service is interrupted.
25.4.2 Hot Uninstall
When a plugin is uninstalled at runtime:
- The host sends
shutdown()and follows the graceful shutdown policy (Section 12.5). - The host removes the plugin's event subscriptions, job schedules, webhook endpoints, and agent tool declarations from the live routing tables.
- The host removes the plugin's UI bundle from the extension slot registry. Any currently mounted plugin UI components are unmounted and replaced with a placeholder or removed entirely.
- The host marks the plugin
uninstalledand starts the data retention grace period (Section 25.1).
No server restart is needed.
25.4.3 Hot Upgrade
When a plugin is upgraded at runtime:
- The host follows the upgrade lifecycle (Section 25.3) — shut down old worker, start new worker.
- If the new version changes event subscriptions, job schedules, webhook endpoints, or agent tools, the host atomically swaps the old registrations for the new ones.
- If the new version ships an updated UI bundle, the host invalidates any cached bundle assets and notifies the frontend to reload plugin UI components. Active users see the updated UI on next navigation or via a live refresh notification.
- If the manifest
apiVersionis unchanged and no new capabilities are added, the upgrade completes without operator interaction.
25.4.4 Hot Config Change
When an operator updates a plugin's instance config at runtime:
- The host writes the new config to
plugin_config. - The host sends a
configChangednotification to the running worker via IPC. - The worker receives the new config through
ctx.configand applies it without restarting. If the plugin needs to re-initialize connections (e.g. a new API token), it does so internally. - If the plugin does not handle
configChanged, the host restarts the worker process with the new config (graceful shutdown then restart).
25.4.5 Frontend Cache Invalidation
The host must version plugin UI bundle URLs (e.g. /_plugins/:pluginId/ui/:version/* or content-hash-based paths) so that browser caches do not serve stale bundles after upgrade or reinstall.
The host should emit a plugin.ui.updated event that the frontend listens for to trigger re-import of updated plugin modules without a full page reload.
25.4.6 Worker Process Management
The host's plugin process manager must support:
- starting a worker for a newly installed plugin without affecting other workers
- stopping a worker for an uninstalled plugin without affecting other workers
- replacing a worker during upgrade (stop old, start new) atomically from the routing table's perspective
- restarting a worker after crash without operator intervention (with backoff)
Each worker process is independent. There is no shared process pool or batch restart mechanism.
26. Plugin Observability
26.1 Logging
Plugin workers use ctx.logger to emit structured logs. The host captures these logs and stores them in a queryable format.
Log storage rules:
- Plugin logs are stored in a
plugin_logstable or appended to a log file under the plugin's data directory. - Each log entry includes: plugin ID, timestamp, level, message, and optional structured metadata.
- Logs are queryable from the plugin settings page in the UI.
- Logs have a configurable retention period (default: 7 days).
- The host captures
stdoutandstderrfrom the worker process as fallback logs even if the worker does not usectx.logger.
26.2 Health Dashboard
The plugin settings page must show:
- current worker status (running, error, stopped)
- uptime since last restart
- recent log entries
- job run history with success/failure rates
- webhook delivery history with success/failure rates
- last health check result and diagnostics
- resource usage if available (memory, CPU)
26.3 Alerting
The host should emit internal events when plugin health degrades. These use the plugin.* namespace (not core domain events) and do not appear in the core activity log:
plugin.health.degraded— worker reporting errors or failing health checksplugin.health.recovered— worker recovered from error stateplugin.worker.crashed— worker process exited unexpectedlyplugin.worker.restarted— worker restarted after crash
These events can be consumed by other plugins (e.g. a notification plugin) or surfaced in the dashboard.
27. Plugin Development And Testing
27.1 @paperclipai/plugin-test-harness
The host should publish a test harness package that plugin authors use for local development and testing.
The test harness provides:
- a mock host that implements the full SDK interface (
ctx.config,ctx.events,ctx.state, etc.) - ability to send synthetic events and verify handler responses
- ability to trigger job runs and verify side effects
- ability to simulate
getDataandperformActioncalls as if coming from the UI bridge - ability to simulate
executeToolcalls as if coming from an agent run - in-memory state and entity stores for assertions
- configurable capability sets for testing capability denial paths
Example usage:
import { createTestHarness } from "@paperclipai/plugin-test-harness";
import manifest from "../dist/manifest.js";
import { register } from "../dist/worker.js";
const harness = createTestHarness({ manifest, capabilities: manifest.capabilities });
await register(harness.ctx);
// Simulate an event
await harness.emit("issue.created", { issueId: "iss-1", projectId: "proj-1" });
// Verify state was written
const state = await harness.state.get({ pluginId: manifest.id, scopeKind: "issue", scopeId: "iss-1", namespace: "sync", stateKey: "external-id" });
expect(state).toBeDefined();
// Simulate a UI data request
const data = await harness.getData("sync-health", { companyId: "comp-1" });
expect(data.syncedCount).toBeGreaterThan(0);
27.2 Local Plugin Development
For developing a plugin against a running Paperclip instance:
- The operator installs the plugin from a local path:
pnpm paperclipai plugin install ./path/to/plugin - The host watches the plugin directory for changes and restarts the worker on rebuild.
devUiUrlin plugin config can point to a local Vite dev server for UI hot-reload.- The plugin settings page shows real-time logs from the worker for debugging.
27.3 Plugin Starter Template
The host should publish a starter template (create-paperclip-plugin) that scaffolds:
package.jsonwith correctpaperclipPluginkeys- manifest with placeholder values
- worker entry with SDK type imports and example event handler
- UI entry with example
DashboardWidgetusing bridge hooks - test file using the test harness
- build configuration (esbuild or similar) for both worker and UI bundles
.gitignoreandtsconfig.json
28. Example Mappings
This spec directly supports the following plugin types:
@paperclip/plugin-workspace-files@paperclip/plugin-terminal@paperclip/plugin-git@paperclip/plugin-linear@paperclip/plugin-github-issues@paperclip/plugin-grafana@paperclip/plugin-runtime-processes@paperclip/plugin-stripe
29. Compatibility And Versioning
29.1 API Version Rules
- Host supports one or more explicit plugin API versions.
- Plugin manifest declares exactly one
apiVersion. - Host rejects unsupported versions at install time.
- Plugin upgrades are explicit operator actions.
- Capability expansion requires explicit operator approval.
29.2 SDK Versioning
The host publishes a single SDK package for plugin authors:
@paperclipai/plugin-sdk— the complete plugin SDK
The package uses subpath exports to separate worker and UI concerns:
@paperclipai/plugin-sdk— worker-side SDK (context, events, state, tools, logger,definePlugin,z)@paperclipai/plugin-sdk/ui— frontend SDK (bridge hooks, shared components, design tokens)
A single package simplifies dependency management for plugin authors — one dependency, one version, one changelog. The subpath exports keep bundle separation clean: worker code imports from the root, UI code imports from /ui. Build tools tree-shake accordingly so the worker bundle does not include React components and the UI bundle does not include worker-only code.
Versioning rules:
- Semver: The SDK follows strict semantic versioning. Major version bumps indicate breaking changes to either the worker or UI surface; minor versions add new features backwards-compatibly; patch versions are bug fixes only.
- Tied to API version: Each major SDK version corresponds to exactly one plugin
apiVersion. When@paperclipai/plugin-sdk@2.xships, it targetsapiVersion: 2. Plugins built with SDK 1.x continue to declareapiVersion: 1. - Host multi-version support: The host must support at least the current and one previous
apiVersionsimultaneously. This means plugins built against the previous SDK major version continue to work without modification. The host maintains separate IPC protocol handlers for each supported API version. - Minimum SDK version in manifest: Plugins declare
sdkVersionin the manifest as a semver range (e.g.">=1.4.0 <2.0.0"). The host validates this at install time and warns if the plugin's declared range is outside the host's supported SDK versions. - Deprecation timeline: When a new
apiVersionships, the previous version enters a deprecation period of at least 6 months. During this period:- The host continues to load plugins targeting the deprecated version.
- The host logs a deprecation warning at plugin startup.
- The plugin settings page shows a banner indicating the plugin should be upgraded.
- After the deprecation period ends, the host may drop support for the old version in a future release.
- SDK changelog and migration guides: Each major SDK release must include a migration guide documenting every breaking change, the new API surface, and a step-by-step upgrade path for plugin authors.
- UI surface stability: Breaking changes to shared UI components (removing a component, changing required props) or design tokens require a major version bump just like worker API changes. The single-package model means both surfaces are versioned together, avoiding drift between worker and UI compatibility.
29.3 Version Compatibility Matrix
The host should publish a compatibility matrix:
| Host Version | Supported API Versions | SDK Range |
|---|---|---|
| 1.0 | 1 | 1.x |
| 2.0 | 1, 2 | 1.x, 2.x |
| 3.0 | 2, 3 | 2.x, 3.x |
This matrix is published in the host docs and queryable via GET /api/plugins/compatibility.
29.4 Plugin Author Workflow
When a new SDK version is released:
- Plugin author updates
@paperclipai/plugin-sdkdependency. - Plugin author follows the migration guide to update code.
- Plugin author updates
apiVersionandsdkVersionin the manifest. - Plugin author publishes a new plugin version.
- Operators upgrade the plugin on their instances. The old version continues to work until explicitly upgraded.
30. Recommended Delivery Order
Phase 1
- plugin manifest
- install/list/remove/upgrade CLI
- global settings UI
- plugin process manager
- capability enforcement
plugins,plugin_config,plugin_state,plugin_jobs,plugin_job_runs,plugin_webhook_deliveries- event bus
- jobs
- webhooks
- settings page
- plugin UI bundle loading, host bridge, and
@paperclipai/plugin-sdk/ui - extension slot mounting for pages, tabs, widgets, sidebar entries
- bridge error propagation (
PluginBridgeError) - auto-generated settings form from
instanceConfigSchema - plugin-contributed agent tools
- plugin-to-plugin events (
plugin.<pluginId>.*namespace) - event filtering
- graceful shutdown with configurable deadlines
- plugin logging and health dashboard
@paperclipai/plugin-test-harnesscreate-paperclip-pluginstarter template- uninstall with data retention grace period
- hot plugin lifecycle (install, uninstall, upgrade, config change without server restart)
- SDK versioning with multi-version host support and deprecation policy
This phase is enough for:
- Linear
- GitHub Issues
- Grafana
- Stripe
- file browser
- terminal
- git workflow
- process/server tracking
Workspace plugins (file browser, terminal, git, process tracking) do not require additional host APIs — they resolve workspace paths through ctx.projects and handle filesystem, git, PTY, and process operations directly.
Phase 2
- optional
plugin_entities - richer action systems
- trusted-module migration path if truly needed
- iframe-based isolation for untrusted plugin UI bundles
- plugin ecosystem/distribution work
31. Final Design Decision
Paperclip should not implement a generic in-process hook bag modeled directly after local coding tools.
Paperclip should implement:
- trusted platform modules for low-level host integration
- globally installed out-of-process plugins for additive instance-wide capabilities
- plugin-contributed agent tools (namespaced, capability-gated)
- plugin-shipped UI bundles rendered in host extension slots via a typed bridge with structured error propagation
- auto-generated settings UI from config schema, with custom settings pages as an option
- plugin-to-plugin events for cross-plugin coordination
- server-side event filtering for efficient event routing
- plugins own their local tooling logic (filesystem, git, terminal, processes) directly
- generic extension tables for most plugin state
- graceful shutdown, uninstall data lifecycle, and plugin observability
- hot plugin lifecycle — install, uninstall, upgrade, and config changes without server restart
- SDK versioning with multi-version host support and a clear deprecation policy
- test harness and starter template for low authoring friction
- strict preservation of core governance and audit rules
That is the complete target design for the Paperclip plugin system.