agents 0.0.0-a20932f → 0.0.0-a45f8f3

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