agents 0.0.0-3bbbf81 → 0.0.0-3bcb134

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