Spaces:
Paused
Paused
File size: 8,144 Bytes
b152fd5 | 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 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 | import type { PaperclipPluginManifestV1 } from "@paperclipai/plugin-sdk";
import {
DEFAULT_CONFIG,
EXPORT_NAMES,
JOB_KEYS,
PAGE_ROUTE,
PLUGIN_ID,
PLUGIN_VERSION,
SLOT_IDS,
TOOL_NAMES,
WEBHOOK_KEYS,
} from "./constants.js";
const manifest: PaperclipPluginManifestV1 = {
id: PLUGIN_ID,
apiVersion: 1,
version: PLUGIN_VERSION,
displayName: "Kitchen Sink (Example)",
description: "Reference plugin that demonstrates the current Paperclip plugin API surface, UI surfaces, bridge actions, events, jobs, webhooks, tools, local workspace access, and runtime diagnostics in one place.",
author: "Paperclip",
categories: ["ui", "automation", "workspace", "connector"],
capabilities: [
"companies.read",
"projects.read",
"project.workspaces.read",
"issues.read",
"issues.create",
"issues.update",
"issue.comments.read",
"issue.comments.create",
"agents.read",
"agents.pause",
"agents.resume",
"agents.invoke",
"agent.sessions.create",
"agent.sessions.list",
"agent.sessions.send",
"agent.sessions.close",
"goals.read",
"goals.create",
"goals.update",
"activity.log.write",
"metrics.write",
"telemetry.track",
"plugin.state.read",
"plugin.state.write",
"events.subscribe",
"events.emit",
"jobs.schedule",
"webhooks.receive",
"http.outbound",
"secrets.read-ref",
"agent.tools.register",
"instance.settings.register",
"ui.sidebar.register",
"ui.page.register",
"ui.detailTab.register",
"ui.dashboardWidget.register",
"ui.commentAnnotation.register",
"ui.action.register",
],
entrypoints: {
worker: "./dist/worker.js",
ui: "./dist/ui",
},
instanceConfigSchema: {
type: "object",
properties: {
showSidebarEntry: {
type: "boolean",
title: "Show Sidebar Entry",
default: DEFAULT_CONFIG.showSidebarEntry,
},
showSidebarPanel: {
type: "boolean",
title: "Show Sidebar Panel",
default: DEFAULT_CONFIG.showSidebarPanel,
},
showProjectSidebarItem: {
type: "boolean",
title: "Show Project Sidebar Item",
default: DEFAULT_CONFIG.showProjectSidebarItem,
},
showCommentAnnotation: {
type: "boolean",
title: "Show Comment Annotation",
default: DEFAULT_CONFIG.showCommentAnnotation,
},
showCommentContextMenuItem: {
type: "boolean",
title: "Show Comment Action",
default: DEFAULT_CONFIG.showCommentContextMenuItem,
},
enableWorkspaceDemos: {
type: "boolean",
title: "Enable Workspace Demos",
default: DEFAULT_CONFIG.enableWorkspaceDemos,
},
enableProcessDemos: {
type: "boolean",
title: "Enable Process Demos",
default: DEFAULT_CONFIG.enableProcessDemos,
description: "Allows curated local child-process demos in project workspaces.",
},
secretRefExample: {
type: "string",
title: "Secret Reference Example",
default: DEFAULT_CONFIG.secretRefExample,
},
httpDemoUrl: {
type: "string",
title: "HTTP Demo URL",
default: DEFAULT_CONFIG.httpDemoUrl,
},
allowedCommands: {
type: "array",
title: "Allowed Process Commands",
items: {
type: "string",
enum: DEFAULT_CONFIG.allowedCommands,
},
default: DEFAULT_CONFIG.allowedCommands,
},
workspaceScratchFile: {
type: "string",
title: "Workspace Scratch File",
default: DEFAULT_CONFIG.workspaceScratchFile,
},
},
},
jobs: [
{
jobKey: JOB_KEYS.heartbeat,
displayName: "Demo Heartbeat",
description: "Periodic demo job that records plugin runtime activity.",
schedule: "*/15 * * * *",
},
],
webhooks: [
{
endpointKey: WEBHOOK_KEYS.demo,
displayName: "Demo Ingest",
description: "Accepts arbitrary webhook payloads and records the latest delivery in plugin state.",
},
],
tools: [
{
name: TOOL_NAMES.echo,
displayName: "Kitchen Sink Echo",
description: "Returns the provided message and the current run context.",
parametersSchema: {
type: "object",
properties: {
message: { type: "string" },
},
required: ["message"],
},
},
{
name: TOOL_NAMES.companySummary,
displayName: "Kitchen Sink Company Summary",
description: "Summarizes the current company using the Paperclip domain APIs.",
parametersSchema: {
type: "object",
properties: {},
},
},
{
name: TOOL_NAMES.createIssue,
displayName: "Kitchen Sink Create Issue",
description: "Creates an issue in the current project from an agent tool call.",
parametersSchema: {
type: "object",
properties: {
title: { type: "string" },
description: { type: "string" },
},
required: ["title"],
},
},
],
ui: {
slots: [
{
type: "page",
id: SLOT_IDS.page,
displayName: "Kitchen Sink",
exportName: EXPORT_NAMES.page,
routePath: PAGE_ROUTE,
},
{
type: "settingsPage",
id: SLOT_IDS.settingsPage,
displayName: "Kitchen Sink Settings",
exportName: EXPORT_NAMES.settingsPage,
},
{
type: "dashboardWidget",
id: SLOT_IDS.dashboardWidget,
displayName: "Kitchen Sink",
exportName: EXPORT_NAMES.dashboardWidget,
},
{
type: "sidebar",
id: SLOT_IDS.sidebar,
displayName: "Kitchen Sink",
exportName: EXPORT_NAMES.sidebar,
},
{
type: "sidebarPanel",
id: SLOT_IDS.sidebarPanel,
displayName: "Kitchen Sink Panel",
exportName: EXPORT_NAMES.sidebarPanel,
},
{
type: "projectSidebarItem",
id: SLOT_IDS.projectSidebarItem,
displayName: "Kitchen Sink",
exportName: EXPORT_NAMES.projectSidebarItem,
entityTypes: ["project"],
},
{
type: "detailTab",
id: SLOT_IDS.projectTab,
displayName: "Kitchen Sink",
exportName: EXPORT_NAMES.projectTab,
entityTypes: ["project"],
},
{
type: "detailTab",
id: SLOT_IDS.issueTab,
displayName: "Kitchen Sink",
exportName: EXPORT_NAMES.issueTab,
entityTypes: ["issue"],
},
{
type: "taskDetailView",
id: SLOT_IDS.taskDetailView,
displayName: "Kitchen Sink Task View",
exportName: EXPORT_NAMES.taskDetailView,
entityTypes: ["issue"],
},
{
type: "toolbarButton",
id: SLOT_IDS.toolbarButton,
displayName: "Kitchen Sink Action",
exportName: EXPORT_NAMES.toolbarButton,
entityTypes: ["project", "issue"],
},
{
type: "contextMenuItem",
id: SLOT_IDS.contextMenuItem,
displayName: "Kitchen Sink Context",
exportName: EXPORT_NAMES.contextMenuItem,
entityTypes: ["project", "issue"],
},
{
type: "commentAnnotation",
id: SLOT_IDS.commentAnnotation,
displayName: "Kitchen Sink Comment Annotation",
exportName: EXPORT_NAMES.commentAnnotation,
entityTypes: ["comment"],
},
{
type: "commentContextMenuItem",
id: SLOT_IDS.commentContextMenuItem,
displayName: "Kitchen Sink Comment Action",
exportName: EXPORT_NAMES.commentContextMenuItem,
entityTypes: ["comment"],
},
],
launchers: [
{
id: "kitchen-sink-launcher",
displayName: "Kitchen Sink Modal",
placementZone: "toolbarButton",
entityTypes: ["project", "issue"],
action: {
type: "openModal",
target: EXPORT_NAMES.launcherModal,
},
render: {
environment: "hostOverlay",
bounds: "wide",
},
},
],
},
};
export default manifest;
|