agents 0.0.0-f641104 → 0.0.0-f6c26e4

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.
Files changed (51) hide show
  1. package/README.md +24 -28
  2. package/dist/ai-chat-agent.d.ts +51 -4
  3. package/dist/ai-chat-agent.js +179 -78
  4. package/dist/ai-chat-agent.js.map +1 -1
  5. package/dist/ai-react.d.ts +18 -5
  6. package/dist/ai-react.js +62 -48
  7. package/dist/ai-react.js.map +1 -1
  8. package/dist/ai-types.d.ts +5 -0
  9. package/dist/chunk-5YIRLLUX.js +1264 -0
  10. package/dist/chunk-5YIRLLUX.js.map +1 -0
  11. package/dist/chunk-KUH345EY.js +116 -0
  12. package/dist/chunk-KUH345EY.js.map +1 -0
  13. package/dist/chunk-MW5BQ2FW.js +469 -0
  14. package/dist/chunk-MW5BQ2FW.js.map +1 -0
  15. package/dist/chunk-PVQZBKN7.js +106 -0
  16. package/dist/chunk-PVQZBKN7.js.map +1 -0
  17. package/dist/client.d.ts +16 -2
  18. package/dist/client.js +6 -133
  19. package/dist/client.js.map +1 -1
  20. package/dist/index-BIJvkfYt.d.ts +614 -0
  21. package/dist/index.d.ts +37 -300
  22. package/dist/index.js +12 -4
  23. package/dist/mcp/client.d.ts +1055 -0
  24. package/dist/mcp/client.js +9 -0
  25. package/dist/mcp/do-oauth-client-provider.d.ts +41 -0
  26. package/dist/mcp/do-oauth-client-provider.js +7 -0
  27. package/dist/mcp/do-oauth-client-provider.js.map +1 -0
  28. package/dist/mcp/index.d.ts +84 -0
  29. package/dist/mcp/index.js +783 -0
  30. package/dist/mcp/index.js.map +1 -0
  31. package/dist/observability/index.d.ts +12 -0
  32. package/dist/observability/index.js +10 -0
  33. package/dist/observability/index.js.map +1 -0
  34. package/dist/react.d.ts +85 -5
  35. package/dist/react.js +50 -31
  36. package/dist/react.js.map +1 -1
  37. package/dist/schedule.d.ts +6 -6
  38. package/dist/schedule.js +4 -6
  39. package/dist/schedule.js.map +1 -1
  40. package/dist/serializable.d.ts +32 -0
  41. package/dist/serializable.js +1 -0
  42. package/dist/serializable.js.map +1 -0
  43. package/package.json +84 -52
  44. package/src/index.ts +1172 -182
  45. package/dist/chunk-HMLY7DHA.js +0 -16
  46. package/dist/chunk-X6BBKLSC.js +0 -568
  47. package/dist/chunk-X6BBKLSC.js.map +0 -1
  48. package/dist/mcp.d.ts +0 -58
  49. package/dist/mcp.js +0 -945
  50. package/dist/mcp.js.map +0 -1
  51. /package/dist/{chunk-HMLY7DHA.js.map → mcp/client.js.map} +0 -0
package/src/index.ts CHANGED
@@ -1,19 +1,32 @@
1
+ import { AsyncLocalStorage } from "node:async_hooks";
2
+ import type { Client } from "@modelcontextprotocol/sdk/client/index.js";
3
+ import type { SSEClientTransportOptions } from "@modelcontextprotocol/sdk/client/sse.js";
4
+
5
+ import type {
6
+ Prompt,
7
+ Resource,
8
+ ServerCapabilities,
9
+ Tool
10
+ } from "@modelcontextprotocol/sdk/types.js";
11
+ import { parseCronExpression } from "cron-schedule";
12
+ import { nanoid } from "nanoid";
13
+ import { EmailMessage } from "cloudflare:email";
1
14
  import {
2
- Server,
3
- routePartykitRequest,
4
- type PartyServerOptions,
5
- getServerByName,
6
15
  type Connection,
7
16
  type ConnectionContext,
17
+ type PartyServerOptions,
18
+ Server,
8
19
  type WSMessage,
20
+ getServerByName,
21
+ routePartykitRequest
9
22
  } from "partyserver";
23
+ import { camelCaseToKebabCase } from "./client";
24
+ import { MCPClientManager } from "./mcp/client";
25
+ // import type { MCPClientConnection } from "./mcp/client-connection";
26
+ import { DurableObjectOAuthClientProvider } from "./mcp/do-oauth-client-provider";
27
+ import { genericObservability, type Observability } from "./observability";
10
28
 
11
- import { parseCronExpression } from "cron-schedule";
12
- import { nanoid } from "nanoid";
13
-
14
- export type { Connection, WSMessage, ConnectionContext } from "partyserver";
15
-
16
- import { WorkflowEntrypoint as CFWorkflowEntrypoint } from "cloudflare:workers";
29
+ export type { Connection, ConnectionContext, WSMessage } from "partyserver";
17
30
 
18
31
  /**
19
32
  * RPC request message from client
@@ -97,7 +110,6 @@ export type CallableMetadata = {
97
110
  streaming?: boolean;
98
111
  };
99
112
 
100
- // biome-ignore lint/complexity/noBannedTypes: <explanation>
101
113
  const callableMetadata = new Map<Function, CallableMetadata>();
102
114
 
103
115
  /**
@@ -107,6 +119,7 @@ const callableMetadata = new Map<Function, CallableMetadata>();
107
119
  export function unstable_callable(metadata: CallableMetadata = {}) {
108
120
  return function callableDecorator<This, Args extends unknown[], Return>(
109
121
  target: (this: This, ...args: Args) => Return,
122
+ // biome-ignore lint/correctness/noUnusedFunctionParameters: later
110
123
  context: ClassMethodDecoratorContext
111
124
  ) {
112
125
  if (!callableMetadata.has(target)) {
@@ -117,10 +130,12 @@ export function unstable_callable(metadata: CallableMetadata = {}) {
117
130
  };
118
131
  }
119
132
 
120
- /**
121
- * A class for creating workflow entry points that can be used with Cloudflare Workers
122
- */
123
- export class WorkflowEntrypoint extends CFWorkflowEntrypoint {}
133
+ export type QueueItem<T = string> = {
134
+ id: string;
135
+ payload: T;
136
+ callback: keyof Agent<unknown>;
137
+ created_at: number;
138
+ };
124
139
 
125
140
  /**
126
141
  * Represents a scheduled task within an Agent
@@ -163,18 +178,118 @@ function getNextCronTime(cron: string) {
163
178
  return interval.getNextDate();
164
179
  }
165
180
 
181
+ /**
182
+ * MCP Server state update message from server -> Client
183
+ */
184
+ export type MCPServerMessage = {
185
+ type: "cf_agent_mcp_servers";
186
+ mcp: MCPServersState;
187
+ };
188
+
189
+ export type MCPServersState = {
190
+ servers: {
191
+ [id: string]: MCPServer;
192
+ };
193
+ tools: Tool[];
194
+ prompts: Prompt[];
195
+ resources: Resource[];
196
+ };
197
+
198
+ export type MCPServer = {
199
+ name: string;
200
+ server_url: string;
201
+ auth_url: string | null;
202
+ // This state is specifically about the temporary process of getting a token (if needed).
203
+ // Scope outside of that can't be relied upon because when the DO sleeps, there's no way
204
+ // to communicate a change to a non-ready state.
205
+ state: "authenticating" | "connecting" | "ready" | "discovering" | "failed";
206
+ instructions: string | null;
207
+ capabilities: ServerCapabilities | null;
208
+ };
209
+
210
+ /**
211
+ * MCP Server data stored in DO SQL for resuming MCP Server connections
212
+ */
213
+ type MCPServerRow = {
214
+ id: string;
215
+ name: string;
216
+ server_url: string;
217
+ client_id: string | null;
218
+ auth_url: string | null;
219
+ callback_url: string;
220
+ server_options: string;
221
+ };
222
+
166
223
  const STATE_ROW_ID = "cf_state_row_id";
167
224
  const STATE_WAS_CHANGED = "cf_state_was_changed";
168
225
 
169
226
  const DEFAULT_STATE = {} as unknown;
170
227
 
