@marsbdigital/paperclip-content-sprint-plugin 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,47 @@
1
+ # Content Sprint AI (Paperclip plugin)
2
+
3
+ npm package **`@marsbdigital/paperclip-content-sprint-plugin`** — generates five structured social posts from product context (two authority, two engagement, one conversion) for **LinkedIn** or **X (Twitter)**.
4
+
5
+ ## Paperclip manifest id
6
+
7
+ The host requires plugin ids to match `^[a-z0-9][a-z0-9._-]*$`. This plugin’s manifest id is **`marsbdigital.paperclip-content-sprint-plugin`** (see `plugin.json`). The scoped npm name stays **`@marsbdigital/paperclip-content-sprint-plugin`**.
8
+
9
+ ## Layout
10
+
11
+ | Path | Role |
12
+ |------|------|
13
+ | `plugin.json` | Manifest snapshot (also bundled into `dist/manifest.js`) |
14
+ | `src/index.ts` | Worker: `definePlugin`, tool `generate_content_batch`, action `generate_content_sprint`, job `run_content_sprint` |
15
+ | `src/manifest.ts` | Default export consumed by the build |
16
+ | `src/server/tools/generateContentBatch.ts` | Zod validation + stub post generator (swap for an LLM later) |
17
+ | `src/server/jobs/runContentSprint.ts` | Job handler with placeholder input |
18
+ | `src/ui/ToolbarButton.tsx` | `globalToolbarButton` slot — **⚡ Content Sprint** |
19
+ | `src/ui/ContentSprintPanel.tsx` | `dashboardWidget` — form, generate, loading, output |
20
+
21
+ ## Scripts
22
+
23
+ ```bash
24
+ npm install
25
+ npm run build # dist/index.js (worker), dist/manifest.js, dist/ui/
26
+ npm run typecheck
27
+ ```
28
+
29
+ ## Host integration
30
+
31
+ `package.json` includes:
32
+
33
+ ```json
34
+ "paperclipPlugin": {
35
+ "manifest": "./dist/manifest.js",
36
+ "worker": "./dist/index.js"
37
+ }
38
+ ```
39
+
40
+ Install per [Paperclip plugin docs](https://github.com/paperclipai/paperclip); UI entry directory is `dist/ui` as declared in the manifest.
41
+
42
+ ## Capabilities
43
+
44
+ - `agent.tools.register` — `generate_content_batch`
45
+ - `jobs.schedule` — `run_content_sprint` (weekly cron in manifest)
46
+ - `ui.action.register` — toolbar button
47
+ - `ui.dashboardWidget.register` — dashboard widget