@wakeshift/sdk 0.8.0 → 0.9.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/CHANGELOG.md +20 -0
- package/README.md +14 -10
- package/dist/errors.d.ts +11 -0
- package/dist/errors.js +12 -0
- package/dist/events.d.ts +13 -5
- package/dist/events.js +50 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/mastra.d.ts +8 -1
- package/dist/mastra.js +11 -14
- package/dist/toolcall.d.ts +56 -12
- package/dist/toolcall.js +91 -15
- package/dist/wakeshift.d.ts +8 -4
- package/dist/wakeshift.js +13 -6
- package/dist/xmcp.d.ts +19 -1
- package/dist/xmcp.js +22 -13
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,26 @@
|
|
|
2
2
|
|
|
3
3
|
What changed in each release of `@wakeshift/sdk`. 0.4.0 is the first published release: to start with it, read the [README](README.md). Its notes below, and the earlier releases', are for apps that ran the preview builds.
|
|
4
4
|
|
|
5
|
+
## 0.9.0 (2026-11-03)
|
|
6
|
+
|
|
7
|
+
### Added
|
|
8
|
+
|
|
9
|
+
- **`subscribes`: a tool declares the events it subscribes to.** `attached.events("watch_build", { subscribes: [buildFinished] }, handler)`. tools/list then adds a sentence to the tool's description, written from each event's own description and naming your app as the console has it: "This tool is how Shipyard notifies you in this conversation of this event: A build finished: it passed, failed or was canceled. Shipyard delivers its notifications through Wakeshift; the result may ask you to start a background listener and to offer the user a one-time install. Follow it." Several events read "of these events: …; …". Every tool that subscribes gets the sentence without writing it: agents set Wakeshift's part of a result aside as something the user didn't ask for unless the tool's description says the tool notifies through it. `call.subscribe` takes only the declared events (a type error otherwise), and a tool that declares `subscribes: []` has no `call.subscribe`. Mastra's adapter takes the same option; xmcp's does too, with `attached.describe(description, { subscribes })` for the tool file's metadata, since xmcp writes tools/list itself. The Go SDK has `appkit.Subscribes`, the Python SDK `@attached.tool(subscribes=[…])`. Write event descriptions as plain statements of what happened, since agents now read them in your tools' descriptions.
|
|
10
|
+
- **`IdReusedError`: an emit's `id` used for a different emit is refused.** Wakeshift deduplicated emits on `id` alone, so reusing an `id` by accident (a timestamp or a commit SHA two occurrences share) for another event, other arguments, recipients or payload dropped the second emit silently, and it returned the first's `matched`, reading as delivered. Now Wakeshift compares what each emit sends: a retry of the same emit with its `id` still sends nothing new and returns the first's result with `duplicate: true`, and the same `id` on a different emit is refused with `409 id_reused` and sends nothing. `emit` throws `IdReusedError` for it, a `WakeshiftError` with code `id_reused` (`isCode(err, "id_reused")` works too). Recipients compare as a set, so a retry may list them in another order, and `"u1"` and `["u1"]` are the same.
|
|
11
|
+
|
|
12
|
+
### Deprecated
|
|
13
|
+
|
|
14
|
+
- **A subscribe the tool doesn't declare.** `call.subscribe` from a tool wrapped without `subscribes` (`attached.events(name, handler)`), or to an event its `subscribes` doesn't list, still works in this release, and warns once per tool through `onWarning`, naming the tool and the fix. From the next release it throws. The two-argument `attached.events(name, handler)` stays, for tools that don't subscribe.
|
|
15
|
+
|
|
16
|
+
### Changed
|
|
17
|
+
|
|
18
|
+
- **`notifies` is an override.** Tools that declare `subscribes` get the sentence without it. Use `notifies(description, { when })` only for your own wording: a description that already has its sentence gets no second one.
|
|
19
|
+
|
|
20
|
+
### Fixed
|
|
21
|
+
|
|
22
|
+
- **An emit to one user with nothing subscribed lists them in `unmatched`.** It returned `matched: 0` and an empty `unmatched`, so the recipient was in neither; an emit to several listed them correctly. Every recipient is now in `matched`'s count, `unmatched` or `ended`, whether `to` names one or many.
|
|
23
|
+
- **`matched` is described the same everywhere**: the conversations an emit reached, each woken now or as soon as its agent can take it (the README said "woken").
|
|
24
|
+
|
|
5
25
|
## 0.8.0 (2026-11-03)
|
|
6
26
|
|
|
7
27
|
### Added
|
package/README.md
CHANGED
|
@@ -105,7 +105,7 @@ await turn.emit({ table: "juniper" }, { hole: ["As", "Kd"], toCall: 2 }, { to: "
|
|
|
105
105
|
```
|
|
106
106
|
|
|
107
107
|
- **`wake.defineEvent(name, { description, args, payload, text, authorize?, personal?, deleteOnDelivery? })`** returns the event. `args` is what a subscriber picks; its required string, integer and boolean fields route occurrences, so their values are lowercase IDs (a-z 0-9 . _ -), and an optional one filters on the payload field of the same name. `authorize(subscriber, args)` decides who may subscribe. With `deleteOnDelivery: true`, Wakeshift deletes each occurrence's text and payload once it's delivered. Define every event before `attach`, which throws with none.
|
|
108
|
-
- **`event.emit(args, payload, { id?, to? })`** checks the payload against its schema and sends it to everyone subscribed with those arguments. A personal event goes to its recipients, `to`: users (the `user` attach's `identify` gives for them), `{ user, subscription }` (exactly one conversation's subscription, the `id` `call.subscribe` returned) and `{ native: user }` (only that user's own MCP Events subscriptions), mixable, up to 1,000. It returns `{ matched, duplicate, unmatched, ended }`: `matched` counts the conversations
|
|
108
|
+
- **`event.emit(args, payload, { id?, to? })`** checks the payload against its schema and sends it to everyone subscribed with those arguments. A personal event goes to its recipients, `to`: users (the `user` attach's `identify` gives for them), `{ user, subscription }` (exactly one conversation's subscription, the `id` `call.subscribe` returned) and `{ native: user }` (only that user's own MCP Events subscriptions), mixable, up to 1,000. It returns `{ matched, duplicate, unmatched, ended }`: `matched` counts the conversations reached, `unmatched` the users with nothing subscribed, `ended` the subscriptions no longer live (forget them). `id` makes retries emit once: a retry of the same emit returns the first's result with `duplicate: true`, and the same `id` on a different emit (other arguments, recipients or payload) throws `IdReusedError` (`id_reused`) and sends nothing.
|
|
109
109
|
- **`wake.attach(server, { identify?, tools?, events? })`** attaches Wakeshift to your MCP server and returns the handle your own tools use (below). It serves `events/list`, `events/subscribe` and `events/unsubscribe` to clients that speak MCP Events, and adds `subscribe_events` (for everyone else), `unsubscribe_events` and `list_subscriptions` (for every client, so a person can always see and stop what they're subscribed to); `tools` names fewer of them (`BUILTIN_TOOLS`; `[]` for none). `identify(ctx)` says who is behind a request, as `{ user, client? }`: `user` is your app's ID for the person, from your own sign-in; without it, requests have no user, so personal events and `list_subscriptions` refuse. On a stateless server, which never sees `initialize` (`createMcpHandler`'s is one), `client` is the MCP client's name as your sign-in knows it (an OAuth registration's `client_name`, say): Wakeshift reads it to tell which program the agent runs in. A name the request carries wins. On a stateless server it also serves `wakeshift_wait` to clients that take MCP tasks (a recent Claude Code in the terminal): Wakeshift tells those conversations to call it, and it wakes them when your events arrive, with nothing to install; other clients don't see it. Once it has run, the first call about events sends your app's manifest, with your events: it adds them and never removes one. An emit before `attach` has run (`createMcpHandler` runs it on the first request), or from a separate process that only emits, sends the manifest only if Wakeshift answers with `unknown_event`, then emits again (see [emitting before any agent connects](#emitting-before-any-agent-connects)).
|
|
110
110
|
- **`event.end(user, id)`** ends one of a user's subscriptions by its ID, outside a tool (a player who timed out, a member removed).
|
|
111
111
|
- **`event.status(args, { to? })`** counts the conversations subscribed with those arguments (a personal event: one user's), how many are connected now, and how: `{ subscriptions, connected, via: { stream, poll, hooks, webhook } }`. **`event.statusOf([{ user, subscription }, …])`** reads up to 1,000 subscriptions by ID: `[{ id, user, live, connected, via? }]`. Both only read.
|
|
@@ -119,8 +119,8 @@ A tool like "join" subscribes the conversation calling it: wrap its callback wit
|
|
|
119
119
|
// attached: what wake.attach(server, …) returned, above.
|
|
120
120
|
server.registerTool(
|
|
121
121
|
"join",
|
|
122
|
-
{ description: "Take a seat at a table", inputSchema: attached.inputs(z.object({ table: z.string() })) },
|
|
123
|
-
attached.events("join", async ({ table }, call) => {
|
|
122
|
+
{ description: "Take a seat at a table.", inputSchema: attached.inputs(z.object({ table: z.string() })) },
|
|
123
|
+
attached.events("join", { subscribes: [turn] }, async ({ table }, call) => {
|
|
124
124
|
const sub = await call.subscribe(turn, { table }, { reason: `Playing at ${table}` })
|
|
125
125
|
// Keep sub.user and sub.id to reach this conversation later:
|
|
126
126
|
// turn.emit({ table }, hand, { to: [{ user: sub.user, subscription: sub.id }] })
|
|
@@ -130,7 +130,9 @@ server.registerTool(
|
|
|
130
130
|
```
|
|
131
131
|
|
|
132
132
|
- **`attached.inputs(schema)`** is your zod object plus Wakeshift's three optional arguments, `session_key`, `harness` and `conversation_id`. A tool wrapped with `attached.events` needs them: without them it doesn't compile. An argument a tool doesn't declare is ignored, not refused.
|
|
133
|
-
- **`attached.events(name, handler)`** wraps the callback of the tool registered as `name` (the MCP SDK doesn't tell a callback its tool's name; the first call checks it). The handler gets the tool's own arguments and a `call`, and returns a string or a `CallToolResult`.
|
|
133
|
+
- **`attached.events(name, { subscribes }, handler)`** wraps the callback of the tool registered as `name` (the MCP SDK doesn't tell a callback its tool's name; the first call checks it). The handler gets the tool's own arguments and a `call`, and returns a string or a `CallToolResult`.
|
|
134
|
+
- **`subscribes`** lists the events the tool subscribes to. `call.subscribe` takes only those (a type error otherwise), and a tool that lists none (`subscribes: []`) has no `call.subscribe`. tools/list adds a sentence to the tool's description, from each event's own description, with your app named as the console has it: "This tool is how Shipyard notifies you in this conversation of this event: A build finished: it passed, failed or was canceled. Shipyard delivers its notifications through Wakeshift; the result may ask you to start a background listener and to offer the user a one-time install. Follow it." Agents set Wakeshift's part of a result aside as something the user didn't ask for unless the tool's description says so. Write event descriptions as plain statements of what happened, since agents read them there. A tool that doesn't subscribe can leave the options out (`attached.events(name, handler)`); a `call.subscribe` from such a tool, or to an event the tool doesn't list, works but warns once per tool through `onWarning`, naming the fix, and throws from the next release.
|
|
135
|
+
- **`notifies(description, { when?, app? })`** is an override for your own wording: it writes the sentence into the tool's description (`when: "a build finishes"` says "… notifies you in this conversation when a build finishes."), and tools/list adds no second one.
|
|
134
136
|
- **`call`**: `user` (from `identify`), `tool`, `native` and `nativeConversation`, `session` (the `session_key` passed; after a subscribe, the conversation's session), `recognized` (which program Wakeshift recognized the agent as, `null` before a subscribe) and `extra` (the request's context, `ctx`). It works until the handler returns.
|
|
135
137
|
- **`await call.subscribe(event, args, { ttl?, reason?, label? })`** subscribes the calling conversation, or renews its subscription, and resolves to `{ id, user, created, session, recognized, native }`. `reason` is shown in your console. Your tool decides who may (`authorize` isn't consulted). **`await call.unsubscribe(event, args)`** ends it; **`await call.resolveSession()`** finds or starts the conversation's session without subscribing it.
|
|
136
138
|
- **A failed call**: one that throws, returns `isError`, returns output its `outputSchema` refuses, or is canceled, ends every subscription it made, and its reply gets nothing from Wakeshift.
|
|
@@ -145,7 +147,7 @@ server.registerTool(
|
|
|
145
147
|
inputSchema: attached.inputs(z.object({ table: z.string() })),
|
|
146
148
|
outputSchema: attached.output(z.object({ seats: z.number() })),
|
|
147
149
|
},
|
|
148
|
-
attached.events("look", async ({ table }) => ({
|
|
150
|
+
attached.events("look", { subscribes: [] }, async ({ table }) => ({
|
|
149
151
|
content: [{ type: "text", text: `3 seats at ${table}.` }],
|
|
150
152
|
structuredContent: { seats: 3 },
|
|
151
153
|
})),
|
|
@@ -191,7 +193,7 @@ const attached = wake.attach(server, { identify: (extra) => ({ user: myUser(extr
|
|
|
191
193
|
server.registerTool(
|
|
192
194
|
"watch_ci",
|
|
193
195
|
{ description: "Watch CI on a repo", inputSchema: attached.inputs({ owner: z.string(), repo: z.string() }) },
|
|
194
|
-
attached.events("watch_ci", async ({ owner, repo }, call) => {
|
|
196
|
+
attached.events("watch_ci", { subscribes: [ciFinished] }, async ({ owner, repo }, call) => {
|
|
195
197
|
await call.subscribe(ciFinished, { owner, repo }, { reason: `Watching ${owner}/${repo}` })
|
|
196
198
|
return `Watching CI on ${owner}/${repo}.`
|
|
197
199
|
}),
|
|
@@ -244,7 +246,7 @@ const watchCi = createTool({
|
|
|
244
246
|
id: "watch_ci",
|
|
245
247
|
description: "Watch CI on a repo",
|
|
246
248
|
inputSchema: attached.inputs(z.object({ owner: z.string(), repo: z.string() })),
|
|
247
|
-
execute: attached.events("watch_ci", async ({ owner, repo }: { owner: string; repo: string }, call) => {
|
|
249
|
+
execute: attached.events("watch_ci", { subscribes: [ciFinished] }, async ({ owner, repo }: { owner: string; repo: string }, call) => {
|
|
248
250
|
await call.subscribe(ciFinished, { owner, repo }, { reason: `Watching ${owner}/${repo}` })
|
|
249
251
|
return `Watching CI on ${owner}/${repo}.`
|
|
250
252
|
}),
|
|
@@ -255,7 +257,7 @@ const server = attached.serve(new MCPServer({ id: "ci-bot", name: "CI bot", vers
|
|
|
255
257
|
|
|
256
258
|
Serve it as Mastra's docs do (`server.startHTTP`, `server.startStdio`, or registered on your `Mastra` instance). It gets everything `attach` gives: the built-in tools, MCP Events for clients that speak it, Claude Code's `wakeshift_wait`, and Wakeshift's addition in your wrapped tools' results.
|
|
257
259
|
|
|
258
|
-
- `attached.events(name, handler)` wraps a tool's `execute` for the tool your `MCPServer` serves under `name` (its key in `tools`). `handler(args, call, context)` returns what a Mastra tool returns: a string, or your output. Run outside an MCP client's call (by an agent, a workflow or Studio), `call.subscribe` throws.
|
|
260
|
+
- `attached.events(name, { subscribes }, handler)` wraps a tool's `execute` for the tool your `MCPServer` serves under `name` (its key in `tools`); `subscribes` is as on `attach`'s handle. `handler(args, call, context)` returns what a Mastra tool returns: a string, or your output. Run outside an MCP client's call (by an agent, a workflow or Studio), `call.subscribe` throws.
|
|
259
261
|
- Wrapped tools answer in one call: a Mastra task or a request for input from one ends what it subscribed.
|
|
260
262
|
- Your own MCP Events (`MCPServer`'s `events`) keep working: `events/list` lists yours and Wakeshift's, and each request goes to whichever serves the event it names.
|
|
261
263
|
- `attached.serve` checks your `@mastra/mcp` version and throws for one outside 2.7–2.x.
|
|
@@ -282,8 +284,9 @@ const attached = attachXmcp(wake, { identify: (extra) => ({ user: myUser(extra.a
|
|
|
282
284
|
|
|
283
285
|
// src/tools/watch_ci.ts: export these three
|
|
284
286
|
const schema = attached.inputs({ owner: z.string(), repo: z.string() })
|
|
285
|
-
|
|
286
|
-
const
|
|
287
|
+
// xmcp writes tools/list itself: describe gives the metadata the sentence attach adds elsewhere.
|
|
288
|
+
const metadata = { name: "watch_ci", description: attached.describe("Watch CI on a repo.", { subscribes: [ciFinished] }) }
|
|
289
|
+
const handler = attached.events("watch_ci", { subscribes: [ciFinished] }, async ({ owner, repo }: { owner: string; repo: string }, call) => {
|
|
287
290
|
await call.subscribe(ciFinished, { owner, repo }, { reason: `Watching ${owner}/${repo}` })
|
|
288
291
|
return `Watching CI on ${owner}/${repo}.`
|
|
289
292
|
})
|
|
@@ -332,6 +335,7 @@ API errors throw `WakeshiftError` with `status` and `code`: the same codes as th
|
|
|
332
335
|
| `403` | `other_client` | The `session_key` is a conversation in another MCP client of the same user. Call again without it. |
|
|
333
336
|
| `404` | `unknown_event` | Your app offers no event by that name (an emit gets this only once the SDK has sent your manifest and tried again), or `call.subscribe` or `call.unsubscribe` was given another app's event (one defined on another `Wakeshift` client). |
|
|
334
337
|
| `404` | `unknown_publish_url` | The publish URL ID isn't one of your app's. |
|
|
338
|
+
| `409` | `id_reused` | An emit's `id` was used within the last day for a different emit (another event, arguments, recipients or payload). Nothing was sent. Give each occurrence its own `id`. |
|
|
335
339
|
| `413` | `too_large` | The request body is over 64 KB (512 KB for an emit or a status call, room for 1,000 recipients). The limit is on the whole body, so the payload must leave room for the rest of the request. |
|
|
336
340
|
| `429` | `rate_limited` | Your emits to lists named over 10,000 recipients in a minute. |
|
|
337
341
|
| `0` | `unreachable` | No answer at all: a wrong `core`, a network problem, or the timeout. The message names the core it tried. |
|
package/dist/errors.d.ts
CHANGED
|
@@ -16,5 +16,16 @@ export declare class WakeshiftError extends Error {
|
|
|
16
16
|
reason?: string;
|
|
17
17
|
});
|
|
18
18
|
}
|
|
19
|
+
/**
|
|
20
|
+
* An emit's id was used within the last day for a different emit (another
|
|
21
|
+
* event, arguments, recipients or payload): a WakeshiftError with code
|
|
22
|
+
* id_reused (status 409). Nothing was sent. A retry of the same emit isn't
|
|
23
|
+
* refused: it returns the first emit's result with `duplicate: true`.
|
|
24
|
+
*/
|
|
25
|
+
export declare class IdReusedError extends WakeshiftError {
|
|
26
|
+
constructor(message: string, options?: {
|
|
27
|
+
cause?: unknown;
|
|
28
|
+
});
|
|
29
|
+
}
|
|
19
30
|
/** Whether err is a WakeshiftError with code. */
|
|
20
31
|
export declare function isCode(err: unknown, code: string): boolean;
|
package/dist/errors.js
CHANGED
|
@@ -21,6 +21,18 @@ export class WakeshiftError extends Error {
|
|
|
21
21
|
this.reason = options.reason;
|
|
22
22
|
}
|
|
23
23
|
}
|
|
24
|
+
/**
|
|
25
|
+
* An emit's id was used within the last day for a different emit (another
|
|
26
|
+
* event, arguments, recipients or payload): a WakeshiftError with code
|
|
27
|
+
* id_reused (status 409). Nothing was sent. A retry of the same emit isn't
|
|
28
|
+
* refused: it returns the first emit's result with `duplicate: true`.
|
|
29
|
+
*/
|
|
30
|
+
export class IdReusedError extends WakeshiftError {
|
|
31
|
+
constructor(message, options) {
|
|
32
|
+
super(409, "id_reused", message, options);
|
|
33
|
+
this.name = "IdReusedError";
|
|
34
|
+
}
|
|
35
|
+
}
|
|
24
36
|
/** Whether err is a WakeshiftError with code. */
|
|
25
37
|
export function isCode(err, code) {
|
|
26
38
|
return err instanceof WakeshiftError && err.code === code;
|
package/dist/events.d.ts
CHANGED
|
@@ -53,7 +53,12 @@ export interface EventOptions<A extends AnySchema, P extends AnySchema> {
|
|
|
53
53
|
filter?: Record<string, string>;
|
|
54
54
|
}
|
|
55
55
|
export interface EmitOptions {
|
|
56
|
-
/**
|
|
56
|
+
/**
|
|
57
|
+
* Makes retries emit once for a day (at most 200 characters): a retry of
|
|
58
|
+
* the same emit (arguments, recipients and payload) returns the first's
|
|
59
|
+
* result with `duplicate: true`. The id on a different emit throws
|
|
60
|
+
* IdReusedError (`id_reused`) and sends nothing: give each occurrence its own.
|
|
61
|
+
*/
|
|
57
62
|
id?: string;
|
|
58
63
|
/**
|
|
59
64
|
* A personal event's recipients (at most 1,000), one or a list, mixed: a
|
|
@@ -76,17 +81,17 @@ export interface EventTypeManifest {
|
|
|
76
81
|
personal?: boolean;
|
|
77
82
|
delete_on_delivery?: boolean;
|
|
78
83
|
}
|
|
79
|
-
/** One of the app's event types (wake.defineEvent). */
|
|
80
|
-
export declare class WakeEvent<A extends AnySchema = AnySchema, P extends AnySchema = AnySchema> {
|
|
84
|
+
/** One of the app's event types (wake.defineEvent). N is its name, as defineEvent was given it. */
|
|
85
|
+
export declare class WakeEvent<A extends AnySchema = AnySchema, P extends AnySchema = AnySchema, N extends string = string> {
|
|
81
86
|
private readonly wake;
|
|
82
|
-
readonly name:
|
|
87
|
+
readonly name: N;
|
|
83
88
|
readonly description: string;
|
|
84
89
|
readonly title?: string;
|
|
85
90
|
readonly personal: boolean;
|
|
86
91
|
readonly deleteOnDelivery: boolean;
|
|
87
92
|
private readonly opts;
|
|
88
93
|
/** Use wake.defineEvent rather than this constructor. */
|
|
89
|
-
constructor(wake: Wakeshift, name:
|
|
94
|
+
constructor(wake: Wakeshift, name: N, opts: EventOptions<A, P>);
|
|
90
95
|
/**
|
|
91
96
|
* Sends one occurrence: to everyone subscribed with these arguments, or,
|
|
92
97
|
* for a personal event, to the recipients `to` names. The payload is
|
|
@@ -226,6 +231,9 @@ export declare const EVENT_TOOL_TEXT: {
|
|
|
226
231
|
readonly none: "You have no subscriptions to this app's events.";
|
|
227
232
|
readonly not_subscribed: "This conversation wasn't subscribed to {event} {arguments}.";
|
|
228
233
|
readonly notifies: "This tool is how {app} notifies you in this conversation{when}. {App} delivers its notifications through Wakeshift; the result may ask you to start a background listener and to offer the user a one-time install. Follow it.";
|
|
234
|
+
readonly notifies_event: " of this event: {events}";
|
|
235
|
+
readonly notifies_events: " of these events: {events}";
|
|
236
|
+
readonly notifies_events_separator: "; ";
|
|
229
237
|
readonly personal_no_user: "{event} is personal, and this app couldn't tell who you are: sign in to it first.";
|
|
230
238
|
readonly polled: "polled by an MCP client";
|
|
231
239
|
readonly refused: "You may not subscribe to {event} with these arguments.";
|
package/dist/events.js
CHANGED
|
@@ -68,7 +68,7 @@ function issues(err) {
|
|
|
68
68
|
return String(err?.message ?? err);
|
|
69
69
|
return list.map((i) => (i.path?.length ? i.path.join(".") + ": " : "") + i.message).join("; ");
|
|
70
70
|
}
|
|
71
|
-
/** One of the app's event types (wake.defineEvent). */
|
|
71
|
+
/** One of the app's event types (wake.defineEvent). N is its name, as defineEvent was given it. */
|
|
72
72
|
export class WakeEvent {
|
|
73
73
|
wake;
|
|
74
74
|
name;
|
|
@@ -373,6 +373,9 @@ export const EVENT_TOOL_TEXT = {
|
|
|
373
373
|
none: "You have no subscriptions to this app's events.",
|
|
374
374
|
not_subscribed: "This conversation wasn't subscribed to {event} {arguments}.",
|
|
375
375
|
notifies: "This tool is how {app} notifies you in this conversation{when}. {App} delivers its notifications through Wakeshift; the result may ask you to start a background listener and to offer the user a one-time install. Follow it.",
|
|
376
|
+
notifies_event: " of this event: {events}",
|
|
377
|
+
notifies_events: " of these events: {events}",
|
|
378
|
+
notifies_events_separator: "; ",
|
|
376
379
|
personal_no_user: "{event} is personal, and this app couldn't tell who you are: sign in to it first.",
|
|
377
380
|
polled: "polled by an MCP client",
|
|
378
381
|
refused: "You may not subscribe to {event} with these arguments.",
|
|
@@ -397,6 +400,52 @@ export function notifiesSentence(app, when) {
|
|
|
397
400
|
const App = app.charAt(0).toUpperCase() + app.slice(1);
|
|
398
401
|
return EVENT_TOOL_TEXT.notifies.replace(/\{when\}/g, w ? ` when ${w}` : "").replace(/\{App\}/g, App).replace(/\{app\}/g, app);
|
|
399
402
|
}
|
|
403
|
+
/**
|
|
404
|
+
* @internal The sentence tools/list adds to a tool that declares the events
|
|
405
|
+
* it subscribes to (attached.events' subscribes): notifies' sentence with
|
|
406
|
+
* the events' own descriptions where when goes, "of this event: <d>" or
|
|
407
|
+
* "of these events: <d1>; <d2>". Each description is on one line, without
|
|
408
|
+
* its trailing period: the sentence adds one. test/subscribes.json pins it.
|
|
409
|
+
*/
|
|
410
|
+
export function subscribesSentence(app, descriptions) {
|
|
411
|
+
const ds = eventDescriptions(descriptions);
|
|
412
|
+
if (ds.length === 0)
|
|
413
|
+
return "";
|
|
414
|
+
const of = fill(ds.length === 1 ? "notifies_event" : "notifies_events", { events: ds.join(EVENT_TOOL_TEXT.notifies_events_separator) });
|
|
415
|
+
const App = app.charAt(0).toUpperCase() + app.slice(1);
|
|
416
|
+
return EVENT_TOOL_TEXT.notifies.replace(/\{when\}/g, () => of).replace(/\{App\}/g, () => App).replace(/\{app\}/g, () => app);
|
|
417
|
+
}
|
|
418
|
+
// eventDescriptions is the declared events' descriptions as the sentence
|
|
419
|
+
// quotes them: each on one line, its trailing periods trimmed, each once.
|
|
420
|
+
function eventDescriptions(descriptions) {
|
|
421
|
+
const out = [];
|
|
422
|
+
for (const d of descriptions) {
|
|
423
|
+
const c = (d ?? "").replace(/\s+/g, " ").trim().replace(/[.\s]+$/, "");
|
|
424
|
+
if (c && !out.includes(c))
|
|
425
|
+
out.push(c);
|
|
426
|
+
}
|
|
427
|
+
return out;
|
|
428
|
+
}
|
|
429
|
+
// NOTIFIES_TAIL is the part of every notifies sentence after the app's
|
|
430
|
+
// name, whatever its app and events: a description that has it already
|
|
431
|
+
// says how the app notifies (notifies() wrote it).
|
|
432
|
+
const NOTIFIES_TAIL = EVENT_TOOL_TEXT.notifies.slice(EVENT_TOOL_TEXT.notifies.indexOf("{App}") + "{App}".length);
|
|
433
|
+
/**
|
|
434
|
+
* @internal A tool's description as tools/list gives it for a tool that
|
|
435
|
+
* declares the events it subscribes to: the subscribes sentence after the
|
|
436
|
+
* tool's own description. A description that already has a notifies
|
|
437
|
+
* sentence (notifies(), for custom wording), or no events, leaves it as it
|
|
438
|
+
* was. app is the app's name ("this app" until tools/list names it).
|
|
439
|
+
*/
|
|
440
|
+
export function withSubscribes(description, descriptions, app = UNNAMED_APP) {
|
|
441
|
+
const d = (description ?? "").trim();
|
|
442
|
+
if (d.includes(NOTIFIES_TAIL))
|
|
443
|
+
return description;
|
|
444
|
+
const n = subscribesSentence(app.trim() || UNNAMED_APP, descriptions);
|
|
445
|
+
if (!n)
|
|
446
|
+
return description;
|
|
447
|
+
return d ? `${d} ${n}` : n;
|
|
448
|
+
}
|
|
400
449
|
/** @internal The parts of notifies' sentence that name the app, for "this app": tools/list names it. */
|
|
401
450
|
export function unnamedNotifiesParts() {
|
|
402
451
|
const s = notifiesSentence(UNNAMED_APP);
|
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
export { Wakeshift, DEFAULT_CORE, SESSION_ARG, HARNESS_ARG, CONVERSATION_ARG, type WakeshiftOptions, type AppInfo, type Duration, type Recognized, type Emitted, type Recipient, type Via, type PublishUrl, type ToolExtra, type Manifest, type AgentScope, type ScopeEvent, } from "./wakeshift.js";
|
|
2
2
|
export { harnessAgent } from "./harness.js";
|
|
3
|
-
export { WakeshiftError, isCode } from "./errors.js";
|
|
3
|
+
export { IdReusedError, WakeshiftError, isCode } from "./errors.js";
|
|
4
4
|
export { parseKey, signAssertion, type AppKey } from "./key.js";
|
|
5
5
|
export { WakeEvent, ArgsError, EVENT_TOOL_TEXT, notifies, type NotifiesOptions, SUBSCRIBE_TOOL_DESCRIPTION, UNSUBSCRIBE_TOOL_DESCRIPTION, LIST_TOOL_DESCRIPTION, BUILTIN_TOOLS, type BuiltinTool, type EventOptions, type EmitOptions, type EventStatus, type EventSubscriptionStatus, MAX_STATUS_SUBSCRIPTIONS, type EventTypeManifest, type AttachOptions, type Identity, type Subscriber, } from "./events.js";
|
|
6
|
-
export { CallEnded, type Attached, type AppArgs, type EventsOptions, type Subscription, type ToolCall, type ToolCallExtra, type ToolSubscribeOptions, type WakeArgs, type WakeInputs, type WakeInputsV3, type WakeInputsV4, type WakeKey, type WakeOutputShape, type WakeOutputV3, type WakeOutputV4, type WakeShape, type WrappedCallback, type WrappedResult, } from "./toolcall.js";
|
|
6
|
+
export { CallEnded, type AnyWakeEvent, type EventArgs, type ToolCallBase, type ToolCallSubscribe, type ToolEventsOptions, type Attached, type AppArgs, type EventsOptions, type Subscription, type ToolCall, type ToolCallExtra, type ToolSubscribeOptions, type WakeArgs, type WakeInputs, type WakeInputsV3, type WakeInputsV4, type WakeKey, type WakeOutputShape, type WakeOutputV3, type WakeOutputV4, type WakeShape, type WrappedCallback, type WrappedResult, } from "./toolcall.js";
|
|
7
7
|
export type { AuthInfo, CallToolResult, ContentBlock, HostContext, McpServerLike } from "./mcp.js";
|
|
8
8
|
export { EXTENSION_KEY, TEXT_META, REVISION as EVENTS_REVISION } from "./spec.js";
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export { Wakeshift, DEFAULT_CORE, SESSION_ARG, HARNESS_ARG, CONVERSATION_ARG, } from "./wakeshift.js";
|
|
2
2
|
export { harnessAgent } from "./harness.js";
|
|
3
|
-
export { WakeshiftError, isCode } from "./errors.js";
|
|
3
|
+
export { IdReusedError, WakeshiftError, isCode } from "./errors.js";
|
|
4
4
|
export { parseKey, signAssertion } from "./key.js";
|
|
5
5
|
export { WakeEvent, ArgsError, EVENT_TOOL_TEXT, notifies, SUBSCRIBE_TOOL_DESCRIPTION, UNSUBSCRIBE_TOOL_DESCRIPTION, LIST_TOOL_DESCRIPTION, BUILTIN_TOOLS, MAX_STATUS_SUBSCRIPTIONS, } from "./events.js";
|
|
6
6
|
export { CallEnded, } from "./toolcall.js";
|
package/dist/mastra.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ import type * as z4 from "zod/v4";
|
|
|
3
3
|
import type { ToolCallExtra } from "./mcp.js";
|
|
4
4
|
import type { ZodRawShapeCompat } from "./zod.js";
|
|
5
5
|
import { type AttachOptions, type BuiltinTool, type Identity } from "./events.js";
|
|
6
|
-
import { CallEnded, type ToolCall, type WakeArgs, type WakeInputs, type WakeInputsV3, type WakeInputsV4, type WakeOutputShape, type WakeOutputV3, type WakeOutputV4 } from "./toolcall.js";
|
|
6
|
+
import { CallEnded, type AnyWakeEvent, type ToolCall, type ToolEventsOptions, type WakeArgs, type WakeInputs, type WakeInputsV3, type WakeInputsV4, type WakeOutputShape, type WakeOutputV3, type WakeOutputV4 } from "./toolcall.js";
|
|
7
7
|
import type { Wakeshift } from "./wakeshift.js";
|
|
8
8
|
/** The @mastra/mcp releases serve() is built for: 2.x, from 2.7. */
|
|
9
9
|
export declare const MASTRA_MCP_RANGE = ">=2.7.0 <3.0.0";
|
|
@@ -31,6 +31,7 @@ export declare class MastraAttached {
|
|
|
31
31
|
private readonly wake;
|
|
32
32
|
private readonly opts;
|
|
33
33
|
private readonly wrapped;
|
|
34
|
+
private readonly declared;
|
|
34
35
|
private readonly scopes;
|
|
35
36
|
private readonly shapes;
|
|
36
37
|
private readonly served;
|
|
@@ -56,7 +57,13 @@ export declare class MastraAttached {
|
|
|
56
57
|
* subscriptions it made. Its inputSchema must come from attached.inputs.
|
|
57
58
|
* Run outside an MCP request (by an agent, a workflow or Studio), the
|
|
58
59
|
* handler gets a call whose subscribe throws.
|
|
60
|
+
*
|
|
61
|
+
* subscribes lists the events the tool subscribes to, as attach's
|
|
62
|
+
* attached.events takes it: call.subscribe takes only those, and
|
|
63
|
+
* tools/list says the tool is how the app notifies the agent of them.
|
|
64
|
+
* `execute: attached.events("watch_ci", { subscribes: [ciFinished] }, async (args, call) => …)`.
|
|
59
65
|
*/
|
|
66
|
+
events<P extends Record<string, any> = Record<string, any>, R = unknown, const E extends readonly AnyWakeEvent[] = readonly AnyWakeEvent[]>(name: string, opts: ToolEventsOptions<E>, handler: (args: P, call: ToolCall<MastraContext, E[number]>, context: MastraToolContext) => R | Promise<R>): (input: P & WakeArgs, context?: any) => Promise<R>;
|
|
60
67
|
events<P extends Record<string, any> = Record<string, any>, R = unknown>(name: string, handler: (args: P, call: ToolCall<MastraContext>, context: MastraToolContext) => R | Promise<R>): (input: P & WakeArgs, context?: any) => Promise<R>;
|
|
61
68
|
/**
|
|
62
69
|
* Serves Wakeshift from your MCPServer (@mastra/mcp 2.7 or later, 2.x),
|
package/dist/mastra.js
CHANGED
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
// id: "watch_ci",
|
|
28
28
|
// description: "Watch CI on a repo",
|
|
29
29
|
// inputSchema: attached.inputs(z.object({ owner: z.string(), repo: z.string() })),
|
|
30
|
-
// execute: attached.events("watch_ci", async ({ owner, repo }, call) => {
|
|
30
|
+
// execute: attached.events("watch_ci", { subscribes: [ciFinished] }, async ({ owner, repo }, call) => {
|
|
31
31
|
// await call.subscribe(ciFinished, { owner, repo })
|
|
32
32
|
// return `Watching CI on ${owner}/${repo}.`
|
|
33
33
|
// }),
|
|
@@ -60,6 +60,8 @@ export class MastraAttached {
|
|
|
60
60
|
wake;
|
|
61
61
|
opts;
|
|
62
62
|
wrapped = new Set();
|
|
63
|
+
// The events each wrapped tool declares (subscribes), by tool.
|
|
64
|
+
declared = new Map();
|
|
63
65
|
// The call each wrapped tool's execute belongs to, by its request (ctx.mcpReq,
|
|
64
66
|
// which Mastra passes the tool as context.mcp.extra.mcpReq).
|
|
65
67
|
scopes = new WeakMap();
|
|
@@ -79,23 +81,18 @@ export class MastraAttached {
|
|
|
79
81
|
output(schema) {
|
|
80
82
|
return this.shapes.output(schema);
|
|
81
83
|
}
|
|
82
|
-
|
|
83
|
-
* Wraps a Mastra tool's execute, for the tool your MCPServer serves under
|
|
84
|
-
* the same name (its key in `tools`): `execute: attached.events("watch_ci",
|
|
85
|
-
* async (args, call) => …)`. handler gets your own arguments, a ToolCall
|
|
86
|
-
* and Mastra's tool context, and returns what a Mastra tool returns (a
|
|
87
|
-
* string, or your output). The reply an MCP client gets carries what
|
|
88
|
-
* Wakeshift adds for the conversation; a call that fails ends the
|
|
89
|
-
* subscriptions it made. Its inputSchema must come from attached.inputs.
|
|
90
|
-
* Run outside an MCP request (by an agent, a workflow or Studio), the
|
|
91
|
-
* handler gets a call whose subscribe throws.
|
|
92
|
-
*/
|
|
93
|
-
events(name, handler) {
|
|
84
|
+
events(name, optsOrHandler, maybeHandler) {
|
|
94
85
|
if (!name || typeof name !== "string")
|
|
95
86
|
throw new Error("wakeshift: attached.events needs the tool's name, as your MCPServer serves it");
|
|
87
|
+
const declared = typeof optsOrHandler === "function" ? null : this.shapes.checkDeclared(name, optsOrHandler);
|
|
88
|
+
const handler = (typeof optsOrHandler === "function" ? optsOrHandler : maybeHandler);
|
|
96
89
|
if (typeof handler !== "function")
|
|
97
90
|
throw new Error("wakeshift: attached.events needs a handler");
|
|
98
91
|
this.wrapped.add(name);
|
|
92
|
+
if (declared)
|
|
93
|
+
this.declared.set(name, declared);
|
|
94
|
+
else
|
|
95
|
+
this.declared.delete(name);
|
|
99
96
|
return async (input, context) => {
|
|
100
97
|
const key = context?.mcp?.extra?.mcpReq;
|
|
101
98
|
const scope = key && typeof key === "object" ? this.scopes.get(key) : undefined;
|
|
@@ -150,7 +147,7 @@ export class MastraAttached {
|
|
|
150
147
|
const events = this.wake.serveEvents();
|
|
151
148
|
const attached = attachHost(this.wake, host, events, this.opts);
|
|
152
149
|
for (const name of this.wrapped)
|
|
153
|
-
attached.markWrapped(name);
|
|
150
|
+
attached.markWrapped(name, this.declared.get(name) ?? null);
|
|
154
151
|
if (theirs.size > 0)
|
|
155
152
|
shareEvents(handlers, theirs, new Set(events.map((e) => e.name)));
|
|
156
153
|
this.wrapCalls(handlers, attached);
|
package/dist/toolcall.d.ts
CHANGED
|
@@ -97,12 +97,16 @@ export interface ToolSubscribeOptions {
|
|
|
97
97
|
/** Names a new session (agent@label), for an app acting for its agents. */
|
|
98
98
|
label?: string;
|
|
99
99
|
}
|
|
100
|
+
/** Any of the app's events: what call.subscribe takes in a tool that doesn't declare its events. */
|
|
101
|
+
export type AnyWakeEvent = WakeEvent<any, any, any>;
|
|
102
|
+
/** The arguments event takes, as call.subscribe takes them. */
|
|
103
|
+
export type EventArgs<E> = E extends WakeEvent<infer A, any, any> ? SchemaInput<A> : never;
|
|
100
104
|
/**
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
105
|
+
* What every ToolCall has, whatever its tool subscribes to: who's calling,
|
|
106
|
+
* unsubscribe and resolveSession. Only the wrapper makes one, and it works
|
|
107
|
+
* until the handler returns (then CallEnded).
|
|
104
108
|
*/
|
|
105
|
-
export interface
|
|
109
|
+
export interface ToolCallBase<C = any> {
|
|
106
110
|
/** Who attach's identify says is calling (undefined for none). */
|
|
107
111
|
readonly user: string | undefined;
|
|
108
112
|
/** The tool being called. */
|
|
@@ -121,23 +125,49 @@ export interface ToolCall<C = any> {
|
|
|
121
125
|
readonly recognized: Recognized | null;
|
|
122
126
|
/** The call's request context, as your MCP SDK passes it to the tool's callback: 2.x's ctx, 1.x's extra. */
|
|
123
127
|
readonly extra: C;
|
|
128
|
+
/**
|
|
129
|
+
* Ends the calling conversation's subscription to event with args,
|
|
130
|
+
* resolving to whether one ended. For a native caller it ends the user's
|
|
131
|
+
* own (webhook) subscriptions to the event with those arguments.
|
|
132
|
+
*/
|
|
133
|
+
unsubscribe<A extends AnySchema>(event: WakeEvent<A, any>, args: SchemaInput<A>): Promise<boolean>;
|
|
134
|
+
/** Finds or starts the calling conversation's session without subscribing it (it doesn't make it wakeable). */
|
|
135
|
+
resolveSession(): Promise<string>;
|
|
136
|
+
}
|
|
137
|
+
/** call.subscribe, for a tool that subscribes to the events E. */
|
|
138
|
+
export interface ToolCallSubscribe<E extends AnyWakeEvent = AnyWakeEvent> {
|
|
124
139
|
/**
|
|
125
140
|
* Subscribes the calling conversation to event with args, or renews its
|
|
126
141
|
* subscription. The reply then carries what the conversation needs to be
|
|
127
142
|
* woken (one block for the call, however many subscribes it makes), and
|
|
128
143
|
* if the call fails, the subscription is ended. For a native caller
|
|
129
144
|
* nothing is made. Your tool decides who may: authorize isn't consulted.
|
|
130
|
-
* A personal event needs a user (identify's).
|
|
145
|
+
* A personal event needs a user (identify's). event is one of the events
|
|
146
|
+
* the tool declares (attached.events' subscribes).
|
|
131
147
|
*/
|
|
132
|
-
subscribe<
|
|
148
|
+
subscribe<Ev extends E>(event: Ev, args: EventArgs<Ev>, opts?: ToolSubscribeOptions): Promise<Subscription>;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* One call of a wrapped tool (attached.events): who's calling, and the
|
|
152
|
+
* calls that subscribe the calling conversation. E is the events the tool
|
|
153
|
+
* declares (`attached.events(name, { subscribes: [...] }, handler)`):
|
|
154
|
+
* call.subscribe takes only those, and a tool that declares none has no
|
|
155
|
+
* call.subscribe. A tool wrapped without subscribes gets a call whose
|
|
156
|
+
* subscribe takes any of the app's events, and warns when it's used.
|
|
157
|
+
*/
|
|
158
|
+
export type ToolCall<C = any, E extends AnyWakeEvent = AnyWakeEvent> = ToolCallBase<C> & ([E] extends [never] ? {} : ToolCallSubscribe<E>);
|
|
159
|
+
/** attached.events' options for a tool. */
|
|
160
|
+
export interface ToolEventsOptions<E extends readonly AnyWakeEvent[] = readonly AnyWakeEvent[]> {
|
|
133
161
|
/**
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
162
|
+
* The events the tool subscribes the calling conversation to (with
|
|
163
|
+
* call.subscribe). tools/list then adds a sentence to the tool's
|
|
164
|
+
* description saying the tool is how the app notifies the agent of them,
|
|
165
|
+
* in their own descriptions' words, and that the result may ask to start
|
|
166
|
+
* a listener and offer an install. Agents set Wakeshift's part of a
|
|
167
|
+
* result aside as unrequested unless the tool's description says so. An
|
|
168
|
+
* empty list declares that the tool subscribes to nothing.
|
|
137
169
|
*/
|
|
138
|
-
|
|
139
|
-
/** Finds or starts the calling conversation's session without subscribing it (it doesn't make it wakeable). */
|
|
140
|
-
resolveSession(): Promise<string>;
|
|
170
|
+
subscribes: E;
|
|
141
171
|
}
|
|
142
172
|
/** A ToolCall used after its handler returned. */
|
|
143
173
|
export declare class CallEnded extends Error {
|
|
@@ -170,6 +200,7 @@ export declare const WAKESHIFT_FIELD = "wakeshift";
|
|
|
170
200
|
*/
|
|
171
201
|
export declare class Attached<C = any> {
|
|
172
202
|
private readonly at;
|
|
203
|
+
private readonly declared;
|
|
173
204
|
/**
|
|
174
205
|
* A tool's input schema plus Wakeshift's three optional arguments
|
|
175
206
|
* (session_key, harness and conversation_id), for a wrapped tool's
|
|
@@ -199,10 +230,23 @@ export declare class Attached<C = any> {
|
|
|
199
230
|
* a CallToolResult; the reply gets Wakeshift's block. The tool's
|
|
200
231
|
* inputSchema must come from attached.inputs (a type error otherwise).
|
|
201
232
|
* Register it on the server passed to attach.
|
|
233
|
+
*
|
|
234
|
+
* subscribes lists the events the tool subscribes to: call.subscribe
|
|
235
|
+
* takes only those, and tools/list adds a sentence to the tool's
|
|
236
|
+
* description saying it's how the app notifies the agent of them.
|
|
237
|
+
*
|
|
238
|
+
* attached.events("watch_build", { subscribes: [buildFinished] }, async ({ build }, call) => { … })
|
|
239
|
+
*
|
|
240
|
+
* Without subscribes (attached.events(name, handler)), call.subscribe
|
|
241
|
+
* takes any of the app's events but warns: declare them.
|
|
202
242
|
*/
|
|
243
|
+
events<A extends WakeArgs, const E extends readonly AnyWakeEvent[]>(name: string, opts: ToolEventsOptions<E>, handler: (args: Omit<A, WakeKey>, call: ToolCall<C, E[number]>) => WrappedResult | Promise<WrappedResult>): WrappedCallback<A, C>;
|
|
203
244
|
events<A extends WakeArgs>(name: string, handler: (args: Omit<A, WakeKey>, call: ToolCall<C>) => WrappedResult | Promise<WrappedResult>): WrappedCallback<A, C>;
|
|
245
|
+
private declaredOf;
|
|
246
|
+
private declare;
|
|
204
247
|
private run;
|
|
205
248
|
amendToolsList(): void;
|
|
249
|
+
private describeTools;
|
|
206
250
|
/**
|
|
207
251
|
* notifies(description) with no app named says "this app": tools/list
|
|
208
252
|
* names the app instead, as the console has it (GET /app, asked once). A
|
package/dist/toolcall.js
CHANGED
|
@@ -10,12 +10,12 @@
|
|
|
10
10
|
// const attached = wake.attach(server, { identify: (extra) => ({ user: userOf(extra) }) })
|
|
11
11
|
// server.registerTool("join",
|
|
12
12
|
// { description: "…", inputSchema: attached.inputs({ table: z.string() }) },
|
|
13
|
-
// attached.events("join", async ({ table }, call) => {
|
|
13
|
+
// attached.events("join", { subscribes: [turn] }, async ({ table }, call) => {
|
|
14
14
|
// const sub = await call.subscribe(turn, { table }, { reason: `Playing at ${table}` })
|
|
15
15
|
// await casino.seat(call.user!, table, sub.id)
|
|
16
16
|
// return `You're seated at ${table}.`
|
|
17
17
|
// }))
|
|
18
|
-
import { UNNAMED_APP, unnamedNotifiesParts } from "./events.js";
|
|
18
|
+
import { UNNAMED_APP, unnamedNotifiesParts, withSubscribes } from "./events.js";
|
|
19
19
|
import { z } from "zod";
|
|
20
20
|
import * as z3 from "zod/v3";
|
|
21
21
|
import * as z4 from "zod/v4";
|
|
@@ -101,6 +101,27 @@ export const CONVERSATION_META = [
|
|
|
101
101
|
"wakeshift/conversation",
|
|
102
102
|
"x-codex-turn-metadata.thread_id",
|
|
103
103
|
];
|
|
104
|
+
/**
|
|
105
|
+
* @internal What a subscribe the tool doesn't declare does: warns once per
|
|
106
|
+
* tool (this release) or throws (error: the next release). Tests flip it.
|
|
107
|
+
*/
|
|
108
|
+
export const undeclaredSubscribe = { error: false };
|
|
109
|
+
// eventRef is how a warning writes an event in its fix: the name of the
|
|
110
|
+
// event wake.defineEvent returned.
|
|
111
|
+
const eventRef = (name) => `<${name}'s event>`;
|
|
112
|
+
/** @internal The warning (or, with undeclaredSubscribe.error, the error) for a subscribe the tool doesn't declare. */
|
|
113
|
+
export function undeclaredMessage(tool, event, declared, error) {
|
|
114
|
+
const all = [...(declared ?? []), event];
|
|
115
|
+
const fix = `attached.events(${JSON.stringify(tool)}, { subscribes: [${all.map(eventRef).join(", ")}] }, handler)`;
|
|
116
|
+
const what = declared === null
|
|
117
|
+
? `the tool ${tool} subscribed to ${event} without declaring the events it subscribes to`
|
|
118
|
+
: declared.length === 0
|
|
119
|
+
? `the tool ${tool} subscribed to ${event}, but declares that it subscribes to nothing`
|
|
120
|
+
: `the tool ${tool} subscribed to ${event}, which its subscribes doesn't list (${declared.join(", ")})`;
|
|
121
|
+
if (error)
|
|
122
|
+
return `wakeshift: ${what}, so the subscribe was refused. Fix: ${fix}.`;
|
|
123
|
+
return `wakeshift: ${what}, so tools/list doesn't tell the agent that the tool is how this app notifies it. Fix: ${fix}. It works for now; from the next release an undeclared subscribe throws.`;
|
|
124
|
+
}
|
|
104
125
|
/** A ToolCall used after its handler returned. */
|
|
105
126
|
export class CallEnded extends Error {
|
|
106
127
|
constructor() {
|
|
@@ -229,6 +250,8 @@ function detailOf(err) {
|
|
|
229
250
|
export class CallScope {
|
|
230
251
|
at;
|
|
231
252
|
args;
|
|
253
|
+
/** The events the tool declares (null: it declares none: attached.events without subscribes). */
|
|
254
|
+
declared;
|
|
232
255
|
user;
|
|
233
256
|
tool;
|
|
234
257
|
native = false;
|
|
@@ -248,9 +271,10 @@ export class CallScope {
|
|
|
248
271
|
queue = Promise.resolve();
|
|
249
272
|
// The client's name identify gave, for a request that names none.
|
|
250
273
|
identified;
|
|
251
|
-
constructor(at, tool, extra, args) {
|
|
274
|
+
constructor(at, tool, extra, args, declared = null) {
|
|
252
275
|
this.at = at;
|
|
253
276
|
this.args = args;
|
|
277
|
+
this.declared = declared;
|
|
254
278
|
this.tool = tool;
|
|
255
279
|
this.extra = extra;
|
|
256
280
|
const id = at.identify(extra);
|
|
@@ -295,9 +319,21 @@ export class CallScope {
|
|
|
295
319
|
throw new WakeshiftError(404, "unknown_event", `${event?.name ?? "that"} is another app's event: this app doesn't offer it`);
|
|
296
320
|
}
|
|
297
321
|
}
|
|
322
|
+
// checkDeclared warns once per tool (or throws, once undeclared subscribes
|
|
323
|
+
// are an error) when the tool doesn't declare event.
|
|
324
|
+
checkDeclared(event) {
|
|
325
|
+
const d = this.declared;
|
|
326
|
+
if (d && d.some((e) => e === event || e.name === event.name))
|
|
327
|
+
return;
|
|
328
|
+
const names = d ? d.map((e) => e.name) : null;
|
|
329
|
+
if (undeclaredSubscribe.error)
|
|
330
|
+
throw new Error(undeclaredMessage(this.tool, event.name, names, true));
|
|
331
|
+
this.at.warnOnce("undeclared:" + this.tool, undeclaredMessage(this.tool, event.name, names, false));
|
|
332
|
+
}
|
|
298
333
|
subscribe(event, args, opts = {}) {
|
|
299
334
|
return this.request(async () => {
|
|
300
335
|
this.checkEvent(event);
|
|
336
|
+
this.checkDeclared(event);
|
|
301
337
|
const known = event.parseArgs(args);
|
|
302
338
|
if (this.native) {
|
|
303
339
|
this.addNative(event.name, known);
|
|
@@ -494,6 +530,8 @@ export class Attached {
|
|
|
494
530
|
at;
|
|
495
531
|
/** @internal */
|
|
496
532
|
wrapped = new Map();
|
|
533
|
+
// The events each wrapped tool declares (attached.events' subscribes), by tool.
|
|
534
|
+
declared = new Map();
|
|
497
535
|
/** @internal Use wake.attach. */
|
|
498
536
|
constructor(at) {
|
|
499
537
|
this.at = at;
|
|
@@ -526,23 +564,38 @@ export class Attached {
|
|
|
526
564
|
throw new Error("wakeshift: attached.output adds wakeshift itself: leave it out of the shape");
|
|
527
565
|
return { ...shape, ...fieldsFor(shape, "output", this.at.host) };
|
|
528
566
|
}
|
|
529
|
-
|
|
530
|
-
* Wraps a tool's callback, for `server.registerTool(name, …)` with the
|
|
531
|
-
* same name (MCP doesn't tell a callback its tool's name): the handler
|
|
532
|
-
* gets the tool's own arguments and a ToolCall, and returns a string or
|
|
533
|
-
* a CallToolResult; the reply gets Wakeshift's block. The tool's
|
|
534
|
-
* inputSchema must come from attached.inputs (a type error otherwise).
|
|
535
|
-
* Register it on the server passed to attach.
|
|
536
|
-
*/
|
|
537
|
-
events(name, handler) {
|
|
567
|
+
events(name, optsOrHandler, maybeHandler) {
|
|
538
568
|
if (!name || typeof name !== "string")
|
|
539
569
|
throw new Error("wakeshift: attached.events needs the tool's name, as registered");
|
|
570
|
+
const declared = typeof optsOrHandler === "function" ? null : this.declaredOf(name, optsOrHandler);
|
|
571
|
+
const handler = typeof optsOrHandler === "function" ? optsOrHandler : maybeHandler;
|
|
540
572
|
if (typeof handler !== "function")
|
|
541
573
|
throw new Error("wakeshift: attached.events needs a handler");
|
|
542
574
|
const cb = (async (args, extra) => this.run(name, cb, handler, args ?? {}, extra));
|
|
543
575
|
this.wrapped.set(name, cb);
|
|
576
|
+
this.declare(name, declared);
|
|
544
577
|
return cb;
|
|
545
578
|
}
|
|
579
|
+
// declaredOf checks attached.events' options: the tool's subscribes, each
|
|
580
|
+
// one of this app's events.
|
|
581
|
+
declaredOf(name, opts) {
|
|
582
|
+
const list = opts?.subscribes;
|
|
583
|
+
if (!Array.isArray(list))
|
|
584
|
+
throw new Error(`wakeshift: attached.events("${name}", options, handler): options.subscribes lists the events the tool subscribes to ([] for none)`);
|
|
585
|
+
for (const e of list) {
|
|
586
|
+
if (!e || typeof e.owner !== "function" || e.owner() !== this.at.wake) {
|
|
587
|
+
throw new Error(`wakeshift: attached.events("${name}", …): subscribes lists ${e?.name ?? String(e)}, which isn't one of this app's events (wake.defineEvent)`);
|
|
588
|
+
}
|
|
589
|
+
}
|
|
590
|
+
return [...list];
|
|
591
|
+
}
|
|
592
|
+
// declare records the events a tool declares (null: none declared).
|
|
593
|
+
declare(name, declared) {
|
|
594
|
+
if (declared)
|
|
595
|
+
this.declared.set(name, declared);
|
|
596
|
+
else
|
|
597
|
+
this.declared.delete(name);
|
|
598
|
+
}
|
|
546
599
|
async run(name, cb, handler, input, extra) {
|
|
547
600
|
const host = this.at.host;
|
|
548
601
|
const tool = host.registeredTool(name);
|
|
@@ -578,7 +631,7 @@ export class Attached {
|
|
|
578
631
|
*/
|
|
579
632
|
begin(name, input, extra) {
|
|
580
633
|
const str = (k) => (typeof input[k] === "string" && input[k] ? input[k] : undefined);
|
|
581
|
-
const call = new CallScope(this.at, name, extra, { session: str(SESSION_ARG), harness: str(HARNESS_ARG), conversation: str(CONVERSATION_ARG) });
|
|
634
|
+
const call = new CallScope(this.at, name, extra, { session: str(SESSION_ARG), harness: str(HARNESS_ARG), conversation: str(CONVERSATION_ARG) }, this.declared.get(name) ?? null);
|
|
582
635
|
const appArgs = {};
|
|
583
636
|
for (const [k, v] of Object.entries(input ?? {}))
|
|
584
637
|
if (!WAKE_KEYS.includes(k))
|
|
@@ -639,10 +692,15 @@ export class Attached {
|
|
|
639
692
|
* sets the handler when the first tool is registered, perhaps after
|
|
640
693
|
* attach, so a later set is wrapped too (as tasks.ts does).
|
|
641
694
|
*/
|
|
642
|
-
/** @internal Marks name as a wrapped tool, for tools/list (a framework adapter's tool, wrapped outside this handle). */
|
|
643
|
-
markWrapped(name) {
|
|
695
|
+
/** @internal Marks name as a wrapped tool, for tools/list (a framework adapter's tool, wrapped outside this handle), with the events it declares (null: none). */
|
|
696
|
+
markWrapped(name, declared = null) {
|
|
644
697
|
if (!this.wrapped.has(name))
|
|
645
698
|
this.wrapped.set(name, true);
|
|
699
|
+
this.declare(name, declared);
|
|
700
|
+
}
|
|
701
|
+
/** @internal The events a framework adapter's tool declares, checked as attached.events checks them. */
|
|
702
|
+
checkDeclared(name, opts) {
|
|
703
|
+
return this.declaredOf(name, opts);
|
|
646
704
|
}
|
|
647
705
|
amendToolsList() {
|
|
648
706
|
const handlers = this.at.host.handlers();
|
|
@@ -652,6 +710,7 @@ export class Attached {
|
|
|
652
710
|
const out = await h(request, extra);
|
|
653
711
|
if (out && Array.isArray(out.tools)) {
|
|
654
712
|
this.amendTools(out.tools);
|
|
713
|
+
this.describeTools(out.tools);
|
|
655
714
|
await this.nameApp(out.tools);
|
|
656
715
|
}
|
|
657
716
|
return out;
|
|
@@ -662,6 +721,23 @@ export class Attached {
|
|
|
662
721
|
const set = handlers.set.bind(handlers);
|
|
663
722
|
handlers.set = (method, h) => set(method, method === "tools/list" ? wrap(h) : h);
|
|
664
723
|
}
|
|
724
|
+
// describeTools adds the subscribes sentence to each tool that declares
|
|
725
|
+
// events (withSubscribes; "this app" until nameApp names it). A tool's
|
|
726
|
+
// own notifies() sentence stays the only one.
|
|
727
|
+
describeTools(tools) {
|
|
728
|
+
for (let i = 0; i < tools.length; i++) {
|
|
729
|
+
const t = tools[i];
|
|
730
|
+
if (!t || typeof t !== "object" || typeof t.name !== "string")
|
|
731
|
+
continue;
|
|
732
|
+
const evs = this.declared.get(t.name);
|
|
733
|
+
if (!evs || evs.length === 0)
|
|
734
|
+
continue;
|
|
735
|
+
const d = typeof t.description === "string" ? t.description : "";
|
|
736
|
+
const described = withSubscribes(d, evs.map((e) => e.description));
|
|
737
|
+
if (described !== d)
|
|
738
|
+
tools[i] = { ...t, description: described };
|
|
739
|
+
}
|
|
740
|
+
}
|
|
665
741
|
/**
|
|
666
742
|
* notifies(description) with no app named says "this app": tools/list
|
|
667
743
|
* names the app instead, as the console has it (GET /app, asked once). A
|
package/dist/wakeshift.d.ts
CHANGED
|
@@ -78,11 +78,15 @@ export type Recipient = {
|
|
|
78
78
|
};
|
|
79
79
|
/** What an event's emit did. */
|
|
80
80
|
export interface Emitted {
|
|
81
|
-
/** Conversations it
|
|
81
|
+
/** Conversations it reached: each woken now, or as soon as its agent can take it. */
|
|
82
82
|
matched: number;
|
|
83
|
-
/**
|
|
83
|
+
/**
|
|
84
|
+
* A retry: an earlier emit, the same as this one, had its id, and this is
|
|
85
|
+
* that emit's result (nothing new was sent). The id on a different emit
|
|
86
|
+
* throws IdReusedError instead.
|
|
87
|
+
*/
|
|
84
88
|
duplicate: boolean;
|
|
85
|
-
/** User and native recipients with no live subscription it reached
|
|
89
|
+
/** User and native recipients with no live subscription it reached, whether `to` names one or many. */
|
|
86
90
|
unmatched: (string | Recipient)[];
|
|
87
91
|
/** Subscription recipients no longer live (or not that user's). */
|
|
88
92
|
ended: (string | Recipient)[];
|
|
@@ -220,7 +224,7 @@ export declare class Wakeshift {
|
|
|
220
224
|
* })
|
|
221
225
|
* await message.emit({ channel: "eng" }, { from: "ada", text: "shipped" })
|
|
222
226
|
*/
|
|
223
|
-
defineEvent<A extends AnySchema, P extends AnySchema>(name:
|
|
227
|
+
defineEvent<A extends AnySchema, P extends AnySchema, N extends string = string>(name: N, opts: EventOptions<A, P>): WakeEvent<A, P, N>;
|
|
224
228
|
/**
|
|
225
229
|
* Attaches Wakeshift to your MCP server, before you connect it: the one
|
|
226
230
|
* call that connects the two. Today it serves the defined events: MCP
|
package/dist/wakeshift.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { WakeshiftError } from "./errors.js";
|
|
1
|
+
import { IdReusedError, WakeshiftError } from "./errors.js";
|
|
2
2
|
import { v1Req } from "./host.js";
|
|
3
3
|
import { WakeEvent, attachEvents } from "./events.js";
|
|
4
4
|
import { parseKey, signAssertion, isTestKey } from "./key.js";
|
|
@@ -366,13 +366,20 @@ export class Wakeshift {
|
|
|
366
366
|
const seen = this.sends;
|
|
367
367
|
let out;
|
|
368
368
|
try {
|
|
369
|
-
|
|
369
|
+
try {
|
|
370
|
+
out = await this.request("POST", "/events/emit", body);
|
|
371
|
+
}
|
|
372
|
+
catch (err) {
|
|
373
|
+
if (!(err instanceof WakeshiftError && err.status === 404 && err.code === "unknown_event"))
|
|
374
|
+
throw err;
|
|
375
|
+
await this.resendManifest(seen);
|
|
376
|
+
out = await this.request("POST", "/events/emit", body);
|
|
377
|
+
}
|
|
370
378
|
}
|
|
371
379
|
catch (err) {
|
|
372
|
-
if (
|
|
373
|
-
throw err;
|
|
374
|
-
|
|
375
|
-
out = await this.request("POST", "/events/emit", body);
|
|
380
|
+
if (err instanceof WakeshiftError && err.status === 409 && err.code === "id_reused")
|
|
381
|
+
throw new IdReusedError(err.detail, { cause: err });
|
|
382
|
+
throw err;
|
|
376
383
|
}
|
|
377
384
|
return { matched: out.matched, duplicate: !!out.duplicate, unmatched: recipientsOf(out.unmatched), ended: recipientsOf(out.ended) };
|
|
378
385
|
}
|
package/dist/xmcp.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { AuthInfo, CallToolResult } from "./mcp.js";
|
|
2
2
|
import type { ZodRawShapeCompat } from "./zod.js";
|
|
3
3
|
import { BUILTIN_TOOLS, type BuiltinTool, type Identity } from "./events.js";
|
|
4
|
-
import { type ToolCall, type WakeArgs, type WakeInputs, type WrappedResult } from "./toolcall.js";
|
|
4
|
+
import { type AnyWakeEvent, type ToolCall, type ToolEventsOptions, type WakeArgs, type WakeInputs, type WrappedResult } from "./toolcall.js";
|
|
5
5
|
import type { Wakeshift } from "./wakeshift.js";
|
|
6
6
|
/** The request context xmcp passes a tool's handler, its second argument: what Wakeshift reads of it. */
|
|
7
7
|
export interface XmcpExtra {
|
|
@@ -59,8 +59,26 @@ export declare class XmcpAttached {
|
|
|
59
59
|
* a CallToolResult; the reply gets what Wakeshift adds for the
|
|
60
60
|
* conversation, and a call that fails ends the subscriptions it made. Its
|
|
61
61
|
* schema must come from attached.inputs.
|
|
62
|
+
*
|
|
63
|
+
* subscribes lists the events the tool subscribes to, as attach's
|
|
64
|
+
* attached.events takes it: call.subscribe takes only those. xmcp writes
|
|
65
|
+
* tools/list itself, so give the tool's metadata the same events with
|
|
66
|
+
* attached.describe.
|
|
62
67
|
*/
|
|
68
|
+
events<P extends Record<string, any> = Record<string, any>, const E extends readonly AnyWakeEvent[] = readonly AnyWakeEvent[]>(name: string, opts: ToolEventsOptions<E>, handler: (args: P, call: ToolCall<XmcpExtra, E[number]>) => WrappedResult | Promise<WrappedResult>): (args: P & WakeArgs, extra: XmcpExtra) => Promise<CallToolResult>;
|
|
63
69
|
events<P extends Record<string, any> = Record<string, any>>(name: string, handler: (args: P, call: ToolCall<XmcpExtra>) => WrappedResult | Promise<WrappedResult>): (args: P & WakeArgs, extra: XmcpExtra) => Promise<CallToolResult>;
|
|
70
|
+
/**
|
|
71
|
+
* A subscribing tool's description, for its tool file's metadata: your
|
|
72
|
+
* description, then the sentence attach's tools/list adds for the events
|
|
73
|
+
* the tool declares (their own descriptions: "This tool is how this app
|
|
74
|
+
* notifies you in this conversation of this event: …"). xmcp writes
|
|
75
|
+
* tools/list itself, so the sentence goes in the metadata, naming the
|
|
76
|
+
* app as app ("this app" if not given):
|
|
77
|
+
* `export const metadata = { name: "watch_ci", description: attached.describe("Watch CI on a repo.", { subscribes: [ciFinished], app: "CI bot" }) }`.
|
|
78
|
+
*/
|
|
79
|
+
describe(description: string, opts: ToolEventsOptions & {
|
|
80
|
+
app?: string;
|
|
81
|
+
}): string;
|
|
64
82
|
/** One of attach's own tools, for a tool file of its own (src/tools/<name>.ts): its schema, metadata and handler. */
|
|
65
83
|
tool(name: BuiltinTool): XmcpTool;
|
|
66
84
|
}
|
package/dist/xmcp.js
CHANGED
|
@@ -28,15 +28,15 @@
|
|
|
28
28
|
//
|
|
29
29
|
// // src/tools/watch_ci.ts
|
|
30
30
|
// export const schema = attached.inputs({ owner: z.string(), repo: z.string() })
|
|
31
|
-
// export const metadata = { name: "watch_ci", description: "Watch CI on a repo" }
|
|
32
|
-
// export default attached.events("watch_ci", async ({ owner, repo }, call) => { … })
|
|
31
|
+
// export const metadata = { name: "watch_ci", description: attached.describe("Watch CI on a repo.", { subscribes: [ciFinished] }) }
|
|
32
|
+
// export default attached.events("watch_ci", { subscribes: [ciFinished] }, async ({ owner, repo }, call) => { … })
|
|
33
33
|
//
|
|
34
34
|
// // src/tools/subscribe_events.ts (and the same for the other two)
|
|
35
35
|
// const tool = attached.tool("subscribe_events")
|
|
36
36
|
// export const schema = tool.schema
|
|
37
37
|
// export const metadata = tool.metadata
|
|
38
38
|
// export default tool.handler
|
|
39
|
-
import { BUILTIN_TOOLS, attachHost, checkAttach } from "./events.js";
|
|
39
|
+
import { BUILTIN_TOOLS, attachHost, checkAttach, withSubscribes } from "./events.js";
|
|
40
40
|
import { toolsOnlyHost, v1Req } from "./host.js";
|
|
41
41
|
import { WAKESHIFT_FIELD } from "./toolcall.js";
|
|
42
42
|
const CLIENT_INFO_META = "io.modelcontextprotocol/clientInfo";
|
|
@@ -66,16 +66,10 @@ export class XmcpAttached {
|
|
|
66
66
|
inputs(shape) {
|
|
67
67
|
return this.attached.inputs(shape);
|
|
68
68
|
}
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
* a CallToolResult; the reply gets what Wakeshift adds for the
|
|
74
|
-
* conversation, and a call that fails ends the subscriptions it made. Its
|
|
75
|
-
* schema must come from attached.inputs.
|
|
76
|
-
*/
|
|
77
|
-
events(name, handler) {
|
|
78
|
-
const cb = this.attached.events(name, handler);
|
|
69
|
+
events(name, optsOrHandler, maybeHandler) {
|
|
70
|
+
const cb = typeof optsOrHandler === "function"
|
|
71
|
+
? this.attached.events(name, optsOrHandler)
|
|
72
|
+
: this.attached.events(name, optsOrHandler, maybeHandler);
|
|
79
73
|
return async (args, extra) => {
|
|
80
74
|
const out = (await cb(args, extra));
|
|
81
75
|
// xmcp checks structuredContent against the tool's output schema after
|
|
@@ -89,6 +83,21 @@ export class XmcpAttached {
|
|
|
89
83
|
return out;
|
|
90
84
|
};
|
|
91
85
|
}
|
|
86
|
+
/**
|
|
87
|
+
* A subscribing tool's description, for its tool file's metadata: your
|
|
88
|
+
* description, then the sentence attach's tools/list adds for the events
|
|
89
|
+
* the tool declares (their own descriptions: "This tool is how this app
|
|
90
|
+
* notifies you in this conversation of this event: …"). xmcp writes
|
|
91
|
+
* tools/list itself, so the sentence goes in the metadata, naming the
|
|
92
|
+
* app as app ("this app" if not given):
|
|
93
|
+
* `export const metadata = { name: "watch_ci", description: attached.describe("Watch CI on a repo.", { subscribes: [ciFinished], app: "CI bot" }) }`.
|
|
94
|
+
*/
|
|
95
|
+
describe(description, opts) {
|
|
96
|
+
const list = opts?.subscribes;
|
|
97
|
+
if (!Array.isArray(list))
|
|
98
|
+
throw new Error("wakeshift: attached.describe(description, { subscribes }): subscribes lists the events the tool subscribes to");
|
|
99
|
+
return withSubscribes(description, list.map((e) => e.description), opts.app);
|
|
100
|
+
}
|
|
92
101
|
/** One of attach's own tools, for a tool file of its own (src/tools/<name>.ts): its schema, metadata and handler. */
|
|
93
102
|
tool(name) {
|
|
94
103
|
const t = this.own.get(name);
|
package/package.json
CHANGED