@ericsanchezok/synergy-plugin 2.4.0 → 2.4.2
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 +4 -4
- package/dist/index.d.ts +14 -0
- package/dist/manifest.d.ts +9 -0
- package/dist/manifest.js +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
`@ericsanchezok/synergy-plugin` is the authoring SDK for Synergy plugins.
|
|
4
4
|
|
|
5
|
-
Plugins extend the Synergy server runtime and can also contribute Web UI surfaces through `plugin.json`.
|
|
5
|
+
Plugins extend the Synergy server runtime and can also contribute Web UI surfaces through `plugin.json`. A plugin module exports an object descriptor with a canonical `id` and an `init()` method. The descriptor id, `plugin.json.name`, registry id, lockfile key, and approval key must all be the same canonical plugin id.
|
|
6
6
|
|
|
7
7
|
Plugin authors should use `@ericsanchezok/synergy-plugin-kit` and this SDK from a standalone plugin project. Cloning the Synergy source repository is only needed when changing or debugging the plugin platform itself.
|
|
8
8
|
|
|
@@ -59,13 +59,13 @@ export const plugin: PluginDescriptor = {
|
|
|
59
59
|
export default plugin
|
|
60
60
|
```
|
|
61
61
|
|
|
62
|
-
|
|
62
|
+
`plugin.json.name` must match `plugin.id`; Synergy fails validation or loading if they differ.
|
|
63
63
|
|
|
64
64
|
## Tool Results And Attachments
|
|
65
65
|
|
|
66
66
|
Tools can return user-facing files through `attachments`. Use the generated SDK `asset.upload()` route or the public `/asset` endpoint to upload binary data, then return the resulting `asset://...` URL. Do not import Synergy internal asset modules from a plugin.
|
|
67
67
|
|
|
68
|
-
For visual tools whose output
|
|
68
|
+
For visual tools whose output belongs in the main answer area, set `metadata.display.presentation` to `artifact-only` and list the attachment ids to promote:
|
|
69
69
|
|
|
70
70
|
```ts
|
|
71
71
|
return {
|
|
@@ -121,7 +121,7 @@ tool({
|
|
|
121
121
|
})
|
|
122
122
|
```
|
|
123
123
|
|
|
124
|
-
Use `visibility: "media"` for tools whose running and completed success states
|
|
124
|
+
Use `visibility: "media"` for tools whose running and completed success states belong on the media surface. Error states still fall back to normal tool cards.
|
|
125
125
|
|
|
126
126
|
## Internal Tools And Delegated Tasks
|
|
127
127
|
|
package/dist/index.d.ts
CHANGED
|
@@ -82,6 +82,8 @@ export interface PluginAgent {
|
|
|
82
82
|
mode?: "subagent" | "primary" | "all";
|
|
83
83
|
/** Model override in "providerID/modelID" format */
|
|
84
84
|
model?: string;
|
|
85
|
+
/** Model role to resolve when model is not set */
|
|
86
|
+
modelRole?: "vision" | "nano" | "mini" | "mid" | "thinking" | "long" | "creative";
|
|
85
87
|
temperature?: number;
|
|
86
88
|
topP?: number;
|
|
87
89
|
/** Maximum agentic iterations */
|
|
@@ -226,6 +228,18 @@ export type ProviderProfileHook = {
|
|
|
226
228
|
aliases?: string[];
|
|
227
229
|
description?: string;
|
|
228
230
|
signupUrl?: string;
|
|
231
|
+
recommendation?: {
|
|
232
|
+
level: "featured" | "recommended" | "standard";
|
|
233
|
+
rank?: number;
|
|
234
|
+
headline?: string;
|
|
235
|
+
reason?: string;
|
|
236
|
+
cta?: {
|
|
237
|
+
kind: "external";
|
|
238
|
+
label: string;
|
|
239
|
+
url: string;
|
|
240
|
+
};
|
|
241
|
+
defaultModel?: string;
|
|
242
|
+
};
|
|
229
243
|
env?: string[];
|
|
230
244
|
baseURL?: string;
|
|
231
245
|
modelsURL?: string;
|
package/dist/manifest.d.ts
CHANGED
|
@@ -204,6 +204,15 @@ export declare const PluginManifest: z.ZodObject<{
|
|
|
204
204
|
all: "all";
|
|
205
205
|
}>>;
|
|
206
206
|
model: z.ZodOptional<z.ZodString>;
|
|
207
|
+
modelRole: z.ZodOptional<z.ZodEnum<{
|
|
208
|
+
vision: "vision";
|
|
209
|
+
nano: "nano";
|
|
210
|
+
mini: "mini";
|
|
211
|
+
mid: "mid";
|
|
212
|
+
thinking: "thinking";
|
|
213
|
+
long: "long";
|
|
214
|
+
creative: "creative";
|
|
215
|
+
}>>;
|
|
207
216
|
hidden: z.ZodOptional<z.ZodBoolean>;
|
|
208
217
|
permission: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
|
|
209
218
|
}, z.core.$strip>>>>;
|
package/dist/manifest.js
CHANGED
|
@@ -306,6 +306,7 @@ export const PluginManifest = z
|
|
|
306
306
|
description: z.string(),
|
|
307
307
|
mode: z.enum(["subagent", "primary", "all"]).default("subagent"),
|
|
308
308
|
model: z.string().optional(),
|
|
309
|
+
modelRole: z.enum(["vision", "nano", "mini", "mid", "thinking", "long", "creative"]).optional(),
|
|
309
310
|
hidden: z.boolean().optional(),
|
|
310
311
|
permission: z.record(z.string(), z.any()).optional(),
|
|
311
312
|
}))
|