228
+ const agentContext = new AsyncLocalStorage<{
229
+ agent: Agent<unknown, unknown>;
230
+ connection: Connection | undefined;
231
+ request: Request | undefined;
232
+ email: AgentEmail | undefined;
233
+ }>();
234
+
235
+ export function getCurrentAgent<
236
+ T extends Agent<unknown, unknown> = Agent<unknown, unknown>
237
+ >(): {
238
+ agent: T | undefined;
239
+ connection: Connection | undefined;
240
+ request: Request | undefined;
241
+ email: AgentEmail | undefined;
242
+ } {
243
+ const store = agentContext.getStore() as
244
+ | {
245
+ agent: T;
246
+ connection: Connection | undefined;
247
+ request: Request | undefined;
248
+ email: AgentEmail | undefined;
249
+ }
250
+ | undefined;
251
+ if (!store) {
252
+ return {
253
+ agent: undefined,
254
+ connection: undefined,
255
+ request: undefined,
256
+ email: undefined
257
+ };
258
+ }
259
+ return store;
260
+ }
261
+
262
+ /**
263
+ * Wraps a method to run within the agent context, ensuring getCurrentAgent() works properly
264
+ * @param agent The agent instance
265
+ * @param method The method to wrap
266
+ * @returns A wrapped method that runs within the agent context
267
+ */
268
+
269
+ // biome-ignore lint/suspicious/noExplicitAny: I can't typescript
270
+ function withAgentContext<T extends (...args: any[]) => any>(
271
+ method: T
272
+ ): (this: Agent<unknown, unknown>, ...args: Parameters<T>) => ReturnType<T> {
273
+ return function (...args: Parameters<T>): ReturnType<T> {
274
+ const { connection, request, email } = getCurrentAgent();
275
+ return agentContext.run({ agent: this, connection, request, email }, () => {
276
+ return method.apply(this, args);
277
+ });
278
+ };
279
+ }
280
+
171
281
  /**
172
282
  * Base class for creating Agent implementations
173
283
  * @template Env Environment type containing bindings
174
284
  * @template State State type to store within the Agent
175
285
  */
176
286
  export class Agent<Env, State = unknown> extends Server<Env> {
177
- #state = DEFAULT_STATE as State;
287
+ private _state = DEFAULT_STATE as State;
288
+
289
+ private _ParentClass: typeof Agent<Env, State> =
290
+ Object.getPrototypeOf(this).constructor;
291
+
292
+ mcp: MCPClientManager = new MCPClientManager(this._ParentClass.name, "0.0.1");
178
293
 
179
294
  /**
180
295
  * Initial state for the Agent
@@ -186,9 +301,9 @@ export class Agent<Env, State = unknown> extends Server<Env> {
186
301
  * Current state of the Agent
187
302
  */
188
303
  get state(): State {
189
- if (this.#state !== DEFAULT_STATE) {
304
+ if (this._state !== DEFAULT_STATE) {
190
305
  // state was previously set, and populated internal state
191
- return this.#state;
306
+ return this._state;
192
307
  }
193
308
  // looks like this is the first time the state is being accessed
194
309
  // check if the state was set in a previous life
@@ -208,8 +323,8 @@ export class Agent<Env, State = unknown> extends Server<Env> {
208
323
  ) {
209
324
  const state = result[0]?.state as string; // could be null?
210
325
 
211
- this.#state = JSON.parse(state);
212
- return this.#state;
326
+ this._state = JSON.parse(state);
327
+ return this._state;
213
328
  }
214
329
 
215
330
  // ok, this is the first time the state is being accessed
@@ -230,9 +345,14 @@ export class Agent<Env, State = unknown> extends Server<Env> {
230
345
  */
231
346
  static options = {
232
347
  /** Whether the Agent should hibernate when inactive */
233
- hibernate: true, // default to hibernate
348
+ hibernate: true // default to hibernate
234
349
  };
235
350
 
351
+ /**
352
+ * The observability implementation to use for the Agent
353
+ */
354
+ observability?: Observability = genericObservability;
355
+
236
356
  /**
237
357
  * Execute SQL queries against the Agent's database
238
358
  * @template T Type of the returned rows
@@ -262,6 +382,9 @@ export class Agent<Env, State = unknown> extends Server<Env> {
262
382
  constructor(ctx: AgentContext, env: Env) {
263
383
  super(ctx, env);
264
384
 
385
+ // Auto-wrap custom methods with agent context
386
+ this._autoWrapCustomMethods();
387
+
265
388
  this.sql`
266
389
  CREATE TABLE IF NOT EXISTS cf_agents_state (
267
390
  id TEXT PRIMARY KEY NOT NULL,
@@ -269,8 +392,17 @@ export class Agent<Env, State = unknown> extends Server<Env> {
269
392
  )
270
393
  `;
271
394
 
395
+ this.sql`
396
+ CREATE TABLE IF NOT EXISTS cf_agents_queues (
397
+ id TEXT PRIMARY KEY NOT NULL,
398
+ payload TEXT,
399
+ callback TEXT,
400
+ created_at INTEGER DEFAULT (unixepoch())
401
+ )
402
+ `;
403
+
272
404
  void this.ctx.blockConcurrencyWhile(async () => {
273
- return this.#tryCatch(async () => {
405
+ return this._tryCatch(async () => {
274
406
  // Create alarms table if it doesn't exist
275
407
  this.sql`
276
408
  CREATE TABLE IF NOT EXISTS cf_agents_schedules (
@@ -290,96 +422,232 @@ export class Agent<Env, State = unknown> extends Server<Env> {
290
422
  });
291
423
  });
292
424
 
293
- const _onMessage = this.onMessage.bind(this);
294
- this.onMessage = async (connection: Connection, message: WSMessage) => {
295
- if (typeof message !== "string") {
296
- return this.#tryCatch(() => _onMessage(connection, message));
297
- }
298
-
299
- let parsed: unknown;
300
- try {
301
- parsed = JSON.parse(message);
302
- } catch (e) {
303
- // silently fail and let the onMessage handler handle it
304
- return this.#tryCatch(() => _onMessage(connection, message));
305
- }
425
+ this.sql`
426
+ CREATE TABLE IF NOT EXISTS cf_agents_mcp_servers (
427
+ id TEXT PRIMARY KEY NOT NULL,
428
+ name TEXT NOT NULL,
429
+ server_url TEXT NOT NULL,
430
+ callback_url TEXT NOT NULL,
431
+ client_id TEXT,
432
+ auth_url TEXT,
433
+ server_options TEXT
434
+ )
435
+ `;
306
436
 
307
- if (isStateUpdateMessage(parsed)) {
308
- this.#setStateInternal(parsed.state as State, connection);
309
- return;
310
- }
437
+ const _onRequest = this.onRequest.bind(this);
438
+ this.onRequest = (request: Request) => {
439
+ return agentContext.run(
440
+ { agent: this, connection: undefined, request, email: undefined },
441
+ async () => {
442
+ if (this.mcp.isCallbackRequest(request)) {
443
+ await this.mcp.handleCallbackRequest(request);
444
+
445
+ // after the MCP connection handshake, we can send updated mcp state
446
+ this.broadcast(
447
+ JSON.stringify({
448
+ mcp: this.getMcpServers(),
449
+ type: "cf_agent_mcp_servers"
450
+ })
451
+ );
452
+
453
+ // We probably should let the user configure this response/redirect, but this is fine for now.
454
+ return new Response("<script>window.close();</script>", {
455
+ headers: { "content-type": "text/html" },
456
+ status: 200
457
+ });
458
+ }
311
459
 
312
- if (isRPCRequest(parsed)) {
313
- try {
314
- const { id, method, args } = parsed;
460
+ return this._tryCatch(() => _onRequest(request));
461
+ }
462
+ );
463
+ };
315
464
 
316
- // Check if method exists and is callable
317
- const methodFn = this[method as keyof this];
318
- if (typeof methodFn !== "function") {
319
- throw new Error(`Method ${method} does not exist`);
465
+ const _onMessage = this.onMessage.bind(this);
466
+ this.onMessage = async (connection: Connection, message: WSMessage) => {
467
+ return agentContext.run(
468
+ { agent: this, connection, request: undefined, email: undefined },
469
+ async () => {
470
+ if (typeof message !== "string") {
471
+ return this._tryCatch(() => _onMessage(connection, message));
320
472
  }
321
473
 
322
- if (!this.#isCallable(method)) {
323
- throw new Error(`Method ${method} is not callable`);
474
+ let parsed: unknown;
475
+ try {
476
+ parsed = JSON.parse(message);
477
+ } catch (_e) {
478
+ // silently fail and let the onMessage handler handle it
479
+ return this._tryCatch(() => _onMessage(connection, message));
324
480
  }
325
481
 
326
- // biome-ignore lint/complexity/noBannedTypes: <explanation>
327
- const metadata = callableMetadata.get(methodFn as Function);
482
+ if (isStateUpdateMessage(parsed)) {
483
+ this._setStateInternal(parsed.state as State, connection);
484
+ return;
485
+ }
328
486
 
329
- // For streaming methods, pass a StreamingResponse object
330
- if (metadata?.streaming) {
331
- const stream = new StreamingResponse(connection, id);
332
- await methodFn.apply(this, [stream, ...args]);
487
+ if (isRPCRequest(parsed)) {
488
+ try {
489
+ const { id, method, args } = parsed;
490
+
491
+ // Check if method exists and is callable
492
+ const methodFn = this[method as keyof this];
493
+ if (typeof methodFn !== "function") {
494
+ throw new Error(`Method ${method} does not exist`);
495
+ }
496
+
497
+ if (!this._isCallable(method)) {
498
+ throw new Error(`Method ${method} is not callable`);
499
+ }
500
+
501
+ const metadata = callableMetadata.get(methodFn as Function);
502
+
503
+ // For streaming methods, pass a StreamingResponse object
504
+ if (metadata?.streaming) {
505
+ const stream = new StreamingResponse(connection, id);
506
+ await methodFn.apply(this, [stream, ...args]);
507
+ return;
508
+ }
509
+
510
+ // For regular methods, execute and send response
511
+ const result = await methodFn.apply(this, args);
512
+
513
+ this.observability?.emit(
514
+ {
515
+ displayMessage: `RPC call to ${method}`,
516
+ id: nanoid(),
517
+ payload: {
518
+ args,
519
+ method,
520
+ streaming: metadata?.streaming,
521
+ success: true
522
+ },
523
+ timestamp: Date.now(),
524
+ type: "rpc"
525
+ },
526
+ this.ctx
527
+ );
528
+
529
+ const response: RPCResponse = {
530
+ done: true,
531
+ id,
532
+ result,
533
+ success: true,
534
+ type: "rpc"
535
+ };
536
+ connection.send(JSON.stringify(response));
537
+ } catch (e) {
538
+ // Send error response
539
+ const response: RPCResponse = {
540
+ error:
541
+ e instanceof Error ? e.message : "Unknown error occurred",
542
+ id: parsed.id,
543
+ success: false,
544
+ type: "rpc"
545
+ };
546
+ connection.send(JSON.stringify(response));
547
+ console.error("RPC error:", e);
548
+ }
333
549
  return;
334
550
  }
335
551
 
336
- // For regular methods, execute and send response
337
- const result = await methodFn.apply(this, args);
338
- const response: RPCResponse = {
339
- type: "rpc",
340
- id,
341
- success: true,
342
- result,
343
- done: true,
344
- };
345
- connection.send(JSON.stringify(response));
346
- } catch (e) {
347
- // Send error response
348
- const response: RPCResponse = {
349
- type: "rpc",
350
- id: parsed.id,
351
- success: false,
352
- error: e instanceof Error ? e.message : "Unknown error occurred",
353
- };
354
- connection.send(JSON.stringify(response));
355
- console.error("RPC error:", e);
552
+ return this._tryCatch(() => _onMessage(connection, message));
356
553
  }
357
- return;
358
- }
359
-
360
- return this.#tryCatch(() => _onMessage(connection, message));
554
+ );
361
555
  };
362
556
 
363
557
  const _onConnect = this.onConnect.bind(this);
364
558
  this.onConnect = (connection: Connection, ctx: ConnectionContext) => {
365
559
  // TODO: This is a hack to ensure the state is sent after the connection is established
366
560
  // must fix this
367
- setTimeout(() => {
368
- if (this.state) {
369
- connection.send(
370
- JSON.stringify({
371
- type: "cf_agent_state",
372
- state: this.state,
373
- })
374
- );
561
+ return agentContext.run(
562
+ { agent: this, connection, request: ctx.request, email: undefined },
563
+ async () => {
564
+ setTimeout(() => {
565
+ if (this.state) {
566
+ connection.send(
567
+ JSON.stringify({
568
+ state: this.state,
569
+ type: "cf_agent_state"
570
+ })
571
+ );
572
+ }
573
+
574
+ connection.send(
575
+ JSON.stringify({
576
+ mcp: this.getMcpServers(),
577
+ type: "cf_agent_mcp_servers"
578
+ })
579
+ );
580
+
581
+ this.observability?.emit(
582
+ {
583
+ displayMessage: "Connection established",
584
+ id: nanoid(),
585
+ payload: {
586
+ connectionId: connection.id
587
+ },
588
+ timestamp: Date.now(),
589
+ type: "connect"
590
+ },
591
+ this.ctx
592
+ );
593
+ return this._tryCatch(() => _onConnect(connection, ctx));
594
+ }, 20);
595
+ }
596
+ );
597
+ };
598
+
599
+ const _onStart = this.onStart.bind(this);
600
+ this.onStart = async () => {
601
+ return agentContext.run(
602
+ {
603
+ agent: this,
604
+ connection: undefined,
605
+ request: undefined,
606
+ email: undefined
607
+ },
608
+ async () => {
609
+ const servers = this.sql<MCPServerRow>`
610
+ SELECT id, name, server_url, client_id, auth_url, callback_url, server_options FROM cf_agents_mcp_servers;
611
+ `;
612
+
613
+ // from DO storage, reconnect to all servers not currently in the oauth flow using our saved auth information
614
+ if (servers && Array.isArray(servers) && servers.length > 0) {
615
+ Promise.allSettled(
616
+ servers.map((server) => {
617
+ return this._connectToMcpServerInternal(
618
+ server.name,
619
+ server.server_url,
620
+ server.callback_url,
621
+ server.server_options
622
+ ? JSON.parse(server.server_options)
623
+ : undefined,
624
+ {
625
+ id: server.id,
626
+ oauthClientId: server.client_id ?? undefined
627
+ }
628
+ );
629
+ })
630
+ ).then((_results) => {
631
+ this.broadcast(
632
+ JSON.stringify({
633
+ mcp: this.getMcpServers(),
634
+ type: "cf_agent_mcp_servers"
635
+ })
636
+ );
637
+ });
638
+ }
639
+ await this._tryCatch(() => _onStart());
375
640
  }
376
- return this.#tryCatch(() => _onConnect(connection, ctx));
377
- }, 20);
641
+ );
378
642
  };
379
643
  }
380
644
 
381
- #setStateInternal(state: State, source: Connection | "server" = "server") {
382
- this.#state = state;
645
+ private _setStateInternal(
646
+ state: State,
647
+ source: Connection | "server" = "server"
648
+ ) {
649
+ const previousState = this._state;
650
+ this._state = state;
383
651
  this.sql`
384
652
  INSERT OR REPLACE INTO cf_agents_state (id, state)
385
653
  VALUES (${STATE_ROW_ID}, ${JSON.stringify(state)})
@@ -390,12 +658,33 @@ export class Agent<Env, State = unknown> extends Server<Env> {
390
658
  `;
391
659
  this.broadcast(
392
660
  JSON.stringify({
393
- type: "cf_agent_state",
394
661
  state: state,
662
+ type: "cf_agent_state"
395
663
  }),
396
664
  source !== "server" ? [source.id] : []
397
665
  );
398
- return this.#tryCatch(() => this.onStateUpdate(state, source));
666
+ return this._tryCatch(() => {
667
+ const { connection, request, email } = agentContext.getStore() || {};
668
+ return agentContext.run(
669
+ { agent: this, connection, request, email },
670
+ async () => {
671
+ this.observability?.emit(
672
+ {
673
+ displayMessage: "State updated",
674
+ id: nanoid(),
675
+ payload: {
676
+ previousState,
677
+ state
678
+ },
679
+ timestamp: Date.now(),
680
+ type: "state:update"
681
+ },
682
+ this.ctx
683
+ );
684
+ return this.onStateUpdate(state, source);
685
+ }
686
+ );
687
+ });
399
688
  }
400
689
 
401
690
  /**
@@ -403,7 +692,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
403
692
  * @param state New state to set
404
693
  */
405
694
  setState(state: State) {
406
- this.#setStateInternal(state, "server");
695
+ this._setStateInternal(state, "server");
407
696
  }
408
697
 
409
698
  /**
@@ -411,19 +700,90 @@ export class Agent<Env, State = unknown> extends Server<Env> {
411
700
  * @param state Updated state
412
701
  * @param source Source of the state update ("server" or a client connection)
413
702
  */
703
+ // biome-ignore lint/correctness/noUnusedFunctionParameters: overridden later
414
704
  onStateUpdate(state: State | undefined, source: Connection | "server") {
415
705
  // override this to handle state updates
416
706
  }
417
707
 
418
708
  /**
419
- * Called when the Agent receives an email
709
+ * Called when the Agent receives an email via routeAgentEmail()
710
+ * Override this method to handle incoming emails
420
711
  * @param email Email message to process
421
712
  */
422
- onEmail(email: ForwardableEmailMessage) {
423
- throw new Error("Not implemented");
713
+ async _onEmail(email: AgentEmail) {
714
+ // nb: we use this roundabout way of getting to onEmail
715
+ // because of https://github.com/cloudflare/workerd/issues/4499
716
+ return agentContext.run(
717
+ { agent: this, connection: undefined, request: undefined, email: email },
718
+ async () => {
719
+ if ("onEmail" in this && typeof this.onEmail === "function") {
720
+ return this._tryCatch(() =>
721
+ (this.onEmail as (email: AgentEmail) => Promise<void>)(email)
722
+ );
723
+ } else {
724
+ console.log("Received email from:", email.from, "to:", email.to);
725
+ console.log("Subject:", email.headers.get("subject"));
726
+ console.log(
727
+ "Implement onEmail(email: AgentEmail): Promise<void> in your agent to process emails"
728
+ );
729
+ }
730
+ }
731
+ );
732
+ }
733
+
734
+ /**
735
+ * Reply to an email
736
+ * @param email The email to reply to
737
+ * @param options Options for the reply
738
+ * @returns void
739
+ */
740
+ async replyToEmail(
741
+ email: AgentEmail,
742
+ options: {
743
+ fromName: string;
744
+ subject?: string | undefined;
745
+ body: string;
746
+ contentType?: string;
747
+ headers?: Record<string, string>;
748
+ }
749
+ ): Promise<void> {
750
+ return this._tryCatch(async () => {
751
+ const agentName = camelCaseToKebabCase(this._ParentClass.name);
752
+ const agentId = this.name;
753
+
754
+ const { createMimeMessage } = await import("mimetext");
755
+ const msg = createMimeMessage();
756
+ msg.setSender({ addr: email.to, name: options.fromName });
757
+ msg.setRecipient(email.from);
758
+ msg.setSubject(
759
+ options.subject || `Re: ${email.headers.get("subject")}` || "No subject"
760
+ );
761
+ msg.addMessage({
762
+ contentType: options.contentType || "text/plain",
763
+ data: options.body
764
+ });
765
+
766
+ const domain = email.from.split("@")[1];
767
+ const messageId = `<${agentId}@${domain}>`;
768
+ msg.setHeader("In-Reply-To", email.headers.get("Message-ID")!);
769
+ msg.setHeader("Message-ID", messageId);
770
+ msg.setHeader("X-Agent-Name", agentName);
771
+ msg.setHeader("X-Agent-ID", agentId);
772
+
773
+ if (options.headers) {
774
+ for (const [key, value] of Object.entries(options.headers)) {
775
+ msg.setHeader(key, value);
776
+ }
777
+ }
778
+ await email.reply({
779
+ from: email.to,
780
+ raw: msg.asRaw(),
781
+ to: email.from
782
+ });
783
+ });
424
784
  }
425
785
 
426
- async #tryCatch<T>(fn: () => T | Promise<T>) {
786
+ private async _tryCatch<T>(fn: () => T | Promise<T>) {
427
787
  try {
428
788
  return await fn();
429
789
  } catch (e) {
@@ -431,6 +791,72 @@ export class Agent<Env, State = unknown> extends Server<Env> {
431
791
  }
432
792
  }
433
793
 
794
+ /**
795
+ * Automatically wrap custom methods with agent context
796
+ * This ensures getCurrentAgent() works in all custom methods without decorators
797
+ */
798
+ private _autoWrapCustomMethods() {
799
+ // Collect all methods from base prototypes (Agent and Server)
800
+ const basePrototypes = [Agent.prototype, Server.prototype];
801
+ const baseMethods = new Set<string>();
802
+ for (const baseProto of basePrototypes) {
803
+ let proto = baseProto;
804
+ while (proto && proto !== Object.prototype) {
805
+ const methodNames = Object.getOwnPropertyNames(proto);
806
+ for (const methodName of methodNames) {
807
+ baseMethods.add(methodName);
808
+ }
809
+ proto = Object.getPrototypeOf(proto);
810
+ }
811
+ }
812
+ // Get all methods from the current instance's prototype chain
813
+ let proto = Object.getPrototypeOf(this);
814
+ let depth = 0;
815
+ while (proto && proto !== Object.prototype && depth < 10) {
816
+ const methodNames = Object.getOwnPropertyNames(proto);
817
+ for (const methodName of methodNames) {
818
+ // Skip if it's a private method or not a function
819
+ if (
820
+ baseMethods.has(methodName) ||
821
+ methodName.startsWith("_") ||
822
+ typeof this[methodName as keyof this] !== "function"
823
+ ) {
824
+ continue;
825
+ }
826
+ // If the method doesn't exist in base prototypes, it's a custom method
827
+ if (!baseMethods.has(methodName)) {
828
+ const descriptor = Object.getOwnPropertyDescriptor(proto, methodName);
829
+ if (descriptor && typeof descriptor.value === "function") {
830
+ // Wrap the custom method with context
831
+
832
+ const wrappedFunction = withAgentContext(
833
+ // biome-ignore lint/suspicious/noExplicitAny: I can't typescript
834
+ this[methodName as keyof this] as (...args: any[]) => any
835
+ // biome-ignore lint/suspicious/noExplicitAny: I can't typescript
836
+ ) as any;
837
+
838
+ // if the method is callable, copy the metadata from the original method
839
+ if (this._isCallable(methodName)) {
840
+ callableMetadata.set(
841
+ wrappedFunction,
842
+ callableMetadata.get(
843
+ this[methodName as keyof this] as Function
844
+ )!
845
+ );
846
+ }
847
+
848
+ // set the wrapped function on the prototype
849
+ this.constructor.prototype[methodName as keyof this] =
850
+ wrappedFunction;
851
+ }
852
+ }
853
+ }
854
+
855
+ proto = Object.getPrototypeOf(proto);
856
+ depth++;
857
+ }
858
+ }
859
+
434
860
  override onError(
435
861
  connection: Connection,
436
862
  error: unknown
@@ -465,6 +891,135 @@ export class Agent<Env, State = unknown> extends Server<Env> {
465
891
  throw new Error("Not implemented");
466
892
  }
467
893
 
894
+ /**
895
+ * Queue a task to be executed in the future
896
+ * @param payload Payload to pass to the callback
897
+ * @param callback Name of the method to call
898
+ * @returns The ID of the queued task
899
+ */
900
+ async queue<T = unknown>(callback: keyof this, payload: T): Promise<string> {
901
+ const id = nanoid(9);
902
+ if (typeof callback !== "string") {
903
+ throw new Error("Callback must be a string");
904
+ }
905
+
906
+ if (typeof this[callback] !== "function") {
907
+ throw new Error(`this.${callback} is not a function`);
908
+ }
909
+
910
+ this.sql`
911
+ INSERT OR REPLACE INTO cf_agents_queues (id, payload, callback)
912
+ VALUES (${id}, ${JSON.stringify(payload)}, ${callback})
913
+ `;
914
+
915
+ void this._flushQueue().catch((e) => {
916
+ console.error("Error flushing queue:", e);
917
+ });
918
+
919
+ return id;
920
+ }
921
+
922
+ private _flushingQueue = false;
923
+
924
+ private async _flushQueue() {
925
+ if (this._flushingQueue) {
926
+ return;
927
+ }
928
+ this._flushingQueue = true;
929
+ while (true) {
930
+ const executed: string[] = [];
931
+ const result = this.sql<QueueItem<string>>`
932
+ SELECT * FROM cf_agents_queues
933
+ ORDER BY created_at ASC
934
+ `;
935
+
936
+ if (!result || result.length === 0) {
937
+ break;
938
+ }
939
+
940
+ for (const row of result || []) {
941
+ const callback = this[row.callback as keyof Agent<Env>];
942
+ if (!callback) {
943
+ console.error(`callback ${row.callback} not found`);
944
+ continue;
945
+ }
946
+ const { connection, request, email } = agentContext.getStore() || {};
947
+ await agentContext.run(
948
+ {
949
+ agent: this,
950
+ connection,
951
+ request,
952
+ email
953
+ },
954
+ async () => {
955
+ // TODO: add retries and backoff
956
+ await (
957
+ callback as (
958
+ payload: unknown,
959
+ queueItem: QueueItem<string>
960
+ ) => Promise<void>
961
+ ).bind(this)(JSON.parse(row.payload as string), row);
962
+ executed.push(row.id);
963
+ }
964
+ );
965
+ }
966
+ for (const id of executed) {
967
+ await this.dequeue(id);
968
+ }
969
+ }
970
+ this._flushingQueue = false;
971
+ }
972
+
973
+ /**
974
+ * Dequeue a task by ID
975
+ * @param id ID of the task to dequeue
976
+ */
977
+ async dequeue(id: string) {
978
+ this.sql`DELETE FROM cf_agents_queues WHERE id = ${id}`;
979
+ }
980
+
981
+ /**
982
+ * Dequeue all tasks
983
+ */
984
+ async dequeueAll() {
985
+ this.sql`DELETE FROM cf_agents_queues`;
986
+ }
987
+
988
+ /**
989
+ * Dequeue all tasks by callback
990
+ * @param callback Name of the callback to dequeue
991
+ */
992
+ async dequeueAllByCallback(callback: string) {
993
+ this.sql`DELETE FROM cf_agents_queues WHERE callback = ${callback}`;
994
+ }
995
+
996
+ /**
997
+ * Get a queued task by ID
998
+ * @param id ID of the task to get
999
+ * @returns The task or undefined if not found
1000
+ */
1001
+ async getQueue(id: string): Promise<QueueItem<string> | undefined> {
1002
+ const result = this.sql<QueueItem<string>>`
1003
+ SELECT * FROM cf_agents_queues WHERE id = ${id}
1004
+ `;
1005
+ return result
1006
+ ? { ...result[0], payload: JSON.parse(result[0].payload) }
1007
+ : undefined;
1008
+ }
1009
+
1010
+ /**
1011
+ * Get all queues by key and value
1012
+ * @param key Key to filter by
1013
+ * @param value Value to filter by
1014
+ * @returns Array of matching QueueItem objects
1015
+ */
1016
+ async getQueues(key: string, value: string): Promise<QueueItem<string>[]> {
1017
+ const result = this.sql<QueueItem<string>>`
1018
+ SELECT * FROM cf_agents_queues
1019
+ `;
1020
+ return result.filter((row) => JSON.parse(row.payload)[key] === value);
1021
+ }
1022
+
468
1023
  /**
469
1024
  * Schedule a task to be executed in the future
470
1025
  * @template T Type of the payload data
@@ -480,6 +1035,18 @@ export class Agent<Env, State = unknown> extends Server<Env> {
480
1035
  ): Promise<Schedule<T>> {
481
1036
  const id = nanoid(9);
482
1037
 
1038
+ const emitScheduleCreate = (schedule: Schedule<T>) =>
1039
+ this.observability?.emit(
1040
+ {
1041
+ displayMessage: `Schedule ${schedule.id} created`,
1042
+ id: nanoid(),
1043
+ payload: schedule,
1044
+ timestamp: Date.now(),
1045
+ type: "schedule:create"
1046
+ },
1047
+ this.ctx
1048
+ );
1049
+
483
1050
  if (typeof callback !== "string") {
484
1051
  throw new Error("Callback must be a string");
485
1052
  }
@@ -497,15 +1064,19 @@ export class Agent<Env, State = unknown> extends Server<Env> {
497
1064
  )}, 'scheduled', ${timestamp})
498
1065
  `;
499
1066
 
500
- await this.#scheduleNextAlarm();
1067
+ await this._scheduleNextAlarm();
501
1068
 
502
- return {
503
- id,
1069
+ const schedule: Schedule<T> = {
504
1070
  callback: callback,
1071
+ id,
505
1072
  payload: payload as T,
506
1073
  time: timestamp,
507
- type: "scheduled",
1074
+ type: "scheduled"
508
1075
  };
1076
+
1077
+ emitScheduleCreate(schedule);
1078
+
1079
+ return schedule;
509
1080
  }
510
1081
  if (typeof when === "number") {
511
1082
  const time = new Date(Date.now() + when * 1000);
@@ -518,16 +1089,20 @@ export class Agent<Env, State = unknown> extends Server<Env> {
518
1089
  )}, 'delayed', ${when}, ${timestamp})
519
1090
  `;
520
1091
 
521
- await this.#scheduleNextAlarm();
1092
+ await this._scheduleNextAlarm();
522
1093
 
523
- return {
524
- id,
1094
+ const schedule: Schedule<T> = {
525
1095
  callback: callback,
526
- payload: payload as T,
527
1096
  delayInSeconds: when,
1097
+ id,
1098
+ payload: payload as T,
528
1099
  time: timestamp,
529
- type: "delayed",
1100
+ type: "delayed"
530
1101
  };
1102
+
1103
+ emitScheduleCreate(schedule);
1104
+
1105
+ return schedule;
531
1106
  }
532
1107
  if (typeof when === "string") {
533
1108
  const nextExecutionTime = getNextCronTime(when);
@@ -540,16 +1115,20 @@ export class Agent<Env, State = unknown> extends Server<Env> {
540
1115
  )}, 'cron', ${when}, ${timestamp})
541
1116
  `;
542
1117
 
543
- await this.#scheduleNextAlarm();
1118
+ await this._scheduleNextAlarm();
544
1119
 
545
- return {
546
- id,
1120
+ const schedule: Schedule<T> = {
547
1121
  callback: callback,
548
- payload: payload as T,
549
1122
  cron: when,
1123
+ id,
1124
+ payload: payload as T,
550
1125
  time: timestamp,
551
- type: "cron",
1126
+ type: "cron"
552
1127
  };
1128
+
1129
+ emitScheduleCreate(schedule);
1130
+
1131
+ return schedule;
553
1132
  }
554
1133
  throw new Error("Invalid schedule type");
555
1134
  }
@@ -580,7 +1159,6 @@ export class Agent<Env, State = unknown> extends Server<Env> {
580
1159
  */
581
1160
  getSchedules<T = string>(
582
1161
  criteria: {
583
- description?: string;
584
1162
  id?: string;
585
1163
  type?: "scheduled" | "delayed" | "cron";
586
1164
  timeRange?: { start?: Date; end?: Date };
@@ -594,11 +1172,6 @@ export class Agent<Env, State = unknown> extends Server<Env> {
594
1172
  params.push(criteria.id);
595
1173
  }
596
1174
 
597
- if (criteria.description) {
598
- query += " AND description = ?";
599
- params.push(criteria.description);
600
- }
601
-
602
1175
  if (criteria.type) {
603
1176
  query += " AND type = ?";
604
1177
  params.push(criteria.type);
@@ -619,7 +1192,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
619
1192
  .toArray()
620
1193
  .map((row) => ({
621
1194
  ...row,
622
- payload: JSON.parse(row.payload as string) as T,
1195
+ payload: JSON.parse(row.payload as string) as T
623
1196
  })) as Schedule<T>[];
624
1197
 
625
1198
  return result;
@@ -631,13 +1204,26 @@ export class Agent<Env, State = unknown> extends Server<Env> {
631
1204
  * @returns true if the task was cancelled, false otherwise
632
1205
  */
633
1206
  async cancelSchedule(id: string): Promise<boolean> {
1207
+ const schedule = await this.getSchedule(id);
1208
+ if (schedule) {
1209
+ this.observability?.emit(
1210
+ {
1211
+ displayMessage: `Schedule ${id} cancelled`,
1212
+ id: nanoid(),
1213
+ payload: schedule,
1214
+ timestamp: Date.now(),
1215
+ type: "schedule:cancel"
1216
+ },
1217
+ this.ctx
1218
+ );
1219
+ }
634
1220
  this.sql`DELETE FROM cf_agents_schedules WHERE id = ${id}`;
635
1221
 
636
- await this.#scheduleNextAlarm();
1222
+ await this._scheduleNextAlarm();
637
1223
  return true;
638
1224
  }
639
1225
 
640
- async #scheduleNextAlarm() {
1226
+ private async _scheduleNextAlarm() {
641
1227
  // Find the next schedule that needs to be executed
642
1228
  const result = this.sql`
643
1229
  SELECT time FROM cf_agents_schedules
@@ -654,10 +1240,14 @@ export class Agent<Env, State = unknown> extends Server<Env> {
654
1240
  }
655
1241
 
656
1242
  /**
657
- * Method called when an alarm fires
658
- * Executes any scheduled tasks that are due
1243
+ * Method called when an alarm fires.
1244
+ * Executes any scheduled tasks that are due.
1245
+ *
1246
+ * @remarks
1247
+ * To schedule a task, please use the `this.schedule` method instead.
1248
+ * See {@link https://developers.cloudflare.com/agents/api-reference/schedule-tasks/}
659
1249
  */
660
- async alarm() {
1250
+ public readonly alarm = async () => {
661
1251
  const now = Math.floor(Date.now() / 1000);
662
1252
 
663
1253
  // Get all schedules that should be executed now
@@ -665,41 +1255,64 @@ export class Agent<Env, State = unknown> extends Server<Env> {
665
1255
  SELECT * FROM cf_agents_schedules WHERE time <= ${now}
666
1256
  `;
667
1257
 
668
- for (const row of result || []) {
669
- const callback = this[row.callback as keyof Agent<Env>];
670
- if (!callback) {
671
- console.error(`callback ${row.callback} not found`);
672
- continue;
673
- }
674
- try {
675
- await (
676
- callback as (
677
- payload: unknown,
678
- schedule: Schedule<unknown>
679
- ) => Promise<void>
680
- ).bind(this)(JSON.parse(row.payload as string), row);
681
- } catch (e) {
682
- console.error(`error executing callback "${row.callback}"`, e);
683
- }
684
- if (row.type === "cron") {
685
- // Update next execution time for cron schedules
686
- const nextExecutionTime = getNextCronTime(row.cron);
687
- const nextTimestamp = Math.floor(nextExecutionTime.getTime() / 1000);
1258
+ if (result && Array.isArray(result)) {
1259
+ for (const row of result) {
1260
+ const callback = this[row.callback as keyof Agent<Env>];
1261
+ if (!callback) {
1262
+ console.error(`callback ${row.callback} not found`);
1263
+ continue;
1264
+ }
1265
+ await agentContext.run(
1266
+ {
1267
+ agent: this,
1268
+ connection: undefined,
1269
+ request: undefined,
1270
+ email: undefined
1271
+ },
1272
+ async () => {
1273
+ try {
1274
+ this.observability?.emit(
1275
+ {
1276
+ displayMessage: `Schedule ${row.id} executed`,
1277
+ id: nanoid(),
1278
+ payload: row,
1279
+ timestamp: Date.now(),
1280
+ type: "schedule:execute"
1281
+ },
1282
+ this.ctx
1283
+ );
1284
+
1285
+ await (
1286
+ callback as (
1287
+ payload: unknown,
1288
+ schedule: Schedule<unknown>
1289
+ ) => Promise<void>
1290
+ ).bind(this)(JSON.parse(row.payload as string), row);
1291
+ } catch (e) {
1292
+ console.error(`error executing callback "${row.callback}"`, e);
1293
+ }
1294
+ }
1295
+ );
1296
+ if (row.type === "cron") {
1297
+ // Update next execution time for cron schedules
1298
+ const nextExecutionTime = getNextCronTime(row.cron);
1299
+ const nextTimestamp = Math.floor(nextExecutionTime.getTime() / 1000);
688
1300
 
689
- this.sql`
1301
+ this.sql`
690
1302
  UPDATE cf_agents_schedules SET time = ${nextTimestamp} WHERE id = ${row.id}
691
1303
  `;
692
- } else {
693
- // Delete one-time schedules after execution
694
- this.sql`
1304
+ } else {
1305
+ // Delete one-time schedules after execution
1306
+ this.sql`
695
1307
  DELETE FROM cf_agents_schedules WHERE id = ${row.id}
696
1308
  `;
1309
+ }
697
1310
  }
698
1311
  }
699
1312
 
700
1313
  // Schedule the next alarm
701
- await this.#scheduleNextAlarm();
702
- }
1314
+ await this._scheduleNextAlarm();
1315
+ };
703
1316
 
704
1317
  /**
705
1318
  * Destroy the Agent, removing all state and scheduled tasks
@@ -708,20 +1321,203 @@ export class Agent<Env, State = unknown> extends Server<Env> {
708
1321
  // drop all tables
709
1322
  this.sql`DROP TABLE IF EXISTS cf_agents_state`;
710
1323
  this.sql`DROP TABLE IF EXISTS cf_agents_schedules`;
1324
+ this.sql`DROP TABLE IF EXISTS cf_agents_mcp_servers`;
1325
+ this.sql`DROP TABLE IF EXISTS cf_agents_queues`;
711
1326
 
712
1327
  // delete all alarms
713
1328
  await this.ctx.storage.deleteAlarm();
714
1329
  await this.ctx.storage.deleteAll();
1330
+ this.ctx.abort("destroyed"); // enforce that the agent is evicted
1331
+
1332
+ this.observability?.emit(
1333
+ {
1334
+ displayMessage: "Agent destroyed",
1335
+ id: nanoid(),
1336
+ payload: {},
1337
+ timestamp: Date.now(),
1338
+ type: "destroy"
1339
+ },
1340
+ this.ctx
1341
+ );
715
1342
  }
716
1343
 
717
1344
  /**
718
1345
  * Get all methods marked as callable on this Agent
719
1346
  * @returns A map of method names to their metadata
720
1347
  */
721
- #isCallable(method: string): boolean {
722
- // biome-ignore lint/complexity/noBannedTypes: <explanation>
1348
+ private _isCallable(method: string): boolean {
723
1349
  return callableMetadata.has(this[method as keyof this] as Function);
724
1350
  }
1351
+
1352
+ /**
1353
+ * Connect to a new MCP Server
1354
+ *
1355
+ * @param url MCP Server SSE URL
1356
+ * @param callbackHost Base host for the agent, used for the redirect URI.
1357
+ * @param agentsPrefix agents routing prefix if not using `agents`
1358
+ * @param options MCP client and transport (header) options
1359
+ * @returns authUrl
1360
+ */
1361
+ async addMcpServer(
1362
+ serverName: string,
1363
+ url: string,
1364
+ callbackHost: string,
1365
+ agentsPrefix = "agents",
1366
+ options?: {
1367
+ client?: ConstructorParameters<typeof Client>[1];
1368
+ transport?: {
1369
+ headers: HeadersInit;
1370
+ };
1371
+ }
1372
+ ): Promise<{ id: string; authUrl: string | undefined }> {
1373
+ const callbackUrl = `${callbackHost}/${agentsPrefix}/${camelCaseToKebabCase(this._ParentClass.name)}/${this.name}/callback`;
1374
+
1375
+ const result = await this._connectToMcpServerInternal(
1376
+ serverName,
1377
+ url,
1378
+ callbackUrl,
1379
+ options
1380
+ );
1381
+ this.sql`
1382
+ INSERT
1383
+ OR REPLACE INTO cf_agents_mcp_servers (id, name, server_url, client_id, auth_url, callback_url, server_options)
1384
+ VALUES (
1385
+ ${result.id},
1386
+ ${serverName},
1387
+ ${url},
1388
+ ${result.clientId ?? null},
1389
+ ${result.authUrl ?? null},
1390
+ ${callbackUrl},
1391
+ ${options ? JSON.stringify(options) : null}
1392
+ );
1393
+ `;
1394
+
1395
+ this.broadcast(
1396
+ JSON.stringify({
1397
+ mcp: this.getMcpServers(),
1398
+ type: "cf_agent_mcp_servers"
1399
+ })
1400
+ );
1401
+
1402
+ return result;
1403
+ }
1404
+
1405
+ async _connectToMcpServerInternal(
1406
+ _serverName: string,
1407
+ url: string,
1408
+ callbackUrl: string,
1409
+ // it's important that any options here are serializable because we put them into our sqlite DB for reconnection purposes
1410
+ options?: {
1411
+ client?: ConstructorParameters<typeof Client>[1];
1412
+ /**
1413
+ * We don't expose the normal set of transport options because:
1414
+ * 1) we can't serialize things like the auth provider or a fetch function into the DB for reconnection purposes
1415
+ * 2) We probably want these options to be agnostic to the transport type (SSE vs Streamable)
1416
+ *
1417
+ * This has the limitation that you can't override fetch, but I think headers should handle nearly all cases needed (i.e. non-standard bearer auth).
1418
+ */
1419
+ transport?: {
1420
+ headers?: HeadersInit;
1421
+ };
1422
+ },
1423
+ reconnect?: {
1424
+ id: string;
1425
+ oauthClientId?: string;
1426
+ }
1427
+ ): Promise<{
1428
+ id: string;
1429
+ authUrl: string | undefined;
1430
+ clientId: string | undefined;
1431
+ }> {
1432
+ const authProvider = new DurableObjectOAuthClientProvider(
1433
+ this.ctx.storage,
1434
+ this.name,
1435
+ callbackUrl
1436
+ );
1437
+
1438
+ if (reconnect) {
1439
+ authProvider.serverId = reconnect.id;
1440
+ if (reconnect.oauthClientId) {
1441
+ authProvider.clientId = reconnect.oauthClientId;
1442
+ }
1443
+ }
1444
+
1445
+ // allows passing through transport headers if necessary
1446
+ // this handles some non-standard bearer auth setups (i.e. MCP server behind CF access instead of OAuth)
1447
+ let headerTransportOpts: SSEClientTransportOptions = {};
1448
+ if (options?.transport?.headers) {
1449
+ headerTransportOpts = {
1450
+ eventSourceInit: {
1451
+ fetch: (url, init) =>
1452
+ fetch(url, {
1453
+ ...init,
1454
+ headers: options?.transport?.headers
1455
+ })
1456
+ },
1457
+ requestInit: {
1458
+ headers: options?.transport?.headers
1459
+ }
1460
+ };
1461
+ }
1462
+
1463
+ const { id, authUrl, clientId } = await this.mcp.connect(url, {
1464
+ client: options?.client,
1465
+ reconnect,
1466
+ transport: {
1467
+ ...headerTransportOpts,
1468
+ authProvider
1469
+ }
1470
+ });
1471
+
1472
+ return {
1473
+ authUrl,
1474
+ clientId,
1475
+ id
1476
+ };
1477
+ }
1478
+
1479
+ async removeMcpServer(id: string) {
1480
+ this.mcp.closeConnection(id);
1481
+ this.sql`
1482
+ DELETE FROM cf_agents_mcp_servers WHERE id = ${id};
1483
+ `;
1484
+ this.broadcast(
1485
+ JSON.stringify({
1486
+ mcp: this.getMcpServers(),
1487
+ type: "cf_agent_mcp_servers"
1488
+ })
1489
+ );
1490
+ }
1491
+
1492
+ getMcpServers(): MCPServersState {
1493
+ const mcpState: MCPServersState = {
1494
+ prompts: this.mcp.listPrompts(),
1495
+ resources: this.mcp.listResources(),
1496
+ servers: {},
1497
+ tools: this.mcp.listTools()
1498
+ };
1499
+
1500
+ const servers = this.sql<MCPServerRow>`
1501
+ SELECT id, name, server_url, client_id, auth_url, callback_url, server_options FROM cf_agents_mcp_servers;
1502
+ `;
1503
+
1504
+ if (servers && Array.isArray(servers) && servers.length > 0) {
1505
+ for (const server of servers) {
1506
+ const serverConn = this.mcp.mcpConnections[server.id];
1507
+ mcpState.servers[server.id] = {
1508
+ auth_url: server.auth_url,
1509
+ capabilities: serverConn?.serverCapabilities ?? null,
1510
+ instructions: serverConn?.instructions ?? null,
1511
+ name: server.name,
1512
+ server_url: server.server_url,
1513
+ // mark as "authenticating" because the server isn't automatically connected, so it's pending authenticating
1514
+ state: serverConn?.connectionState ?? "authenticating"
1515
+ };
1516
+ }
1517
+ }
1518
+
1519
+ return mcpState;
1520
+ }
725
1521
  }
726
1522
 
727
1523
  /**
@@ -761,17 +1557,17 @@ export async function routeAgentRequest<Env>(
761
1557
  const corsHeaders =
762
1558
  options?.cors === true
763
1559
  ? {
764
- "Access-Control-Allow-Origin": "*",
765
- "Access-Control-Allow-Methods": "GET, POST, HEAD, OPTIONS",
766
1560
  "Access-Control-Allow-Credentials": "true",
767
- "Access-Control-Max-Age": "86400",
1561
+ "Access-Control-Allow-Methods": "GET, POST, HEAD, OPTIONS",
1562
+ "Access-Control-Allow-Origin": "*",
1563
+ "Access-Control-Max-Age": "86400"
768
1564
  }
769
1565
  : options?.cors;
770
1566
 
771
1567
  if (request.method === "OPTIONS") {
772
1568
  if (corsHeaders) {
773
1569
  return new Response(null, {
774
- headers: corsHeaders,
1570
+ headers: corsHeaders
775
1571
  });
776
1572
  }
777
1573
  console.warn(
@@ -784,7 +1580,7 @@ export async function routeAgentRequest<Env>(
784
1580
  env as Record<string, unknown>,
785
1581
  {
786
1582
  prefix: "agents",
787
- ...(options as PartyServerOptions<Record<string, unknown>>),
1583
+ ...(options as PartyServerOptions<Record<string, unknown>>)
788
1584
  }
789
1585
  );
790
1586
 
@@ -797,24 +1593,218 @@ export async function routeAgentRequest<Env>(
797
1593
  response = new Response(response.body, {
798
1594
  headers: {
799
1595
  ...response.headers,
800
- ...corsHeaders,
801
- },
1596
+ ...corsHeaders
1597
+ }
802
1598
  });
803
1599
  }
804
1600
  return response;
805
1601
  }
806
1602
 
1603
+ export type EmailResolver<Env> = (
1604
+ email: ForwardableEmailMessage,
1605
+ env: Env
1606
+ ) => Promise<{
1607
+ agentName: string;
1608
+ agentId: string;
1609
+ } | null>;
1610
+
1611
+ /**
1612
+ * Create a resolver that uses the message-id header to determine the agent to route the email to
1613
+ * @returns A function that resolves the agent to route the email to
1614
+ */
1615
+ export function createHeaderBasedEmailResolver<Env>(): EmailResolver<Env> {
1616
+ return async (email: ForwardableEmailMessage, _env: Env) => {
1617
+ const messageId = email.headers.get("message-id");
1618
+ if (messageId) {
1619
+ const messageIdMatch = messageId.match(/<([^@]+)@([^>]+)>/);
1620
+ if (messageIdMatch) {
1621
+ const [, agentId, domain] = messageIdMatch;
1622
+ const agentName = domain.split(".")[0];
1623
+ return { agentName, agentId };
1624
+ }
1625
+ }
1626
+
1627
+ const references = email.headers.get("references");
1628
+ if (references) {
1629
+ const referencesMatch = references.match(
1630
+ /<([A-Za-z0-9+/]{43}=)@([^>]+)>/
1631
+ );
1632
+ if (referencesMatch) {
1633
+ const [, base64Id, domain] = referencesMatch;
1634
+ const agentId = Buffer.from(base64Id, "base64").toString("hex");
1635
+ const agentName = domain.split(".")[0];
1636
+ return { agentName, agentId };
1637
+ }
1638
+ }
1639
+
1640
+ const agentName = email.headers.get("x-agent-name");
1641
+ const agentId = email.headers.get("x-agent-id");
1642
+ if (agentName && agentId) {
1643
+ return { agentName, agentId };
1644
+ }
1645
+
1646
+ return null;
1647
+ };
1648
+ }
1649
+
1650
+ /**
1651
+ * Create a resolver that uses the email address to determine the agent to route the email to
1652
+ * @param defaultAgentName The default agent name to use if the email address does not contain a sub-address
1653
+ * @returns A function that resolves the agent to route the email to
1654
+ */
1655
+ export function createAddressBasedEmailResolver<Env>(
1656
+ defaultAgentName: string
1657
+ ): EmailResolver<Env> {
1658
+ return async (email: ForwardableEmailMessage, _env: Env) => {
1659
+ const emailMatch = email.to.match(/^([^+@]+)(?:\+([^@]+))?@(.+)$/);
1660
+ if (!emailMatch) {
1661
+ return null;
1662
+ }
1663
+
1664
+ const [, localPart, subAddress] = emailMatch;
1665
+
1666
+ if (subAddress) {
1667
+ return {
1668
+ agentName: localPart,
1669
+ agentId: subAddress
1670
+ };
1671
+ }
1672
+
1673
+ // Option 2: Use defaultAgentName namespace, localPart as agentId
1674
+ // Common for catch-all email routing to a single EmailAgent namespace
1675
+ return {
1676
+ agentName: defaultAgentName,
1677
+ agentId: localPart
1678
+ };
1679
+ };
1680
+ }
1681
+
1682
+ /**
1683
+ * Create a resolver that uses the agentName and agentId to determine the agent to route the email to
1684
+ * @param agentName The name of the agent to route the email to
1685
+ * @param agentId The id of the agent to route the email to
1686
+ * @returns A function that resolves the agent to route the email to
1687
+ */
1688
+ export function createCatchAllEmailResolver<Env>(
1689
+ agentName: string,
1690
+ agentId: string
1691
+ ): EmailResolver<Env> {
1692
+ return async () => ({ agentName, agentId });
1693
+ }
1694
+
1695
+ export type EmailRoutingOptions<Env> = AgentOptions<Env> & {
1696
+ resolver: EmailResolver<Env>;
1697
+ };
1698
+
807
1699
  /**
808
1700
  * Route an email to the appropriate Agent
809
- * @param email Email message to route
810
- * @param env Environment containing Agent bindings
811
- * @param options Routing options
1701
+ * @param email The email to route
1702
+ * @param env The environment containing the Agent bindings
1703
+ * @param options The options for routing the email
1704
+ * @returns A promise that resolves when the email has been routed
812
1705
  */
813
1706
  export async function routeAgentEmail<Env>(
814
1707
  email: ForwardableEmailMessage,
815
1708
  env: Env,
816
- options?: AgentOptions<Env>
817
- ): Promise<void> {}
1709
+ options: EmailRoutingOptions<Env>
1710
+ ): Promise<void> {
1711
+ const routingInfo = await options.resolver(email, env);
1712
+
1713
+ if (!routingInfo) {
1714
+ console.warn("No routing information found for email, dropping message");
1715
+ return;
1716
+ }
1717
+
1718
+ const namespaceBinding = env[routingInfo.agentName as keyof Env];
1719
+ if (!namespaceBinding) {
1720
+ throw new Error(
1721
+ `Agent namespace '${routingInfo.agentName}' not found in environment`
1722
+ );
1723
+ }
1724
+
1725
+ // Type guard to check if this is actually a DurableObjectNamespace (AgentNamespace)
1726
+ if (
1727
+ typeof namespaceBinding !== "object" ||
1728
+ !("idFromName" in namespaceBinding) ||
1729
+ typeof namespaceBinding.idFromName !== "function"
1730
+ ) {
1731
+ throw new Error(
1732
+ `Environment binding '${routingInfo.agentName}' is not an AgentNamespace (found: ${typeof namespaceBinding})`
1733
+ );
1734
+ }
1735
+
1736
+ // Safe cast after runtime validation
1737
+ const namespace = namespaceBinding as unknown as AgentNamespace<Agent<Env>>;
1738
+
1739
+ const agent = await getAgentByName(namespace, routingInfo.agentId);
1740
+
1741
+ // let's make a serialisable version of the email
1742
+ const serialisableEmail: AgentEmail = {
1743
+ getRaw: async () => {
1744
+ const reader = email.raw.getReader();
1745
+ const chunks: Uint8Array[] = [];
1746
+
1747
+ let done = false;
1748
+ while (!done) {
1749
+ const { value, done: readerDone } = await reader.read();
1750
+ done = readerDone;
1751
+ if (value) {
1752
+ chunks.push(value);
1753
+ }
1754
+ }
1755
+
1756
+ const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);
1757
+ const combined = new Uint8Array(totalLength);
1758
+ let offset = 0;
1759
+ for (const chunk of chunks) {
1760
+ combined.set(chunk, offset);
1761
+ offset += chunk.length;
1762
+ }
1763
+
1764
+ return combined;
1765
+ },
1766
+ headers: email.headers,
1767
+ rawSize: email.rawSize,
1768
+ setReject: (reason: string) => {
1769
+ email.setReject(reason);
1770
+ },
1771
+ forward: (rcptTo: string, headers?: Headers) => {
1772
+ return email.forward(rcptTo, headers);
1773
+ },
1774
+ reply: (options: { from: string; to: string; raw: string }) => {
1775
+ return email.reply(
1776
+ new EmailMessage(options.from, options.to, options.raw)
1777
+ );
1778
+ },
1779
+ from: email.from,
1780
+ to: email.to
1781
+ };
1782
+
1783
+ await agent._onEmail(serialisableEmail);
1784
+ }
1785
+
1786
+ export type AgentEmail = {
1787
+ from: string;
1788
+ to: string;
1789
+ getRaw: () => Promise<Uint8Array>;
1790
+ headers: Headers;
1791
+ rawSize: number;
1792
+ setReject: (reason: string) => void;
1793
+ forward: (rcptTo: string, headers?: Headers) => Promise<void>;
1794
+ reply: (options: { from: string; to: string; raw: string }) => Promise<void>;
1795
+ };
1796
+
1797
+ export type EmailSendOptions = {
1798
+ to: string;
1799
+ subject: string;
1800
+ body: string;
1801
+ contentType?: string;
1802
+ headers?: Record<string, string>;
1803
+ includeRoutingHeaders?: boolean;
1804
+ agentName?: string;
1805
+ agentId?: string;
1806
+ domain?: string;
1807
+ };
818
1808
 
819
1809
  /**
820
1810
  * Get or create an Agent by name
@@ -825,7 +1815,7 @@ export async function routeAgentEmail<Env>(
825
1815
  * @param options Options for Agent creation
826
1816
  * @returns Promise resolving to an Agent instance stub
827
1817
  */
828
- export function getAgentByName<Env, T extends Agent<Env>>(
1818
+ export async function getAgentByName<Env, T extends Agent<Env>>(
829
1819
  namespace: AgentNamespace<T>,
830
1820
  name: string,
831
1821
  options?: {
@@ -840,13 +1830,13 @@ export function getAgentByName<Env, T extends Agent<Env>>(
840
1830
  * A wrapper for streaming responses in callable methods
841
1831
  */
842
1832
  export class StreamingResponse {
843
- #connection: Connection;
844
- #id: string;
845
- #closed = false;
1833
+ private _connection: Connection;
1834
+ private _id: string;
1835
+ private _closed = false;
846
1836
 
847
1837
  constructor(connection: Connection, id: string) {
848
- this.#connection = connection;
849
- this.#id = id;
1838
+ this._connection = connection;
1839
+ this._id = id;
850
1840
  }
851
1841
 
852
1842
  /**
@@ -854,17 +1844,17 @@ export class StreamingResponse {
854
1844
  * @param chunk The data to send
855
1845
  */
856
1846
  send(chunk: unknown) {
857
- if (this.#closed) {
1847
+ if (this._closed) {
858
1848
  throw new Error("StreamingResponse is already closed");
859
1849
  }
860
1850
  const response: RPCResponse = {
861
- type: "rpc",
862
- id: this.#id,
863
- success: true,
864
- result: chunk,
865
1851
  done: false,
1852
+ id: this._id,
1853
+ result: chunk,
1854
+ success: true,
1855
+ type: "rpc"
866
1856
  };
867
- this.#connection.send(JSON.stringify(response));
1857
+ this._connection.send(JSON.stringify(response));
868
1858
  }
869
1859
 
870
1860
  /**
@@ -872,17 +1862,17 @@ export class StreamingResponse {
872
1862
  * @param finalChunk Optional final chunk of data to send
873
1863
  */
874
1864
  end(finalChunk?: unknown) {
875
- if (this.#closed) {
1865
+ if (this._closed) {
876
1866
  throw new Error("StreamingResponse is already closed");
877
1867
  }
878
- this.#closed = true;
1868
+ this._closed = true;
879
1869
  const response: RPCResponse = {
880
- type: "rpc",
881
- id: this.#id,
882
- success: true,
883
- result: finalChunk,
884
1870
  done: true,
1871
+ id: this._id,
1872
+ result: finalChunk,
1873
+ success: true,
1874
+ type: "rpc"
885
1875
  };
886
- this.#connection.send(JSON.stringify(response));
1876
+ this._connection.send(JSON.stringify(response));
887
1877
  }
888
1878
  }