agents 0.0.0-f5b5854 → 0.0.0-f6b2319

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 (77) hide show
  1. package/README.md +255 -27
  2. package/dist/_esm-LV5FJ3HK.js +3922 -0
  3. package/dist/_esm-LV5FJ3HK.js.map +1 -0
  4. package/dist/ai-chat-agent.d.ts +55 -8
  5. package/dist/ai-chat-agent.js +574 -90
  6. package/dist/ai-chat-agent.js.map +1 -1
  7. package/dist/ai-chat-v5-migration.d.ts +152 -0
  8. package/dist/ai-chat-v5-migration.js +20 -0
  9. package/dist/ai-react.d.ts +78 -67
  10. package/dist/ai-react.js +273 -109
  11. package/dist/ai-react.js.map +1 -1
  12. package/dist/ai-types.d.ts +41 -18
  13. package/dist/ai-types.js +7 -0
  14. package/dist/ccip-CMBYN64O.js +15 -0
  15. package/dist/ccip-CMBYN64O.js.map +1 -0
  16. package/dist/chunk-254F4GDT.js +1343 -0
  17. package/dist/chunk-254F4GDT.js.map +1 -0
  18. package/dist/chunk-3OT2NNEW.js +941 -0
  19. package/dist/chunk-3OT2NNEW.js.map +1 -0
  20. package/dist/chunk-5Y6BEZDY.js +276 -0
  21. package/dist/chunk-5Y6BEZDY.js.map +1 -0
  22. package/dist/chunk-BER7KXUJ.js +18 -0
  23. package/dist/chunk-BER7KXUJ.js.map +1 -0
  24. package/dist/chunk-JJBFIGUC.js +5202 -0
  25. package/dist/chunk-JJBFIGUC.js.map +1 -0
  26. package/dist/chunk-PR4QN5HX.js +43 -0
  27. package/dist/chunk-PR4QN5HX.js.map +1 -0
  28. package/dist/chunk-QEVM4BVL.js +116 -0
  29. package/dist/chunk-QEVM4BVL.js.map +1 -0
  30. package/dist/chunk-TYAY6AU6.js +159 -0
  31. package/dist/chunk-TYAY6AU6.js.map +1 -0
  32. package/dist/chunk-UJVEAURM.js +150 -0
  33. package/dist/chunk-UJVEAURM.js.map +1 -0
  34. package/dist/chunk-Z44WASMA.js +114 -0
  35. package/dist/chunk-Z44WASMA.js.map +1 -0
  36. package/dist/client-DVoPb3-C.d.ts +5120 -0
  37. package/dist/client.d.ts +16 -2
  38. package/dist/client.js +8 -126
  39. package/dist/client.js.map +1 -1
  40. package/dist/codemode/ai.d.ts +25 -0
  41. package/dist/codemode/ai.js +5109 -0
  42. package/dist/codemode/ai.js.map +1 -0
  43. package/dist/index.d.ts +277 -22
  44. package/dist/index.js +18 -6
  45. package/dist/mcp/client.d.ts +10 -761
  46. package/dist/mcp/client.js +4 -402
  47. package/dist/mcp/client.js.map +1 -1
  48. package/dist/mcp/do-oauth-client-provider.d.ts +4 -3
  49. package/dist/mcp/do-oauth-client-provider.js +4 -103
  50. package/dist/mcp/do-oauth-client-provider.js.map +1 -1
  51. package/dist/mcp/index.d.ts +69 -51
  52. package/dist/mcp/index.js +982 -661
  53. package/dist/mcp/index.js.map +1 -1
  54. package/dist/mcp/x402.d.ts +39 -0
  55. package/dist/mcp/x402.js +3195 -0
  56. package/dist/mcp/x402.js.map +1 -0
  57. package/dist/mcp-BH1fJeiU.d.ts +58 -0
  58. package/dist/observability/index.d.ts +34 -0
  59. package/dist/observability/index.js +12 -0
  60. package/dist/observability/index.js.map +1 -0
  61. package/dist/react.d.ts +97 -9
  62. package/dist/react.js +123 -11
  63. package/dist/react.js.map +1 -1
  64. package/dist/schedule.d.ts +81 -7
  65. package/dist/schedule.js +20 -7
  66. package/dist/schedule.js.map +1 -1
  67. package/dist/secp256k1-M22GZP2U.js +2193 -0
  68. package/dist/secp256k1-M22GZP2U.js.map +1 -0
  69. package/dist/serializable.d.ts +32 -0
  70. package/dist/serializable.js +1 -0
  71. package/dist/serializable.js.map +1 -0
  72. package/package.json +98 -64
  73. package/src/index.ts +1271 -152
  74. package/dist/chunk-HMLY7DHA.js +0 -16
  75. package/dist/chunk-XG52S6YY.js +0 -591
  76. package/dist/chunk-XG52S6YY.js.map +0 -1
  77. /package/dist/{chunk-HMLY7DHA.js.map → ai-chat-v5-migration.js.map} +0 -0
package/src/index.ts CHANGED
@@ -1,19 +1,36 @@
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, type MCPClientOAuthResult } from "./mcp/client";
26
+ import type { MCPConnectionState } from "./mcp/client-connection";
27
+ import { DurableObjectOAuthClientProvider } from "./mcp/do-oauth-client-provider";
28
+ import type { TransportType } from "./mcp/types";
29
+ import { genericObservability, type Observability } from "./observability";
30
+ import { DisposableStore } from "./core/events";
31
+ import { MessageType } from "./ai-types";
10
32
 
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";
33
+ export type { Connection, ConnectionContext, WSMessage } from "partyserver";
17
34
 
18
35
  /**
19
36
  * RPC request message from client
@@ -29,7 +46,7 @@ export type RPCRequest = {
29
46
  * State update message from client
30
47
  */
31
48
  export type StateUpdateMessage = {
32
- type: "cf_agent_state";
49
+ type: MessageType.CF_AGENT_STATE;
33
50
  state: unknown;
34
51
  };
35
52
 
@@ -37,7 +54,7 @@ export type StateUpdateMessage = {
37
54
  * RPC response message to client
38
55
  */
39
56
  export type RPCResponse = {
40
- type: "rpc";
57
+ type: MessageType.RPC;
41
58
  id: string;
42
59
  } & (
43
60
  | {
@@ -64,7 +81,7 @@ function isRPCRequest(msg: unknown): msg is RPCRequest {
64
81
  typeof msg === "object" &&
65
82
  msg !== null &&
66
83
  "type" in msg &&
67
- msg.type === "rpc" &&
84
+ msg.type === MessageType.RPC &&
68
85
  "id" in msg &&
69
86
  typeof msg.id === "string" &&
70
87
  "method" in msg &&
@@ -82,7 +99,7 @@ function isStateUpdateMessage(msg: unknown): msg is StateUpdateMessage {
82
99
  typeof msg === "object" &&
83
100
  msg !== null &&
84
101
  "type" in msg &&
85
- msg.type === "cf_agent_state" &&
102
+ msg.type === MessageType.CF_AGENT_STATE &&
86
103
  "state" in msg
87
104
  );
88
105
  }
@@ -97,16 +114,16 @@ export type CallableMetadata = {
97
114
  streaming?: boolean;
98
115
  };
99
116
 
100
- // biome-ignore lint/complexity/noBannedTypes: <explanation>
101
117
  const callableMetadata = new Map<Function, CallableMetadata>();
102
118
 
103
119
  /**
104
120
  * Decorator that marks a method as callable by clients
105
121
  * @param metadata Optional metadata about the callable method
106
122
  */
107
- export function unstable_callable(metadata: CallableMetadata = {}) {
123
+ export function callable(metadata: CallableMetadata = {}) {
108
124
  return function callableDecorator<This, Args extends unknown[], Return>(
109
125
  target: (this: This, ...args: Args) => Return,
126
+ // biome-ignore lint/correctness/noUnusedFunctionParameters: later
110
127
  context: ClassMethodDecoratorContext
111
128
  ) {
112
129
  if (!callableMetadata.has(target)) {
@@ -117,6 +134,30 @@ export function unstable_callable(metadata: CallableMetadata = {}) {
117
134
  };
118
135
  }
119
136
 
137
+ let didWarnAboutUnstableCallable = false;
138
+
139
+ /**
140
+ * Decorator that marks a method as callable by clients
141
+ * @deprecated this has been renamed to callable, and unstable_callable will be removed in the next major version
142
+ * @param metadata Optional metadata about the callable method
143
+ */
144
+ export const unstable_callable = (metadata: CallableMetadata = {}) => {
145
+ if (!didWarnAboutUnstableCallable) {
146
+ didWarnAboutUnstableCallable = true;
147
+ console.warn(
148
+ "unstable_callable is deprecated, use callable instead. unstable_callable will be removed in the next major version."
149
+ );
150
+ }
151
+ callable(metadata);
152
+ };
153
+
154
+ export type QueueItem<T = string> = {
155
+ id: string;
156
+ payload: T;
157
+ callback: keyof Agent<unknown>;
158
+ created_at: number;
159
+ };
160
+
120
161
  /**
121
162
  * Represents a scheduled task within an Agent
122
163
  * @template T Type of the payload data
@@ -158,24 +199,134 @@ function getNextCronTime(cron: string) {
158
199
  return interval.getNextDate();
159
200
  }
160
201
 
202
+ export type { TransportType } from "./mcp/types";
203
+
204
+ /**
205
+ * MCP Server state update message from server -> Client
206
+ */
207
+ export type MCPServerMessage = {
208
+ type: MessageType.CF_AGENT_MCP_SERVERS;
209
+ mcp: MCPServersState;
210
+ };
211
+
212
+ export type MCPServersState = {
213
+ servers: {
214
+ [id: string]: MCPServer;
215
+ };
216
+ tools: Tool[];
217
+ prompts: Prompt[];
218
+ resources: Resource[];
219
+ };
220
+
221
+ export type MCPServer = {
222
+ name: string;
223
+ server_url: string;
224
+ auth_url: string | null;
225
+ // This state is specifically about the temporary process of getting a token (if needed).
226
+ // Scope outside of that can't be relied upon because when the DO sleeps, there's no way
227
+ // to communicate a change to a non-ready state.
228
+ state: MCPConnectionState;
229
+ instructions: string | null;
230
+ capabilities: ServerCapabilities | null;
231
+ };
232
+
233
+ /**
234
+ * MCP Server data stored in DO SQL for resuming MCP Server connections
235
+ */
236
+ type MCPServerRow = {
237
+ id: string;
238
+ name: string;
239
+ server_url: string;
240
+ client_id: string | null;
241
+ auth_url: string | null;
242
+ callback_url: string;
243
+ server_options: string;
244
+ };
245
+
161
246
  const STATE_ROW_ID = "cf_state_row_id";
162
247
  const STATE_WAS_CHANGED = "cf_state_was_changed";
163
248
 
164
249
  const DEFAULT_STATE = {} as unknown;
165
250
 
166
- export const unstable_context = new AsyncLocalStorage<{
167
- agent: Agent<unknown>;
251
+ const agentContext = new AsyncLocalStorage<{
252
+ agent: Agent<unknown, unknown>;
168
253
  connection: Connection | undefined;
169
254
  request: Request | undefined;
255
+ email: AgentEmail | undefined;
170
256
  }>();
171
257
 
258
+ export function getCurrentAgent<
259
+ T extends Agent<unknown, unknown> = Agent<unknown, unknown>
260
+ >(): {
261
+ agent: T | undefined;
262
+ connection: Connection | undefined;
263
+ request: Request | undefined;
264
+ email: AgentEmail | undefined;
265
+ } {
266
+ const store = agentContext.getStore() as
267
+ | {
268
+ agent: T;
269
+ connection: Connection | undefined;
270
+ request: Request | undefined;
271
+ email: AgentEmail | undefined;
272
+ }
273
+ | undefined;
274
+ if (!store) {
275
+ return {
276
+ agent: undefined,
277
+ connection: undefined,
278
+ request: undefined,
279
+ email: undefined
280
+ };
281
+ }
282
+ return store;
283
+ }
284
+
285
+ /**
286
+ * Wraps a method to run within the agent context, ensuring getCurrentAgent() works properly
287
+ * @param agent The agent instance
288
+ * @param method The method to wrap
289
+ * @returns A wrapped method that runs within the agent context
290
+ */
291
+
292
+ // biome-ignore lint/suspicious/noExplicitAny: I can't typescript
293
+ function withAgentContext<T extends (...args: any[]) => any>(
294
+ method: T
295
+ ): (this: Agent<unknown, unknown>, ...args: Parameters<T>) => ReturnType<T> {
296
+ return function (...args: Parameters<T>): ReturnType<T> {
297
+ const { connection, request, email, agent } = getCurrentAgent();
298
+
299
+ if (agent === this) {
300
+ // already wrapped, so we can just call the method
301
+ return method.apply(this, args);
302
+ }
303
+ // not wrapped, so we need to wrap it
304
+ return agentContext.run({ agent: this, connection, request, email }, () => {
305
+ return method.apply(this, args);
306
+ });
307
+ };
308
+ }
309
+
172
310
  /**
173
311
  * Base class for creating Agent implementations
174
312
  * @template Env Environment type containing bindings
175
313
  * @template State State type to store within the Agent
176
314
  */
177
- export class Agent<Env, State = unknown> extends Server<Env> {
178
- #state = DEFAULT_STATE as State;
315
+ export class Agent<
316
+ Env = typeof env,
317
+ State = unknown,
318
+ Props extends Record<string, unknown> = Record<string, unknown>
319
+ > extends Server<Env, Props> {
320
+ private _state = DEFAULT_STATE as State;
321
+ private _disposables = new DisposableStore();
322
+
323
+ private _ParentClass: typeof Agent<Env, State> =
324
+ Object.getPrototypeOf(this).constructor;
325
+
326
+ readonly mcp: MCPClientManager = new MCPClientManager(
327
+ this._ParentClass.name,
328
+ "0.0.1"
329
+ );
179
330
 
180
331
  /**
181
332
  * Initial state for the Agent
@@ -187,9 +338,9 @@ export class Agent<Env, State = unknown> extends Server<Env> {
187
338
  * Current state of the Agent
188
339
  */
189
340
  get state(): State {
190
- if (this.#state !== DEFAULT_STATE) {
341
+ if (this._state !== DEFAULT_STATE) {
191
342
  // state was previously set, and populated internal state
192
- return this.#state;
343
+ return this._state;
193
344
  }
194
345
  // looks like this is the first time the state is being accessed
195
346
  // check if the state was set in a previous life
@@ -209,8 +360,8 @@ export class Agent<Env, State = unknown> extends Server<Env> {
209
360
  ) {
210
361
  const state = result[0]?.state as string; // could be null?
211
362
 
212
- this.#state = JSON.parse(state);
213
- return this.#state;
363
+ this._state = JSON.parse(state);
364
+ return this._state;
214
365
  }
215
366
 
216
367
  // ok, this is the first time the state is being accessed
@@ -231,9 +382,14 @@ export class Agent<Env, State = unknown> extends Server<Env> {
231
382
  */
232
383
  static options = {
233
384
  /** Whether the Agent should hibernate when inactive */
234
- hibernate: true, // default to hibernate
385
+ hibernate: true // default to hibernate
235
386
  };
236
387
 
388
+ /**
389
+ * The observability implementation to use for the Agent
390
+ */
391
+ observability?: Observability = genericObservability;
392
+
237
393
  /**
238
394
  * Execute SQL queries against the Agent's database
239
395
  * @template T Type of the returned rows
@@ -263,6 +419,26 @@ export class Agent<Env, State = unknown> extends Server<Env> {
263
419
  constructor(ctx: AgentContext, env: Env) {
264
420
  super(ctx, env);
265
421
 
422
+ if (!wrappedClasses.has(this.constructor)) {
423
+ // Auto-wrap custom methods with agent context
424
+ this._autoWrapCustomMethods();
425
+ wrappedClasses.add(this.constructor);
426
+ }
427
+
428
+ // Broadcast server state after background connects (for OAuth servers)
429
+ this._disposables.add(
430
+ this.mcp.onConnected(async () => {
431
+ this.broadcastMcpServers();
432
+ })
433
+ );
434
+
435
+ // Emit MCP observability events
436
+ this._disposables.add(
437
+ this.mcp.onObservabilityEvent((event) => {
438
+ this.observability?.emit(event);
439
+ })
440
+ );
441
+
266
442
  this.sql`
267
443
  CREATE TABLE IF NOT EXISTS cf_agents_state (
268
444
  id TEXT PRIMARY KEY NOT NULL,
@@ -270,8 +446,17 @@ export class Agent<Env, State = unknown> extends Server<Env> {
270
446
  )
271
447
  `;
272
448
 
449
+ this.sql`
450
+ CREATE TABLE IF NOT EXISTS cf_agents_queues (
451
+ id TEXT PRIMARY KEY NOT NULL,
452
+ payload TEXT,
453
+ callback TEXT,
454
+ created_at INTEGER DEFAULT (unixepoch())
455
+ )
456
+ `;
457
+
273
458
  void this.ctx.blockConcurrencyWhile(async () => {
274
- return this.#tryCatch(async () => {
459
+ return this._tryCatch(async () => {
275
460
  // Create alarms table if it doesn't exist
276
461
  this.sql`
277
462
  CREATE TABLE IF NOT EXISTS cf_agents_schedules (
@@ -291,25 +476,68 @@ export class Agent<Env, State = unknown> extends Server<Env> {
291
476
  });
292
477
  });
293
478
 
479
+ this.sql`
480
+ CREATE TABLE IF NOT EXISTS cf_agents_mcp_servers (
481
+ id TEXT PRIMARY KEY NOT NULL,
482
+ name TEXT NOT NULL,
483
+ server_url TEXT NOT NULL,
484
+ callback_url TEXT NOT NULL,
485
+ client_id TEXT,
486
+ auth_url TEXT,
487
+ server_options TEXT
488
+ )
489
+ `;
490
+
491
+ const _onRequest = this.onRequest.bind(this);
492
+ this.onRequest = (request: Request) => {
493
+ return agentContext.run(
494
+ { agent: this, connection: undefined, request, email: undefined },
495
+ async () => {
496
+ if (this.mcp.isCallbackRequest(request)) {
497
+ const result = await this.mcp.handleCallbackRequest(request);
498
+ this.broadcastMcpServers();
499
+
500
+ if (result.authSuccess) {
501
+ // Start background connection if auth was successful
502
+ this.mcp
503
+ .establishConnection(result.serverId)
504
+ .catch((error) => {
505
+ console.error("Background connection failed:", error);
506
+ })
507
+ .finally(() => {
508
+ // Broadcast after background connection resolves (success/failure)
509
+ this.broadcastMcpServers();
510
+ });
511
+ }
512
+
513
+ // Handle OAuth callback response using MCPClientManager configuration
514
+ return this.handleOAuthCallbackResponse(result, request);
515
+ }
516
+
517
+ return this._tryCatch(() => _onRequest(request));
518
+ }
519
+ );
520
+ };
521
+
294
522
  const _onMessage = this.onMessage.bind(this);
295
523
  this.onMessage = async (connection: Connection, message: WSMessage) => {
296
- return unstable_context.run(
297
- { agent: this, connection, request: undefined },
524
+ return agentContext.run(
525
+ { agent: this, connection, request: undefined, email: undefined },
298
526
  async () => {
299
527
  if (typeof message !== "string") {
300
- return this.#tryCatch(() => _onMessage(connection, message));
528
+ return this._tryCatch(() => _onMessage(connection, message));
301
529
  }
302
530
 
303
531
  let parsed: unknown;
304
532
  try {
305
533
  parsed = JSON.parse(message);
306
- } catch (e) {
534
+ } catch (_e) {
307
535
  // silently fail and let the onMessage handler handle it
308
- return this.#tryCatch(() => _onMessage(connection, message));
536
+ return this._tryCatch(() => _onMessage(connection, message));
309
537
  }
310
538
 
311
539
  if (isStateUpdateMessage(parsed)) {
312
- this.#setStateInternal(parsed.state as State, connection);
540
+ this._setStateInternal(parsed.state as State, connection);
313
541
  return;
314
542
  }
315
543
 
@@ -323,11 +551,10 @@ export class Agent<Env, State = unknown> extends Server<Env> {
323
551
  throw new Error(`Method ${method} does not exist`);
324
552
  }
325
553
 
326
- if (!this.#isCallable(method)) {
554
+ if (!this._isCallable(method)) {
327
555
  throw new Error(`Method ${method} is not callable`);
328
556
  }
329
557
 
330
- // biome-ignore lint/complexity/noBannedTypes: <explanation>
331
558
  const metadata = callableMetadata.get(methodFn as Function);
332
559
 
333
560
  // For streaming methods, pass a StreamingResponse object
@@ -339,22 +566,37 @@ export class Agent<Env, State = unknown> extends Server<Env> {
339
566
 
340
567
  // For regular methods, execute and send response
341
568
  const result = await methodFn.apply(this, args);
569
+
570
+ this.observability?.emit(
571
+ {
572
+ displayMessage: `RPC call to ${method}`,
573
+ id: nanoid(),
574
+ payload: {
575
+ method,
576
+ streaming: metadata?.streaming
577
+ },
578
+ timestamp: Date.now(),
579
+ type: "rpc"
580
+ },
581
+ this.ctx
582
+ );
583
+
342
584
  const response: RPCResponse = {
343
- type: "rpc",
585
+ done: true,
344
586
  id,
345
- success: true,
346
587
  result,
347
- done: true,
588
+ success: true,
589
+ type: MessageType.RPC
348
590
  };
349
591
  connection.send(JSON.stringify(response));
350
592
  } catch (e) {
351
593
  // Send error response
352
594
  const response: RPCResponse = {
353
- type: "rpc",
354
- id: parsed.id,
355
- success: false,
356
595
  error:
357
596
  e instanceof Error ? e.message : "Unknown error occurred",
597
+ id: parsed.id,
598
+ success: false,
599
+ type: MessageType.RPC
358
600
  };
359
601
  connection.send(JSON.stringify(response));
360
602
  console.error("RPC error:", e);
@@ -362,7 +604,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
362
604
  return;
363
605
  }
364
606
 
365
- return this.#tryCatch(() => _onMessage(connection, message));
607
+ return this._tryCatch(() => _onMessage(connection, message));
366
608
  }
367
609
  );
368
610
  };
@@ -371,27 +613,110 @@ export class Agent<Env, State = unknown> extends Server<Env> {
371
613
  this.onConnect = (connection: Connection, ctx: ConnectionContext) => {
372
614
  // TODO: This is a hack to ensure the state is sent after the connection is established
373
615
  // must fix this
374
- return unstable_context.run(
375
- { agent: this, connection, request: ctx.request },
616
+ return agentContext.run(
617
+ { agent: this, connection, request: ctx.request, email: undefined },
618
+ () => {
619
+ if (this.state) {
620
+ connection.send(
621
+ JSON.stringify({
622
+ state: this.state,
623
+ type: MessageType.CF_AGENT_STATE
624
+ })
625
+ );
626
+ }
627
+
628
+ connection.send(
629
+ JSON.stringify({
630
+ mcp: this.getMcpServers(),
631
+ type: MessageType.CF_AGENT_MCP_SERVERS
632
+ })
633
+ );
634
+
635
+ this.observability?.emit(
636
+ {
637
+ displayMessage: "Connection established",
638
+ id: nanoid(),
639
+ payload: {
640
+ connectionId: connection.id
641
+ },
642
+ timestamp: Date.now(),
643
+ type: "connect"
644
+ },
645
+ this.ctx
646
+ );
647
+ return this._tryCatch(() => _onConnect(connection, ctx));
648
+ }
649
+ );
650
+ };
651
+
652
+ const _onStart = this.onStart.bind(this);
653
+ this.onStart = async (props?: Props) => {
654
+ return agentContext.run(
655
+ {
656
+ agent: this,
657
+ connection: undefined,
658
+ request: undefined,
659
+ email: undefined
660
+ },
376
661
  async () => {
377
- setTimeout(() => {
378
- if (this.state) {
379
- connection.send(
380
- JSON.stringify({
381
- type: "cf_agent_state",
382
- state: this.state,
383
- })
384
- );
662
+ await this._tryCatch(() => {
663
+ const servers = this.sql<MCPServerRow>`
664
+ SELECT id, name, server_url, client_id, auth_url, callback_url, server_options FROM cf_agents_mcp_servers;
665
+ `;
666
+
667
+ this.broadcastMcpServers();
668
+
669
+ // from DO storage, reconnect to all servers not currently in the oauth flow using our saved auth information
670
+ if (servers && Array.isArray(servers) && servers.length > 0) {
671
+ // Restore callback URLs for OAuth-enabled servers
672
+ servers.forEach((server) => {
673
+ if (server.callback_url) {
674
+ // Register the full redirect URL including serverId to avoid ambiguous matches
675
+ this.mcp.registerCallbackUrl(
676
+ `${server.callback_url}/${server.id}`
677
+ );
678
+ }
679
+ });
680
+
681
+ servers.forEach((server) => {
682
+ this._connectToMcpServerInternal(
683
+ server.name,
684
+ server.server_url,
685
+ server.callback_url,
686
+ server.server_options
687
+ ? JSON.parse(server.server_options)
688
+ : undefined,
689
+ {
690
+ id: server.id,
691
+ oauthClientId: server.client_id ?? undefined
692
+ }
693
+ )
694
+ .then(() => {
695
+ // Broadcast updated MCP servers state after each server connects
696
+ this.broadcastMcpServers();
697
+ })
698
+ .catch((error) => {
699
+ console.error(
700
+ `Error connecting to MCP server: ${server.name} (${server.server_url})`,
701
+ error
702
+ );
703
+ // Still broadcast even if connection fails, so clients know about the failure
704
+ this.broadcastMcpServers();
705
+ });
706
+ });
385
707
  }
386
- return this.#tryCatch(() => _onConnect(connection, ctx));
387
- }, 20);
708
+ return _onStart(props);
709
+ });
388
710
  }
389
711
  );
390
712
  };
391
713
  }
392
714
 
393
- #setStateInternal(state: State, source: Connection | "server" = "server") {
394
- this.#state = state;
715
+ private _setStateInternal(
716
+ state: State,
717
+ source: Connection | "server" = "server"
718
+ ) {
719
+ this._state = state;
395
720
  this.sql`
396
721
  INSERT OR REPLACE INTO cf_agents_state (id, state)
397
722
  VALUES (${STATE_ROW_ID}, ${JSON.stringify(state)})
@@ -402,16 +727,26 @@ export class Agent<Env, State = unknown> extends Server<Env> {
402
727
  `;
403
728
  this.broadcast(
404
729
  JSON.stringify({
405
- type: "cf_agent_state",
406
730
  state: state,
731
+ type: MessageType.CF_AGENT_STATE
407
732
  }),
408
733
  source !== "server" ? [source.id] : []
409
734
  );
410
- return this.#tryCatch(() => {
411
- const { connection, request } = unstable_context.getStore() || {};
412
- return unstable_context.run(
413
- { agent: this, connection, request },
735
+ return this._tryCatch(() => {
736
+ const { connection, request, email } = agentContext.getStore() || {};
737
+ return agentContext.run(
738
+ { agent: this, connection, request, email },
414
739
  async () => {
740
+ this.observability?.emit(
741
+ {
742
+ displayMessage: "State updated",
743
+ id: nanoid(),
744
+ payload: {},
745
+ timestamp: Date.now(),
746
+ type: "state:update"
747
+ },
748
+ this.ctx
749
+ );
415
750
  return this.onStateUpdate(state, source);
416
751
  }
417
752
  );
@@ -423,7 +758,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
423
758
  * @param state New state to set
424
759
  */
425
760
  setState(state: State) {
426
- this.#setStateInternal(state, "server");
761
+ this._setStateInternal(state, "server");
427
762
  }
428
763
 
429
764
  /**
@@ -431,24 +766,90 @@ export class Agent<Env, State = unknown> extends Server<Env> {
431
766
  * @param state Updated state
432
767
  * @param source Source of the state update ("server" or a client connection)
433
768
  */
769
+ // biome-ignore lint/correctness/noUnusedFunctionParameters: overridden later
434
770
  onStateUpdate(state: State | undefined, source: Connection | "server") {
435
771
  // override this to handle state updates
436
772
  }
437
773
 
438
774
  /**
439
- * Called when the Agent receives an email
775
+ * Called when the Agent receives an email via routeAgentEmail()
776
+ * Override this method to handle incoming emails
440
777
  * @param email Email message to process
441
778
  */
442
- onEmail(email: ForwardableEmailMessage) {
443
- return unstable_context.run(
444
- { agent: this, connection: undefined, request: undefined },
779
+ async _onEmail(email: AgentEmail) {
780
+ // nb: we use this roundabout way of getting to onEmail
781
+ // because of https://github.com/cloudflare/workerd/issues/4499
782
+ return agentContext.run(
783
+ { agent: this, connection: undefined, request: undefined, email: email },
445
784
  async () => {
446
- console.error("onEmail not implemented");
785
+ if ("onEmail" in this && typeof this.onEmail === "function") {
786
+ return this._tryCatch(() =>
787
+ (this.onEmail as (email: AgentEmail) => Promise<void>)(email)
788
+ );
789
+ } else {
790
+ console.log("Received email from:", email.from, "to:", email.to);
791
+ console.log("Subject:", email.headers.get("subject"));
792
+ console.log(
793
+ "Implement onEmail(email: AgentEmail): Promise<void> in your agent to process emails"
794
+ );
795
+ }
447
796
  }
448
797
  );
449
798
  }
450
799
 
451
- async #tryCatch<T>(fn: () => T | Promise<T>) {
800
+ /**
801
+ * Reply to an email
802
+ * @param email The email to reply to
803
+ * @param options Options for the reply
804
+ * @returns void
805
+ */
806
+ async replyToEmail(
807
+ email: AgentEmail,
808
+ options: {
809
+ fromName: string;
810
+ subject?: string | undefined;
811
+ body: string;
812
+ contentType?: string;
813
+ headers?: Record<string, string>;
814
+ }
815
+ ): Promise<void> {
816
+ return this._tryCatch(async () => {
817
+ const agentName = camelCaseToKebabCase(this._ParentClass.name);
818
+ const agentId = this.name;
819
+
820
+ const { createMimeMessage } = await import("mimetext");
821
+ const msg = createMimeMessage();
822
+ msg.setSender({ addr: email.to, name: options.fromName });
823
+ msg.setRecipient(email.from);
824
+ msg.setSubject(
825
+ options.subject || `Re: ${email.headers.get("subject")}` || "No subject"
826
+ );
827
+ msg.addMessage({
828
+ contentType: options.contentType || "text/plain",
829
+ data: options.body
830
+ });
831
+
832
+ const domain = email.from.split("@")[1];
833
+ const messageId = `<${agentId}@${domain}>`;
834
+ msg.setHeader("In-Reply-To", email.headers.get("Message-ID")!);
835
+ msg.setHeader("Message-ID", messageId);
836
+ msg.setHeader("X-Agent-Name", agentName);
837
+ msg.setHeader("X-Agent-ID", agentId);
838
+
839
+ if (options.headers) {
840
+ for (const [key, value] of Object.entries(options.headers)) {
841
+ msg.setHeader(key, value);
842
+ }
843
+ }
844
+ await email.reply({
845
+ from: email.to,
846
+ raw: msg.asRaw(),
847
+ to: email.from
848
+ });
849
+ });
850
+ }
851
+
852
+ private async _tryCatch<T>(fn: () => T | Promise<T>) {
452
853
  try {
453
854
  return await fn();
454
855
  } catch (e) {
@@ -456,6 +857,68 @@ export class Agent<Env, State = unknown> extends Server<Env> {
456
857
  }
457
858
  }
458
859
 
860
+ /**
861
+ * Automatically wrap custom methods with agent context
862
+ * This ensures getCurrentAgent() works in all custom methods without decorators
863
+ */
864
+ private _autoWrapCustomMethods() {
865
+ // Collect all methods from base prototypes (Agent and Server)
866
+ const basePrototypes = [Agent.prototype, Server.prototype];
867
+ const baseMethods = new Set<string>();
868
+ for (const baseProto of basePrototypes) {
869
+ let proto = baseProto;
870
+ while (proto && proto !== Object.prototype) {
871
+ const methodNames = Object.getOwnPropertyNames(proto);
872
+ for (const methodName of methodNames) {
873
+ baseMethods.add(methodName);
874
+ }
875
+ proto = Object.getPrototypeOf(proto);
876
+ }
877
+ }
878
+ // Get all methods from the current instance's prototype chain
879
+ let proto = Object.getPrototypeOf(this);
880
+ let depth = 0;
881
+ while (proto && proto !== Object.prototype && depth < 10) {
882
+ const methodNames = Object.getOwnPropertyNames(proto);
883
+ for (const methodName of methodNames) {
884
+ const descriptor = Object.getOwnPropertyDescriptor(proto, methodName);
885
+
886
+ // Skip if it's a private method, a base method, a getter, or not a function,
887
+ if (
888
+ baseMethods.has(methodName) ||
889
+ methodName.startsWith("_") ||
890
+ !descriptor ||
891
+ !!descriptor.get ||
892
+ typeof descriptor.value !== "function"
893
+ ) {
894
+ continue;
895
+ }
896
+
897
+ // Now, methodName is confirmed to be a custom method/function
898
+ // Wrap the custom method with context
899
+ const wrappedFunction = withAgentContext(
900
+ // biome-ignore lint/suspicious/noExplicitAny: I can't typescript
901
+ this[methodName as keyof this] as (...args: any[]) => any
902
+ // biome-ignore lint/suspicious/noExplicitAny: I can't typescript
903
+ ) as any;
904
+
905
+ // if the method is callable, copy the metadata from the original method
906
+ if (this._isCallable(methodName)) {
907
+ callableMetadata.set(
908
+ wrappedFunction,
909
+ callableMetadata.get(this[methodName as keyof this] as Function)!
910
+ );
911
+ }
912
+
913
+ // set the wrapped function on the prototype
914
+ this.constructor.prototype[methodName as keyof this] = wrappedFunction;
915
+ }
916
+
917
+ proto = Object.getPrototypeOf(proto);
918
+ depth++;
919
+ }
920
+ }
921
+
459
922
  override onError(
460
923
  connection: Connection,
461
924
  error: unknown
@@ -490,6 +953,131 @@ export class Agent<Env, State = unknown> extends Server<Env> {
490
953
  throw new Error("Not implemented");
491
954
  }
492
955
 
956
+ /**
957
+ * Queue a task to be executed in the future
958
+ * @param payload Payload to pass to the callback
959
+ * @param callback Name of the method to call
960
+ * @returns The ID of the queued task
961
+ */
962
+ async queue<T = unknown>(callback: keyof this, payload: T): Promise<string> {
963
+ const id = nanoid(9);
964
+ if (typeof callback !== "string") {
965
+ throw new Error("Callback must be a string");
966
+ }
967
+
968
+ if (typeof this[callback] !== "function") {
969
+ throw new Error(`this.${callback} is not a function`);
970
+ }
971
+
972
+ this.sql`
973
+ INSERT OR REPLACE INTO cf_agents_queues (id, payload, callback)
974
+ VALUES (${id}, ${JSON.stringify(payload)}, ${callback})
975
+ `;
976
+
977
+ void this._flushQueue().catch((e) => {
978
+ console.error("Error flushing queue:", e);
979
+ });
980
+
981
+ return id;
982
+ }
983
+
984
+ private _flushingQueue = false;
985
+
986
+ private async _flushQueue() {
987
+ if (this._flushingQueue) {
988
+ return;
989
+ }
990
+ this._flushingQueue = true;
991
+ while (true) {
992
+ const result = this.sql<QueueItem<string>>`
993
+ SELECT * FROM cf_agents_queues
994
+ ORDER BY created_at ASC
995
+ `;
996
+
997
+ if (!result || result.length === 0) {
998
+ break;
999
+ }
1000
+
1001
+ for (const row of result || []) {
1002
+ const callback = this[row.callback as keyof Agent<Env>];
1003
+ if (!callback) {
1004
+ console.error(`callback ${row.callback} not found`);
1005
+ continue;
1006
+ }
1007
+ const { connection, request, email } = agentContext.getStore() || {};
1008
+ await agentContext.run(
1009
+ {
1010
+ agent: this,
1011
+ connection,
1012
+ request,
1013
+ email
1014
+ },
1015
+ async () => {
1016
+ // TODO: add retries and backoff
1017
+ await (
1018
+ callback as (
1019
+ payload: unknown,
1020
+ queueItem: QueueItem<string>
1021
+ ) => Promise<void>
1022
+ ).bind(this)(JSON.parse(row.payload as string), row);
1023
+ await this.dequeue(row.id);
1024
+ }
1025
+ );
1026
+ }
1027
+ }
1028
+ this._flushingQueue = false;
1029
+ }
1030
+
1031
+ /**
1032
+ * Dequeue a task by ID
1033
+ * @param id ID of the task to dequeue
1034
+ */
1035
+ async dequeue(id: string) {
1036
+ this.sql`DELETE FROM cf_agents_queues WHERE id = ${id}`;
1037
+ }
1038
+
1039
+ /**
1040
+ * Dequeue all tasks
1041
+ */
1042
+ async dequeueAll() {
1043
+ this.sql`DELETE FROM cf_agents_queues`;
1044
+ }
1045
+
1046
+ /**
1047
+ * Dequeue all tasks by callback
1048
+ * @param callback Name of the callback to dequeue
1049
+ */
1050
+ async dequeueAllByCallback(callback: string) {
1051
+ this.sql`DELETE FROM cf_agents_queues WHERE callback = ${callback}`;
1052
+ }
1053
+
1054
+ /**
1055
+ * Get a queued task by ID
1056
+ * @param id ID of the task to get
1057
+ * @returns The task or undefined if not found
1058
+ */
1059
+ async getQueue(id: string): Promise<QueueItem<string> | undefined> {
1060
+ const result = this.sql<QueueItem<string>>`
1061
+ SELECT * FROM cf_agents_queues WHERE id = ${id}
1062
+ `;
1063
+ return result
1064
+ ? { ...result[0], payload: JSON.parse(result[0].payload) }
1065
+ : undefined;
1066
+ }
1067
+
1068
+ /**
1069
+ * Get all queues by key and value
1070
+ * @param key Key to filter by
1071
+ * @param value Value to filter by
1072
+ * @returns Array of matching QueueItem objects
1073
+ */
1074
+ async getQueues(key: string, value: string): Promise<QueueItem<string>[]> {
1075
+ const result = this.sql<QueueItem<string>>`
1076
+ SELECT * FROM cf_agents_queues
1077
+ `;
1078
+ return result.filter((row) => JSON.parse(row.payload)[key] === value);
1079
+ }
1080
+
493
1081
  /**
494
1082
  * Schedule a task to be executed in the future
495
1083
  * @template T Type of the payload data
@@ -505,6 +1093,21 @@ export class Agent<Env, State = unknown> extends Server<Env> {
505
1093
  ): Promise<Schedule<T>> {
506
1094
  const id = nanoid(9);
507
1095
 
1096
+ const emitScheduleCreate = (schedule: Schedule<T>) =>
1097
+ this.observability?.emit(
1098
+ {
1099
+ displayMessage: `Schedule ${schedule.id} created`,
1100
+ id: nanoid(),
1101
+ payload: {
1102
+ callback: callback as string,
1103
+ id: id
1104
+ },
1105
+ timestamp: Date.now(),
1106
+ type: "schedule:create"
1107
+ },
1108
+ this.ctx
1109
+ );
1110
+
508
1111
  if (typeof callback !== "string") {
509
1112
  throw new Error("Callback must be a string");
510
1113
  }
@@ -522,15 +1125,19 @@ export class Agent<Env, State = unknown> extends Server<Env> {
522
1125
  )}, 'scheduled', ${timestamp})
523
1126
  `;
524
1127
 
525
- await this.#scheduleNextAlarm();
1128
+ await this._scheduleNextAlarm();
526
1129
 
527
- return {
528
- id,
1130
+ const schedule: Schedule<T> = {
529
1131
  callback: callback,
1132
+ id,
530
1133
  payload: payload as T,
531
1134
  time: timestamp,
532
- type: "scheduled",
1135
+ type: "scheduled"
533
1136
  };
1137
+
1138
+ emitScheduleCreate(schedule);
1139
+
1140
+ return schedule;
534
1141
  }
535
1142
  if (typeof when === "number") {
536
1143
  const time = new Date(Date.now() + when * 1000);
@@ -543,16 +1150,20 @@ export class Agent<Env, State = unknown> extends Server<Env> {
543
1150
  )}, 'delayed', ${when}, ${timestamp})
544
1151
  `;
545
1152
 
546
- await this.#scheduleNextAlarm();
1153
+ await this._scheduleNextAlarm();
547
1154
 
548
- return {
549
- id,
1155
+ const schedule: Schedule<T> = {
550
1156
  callback: callback,
551
- payload: payload as T,
552
1157
  delayInSeconds: when,
1158
+ id,
1159
+ payload: payload as T,
553
1160
  time: timestamp,
554
- type: "delayed",
1161
+ type: "delayed"
555
1162
  };
1163
+
1164
+ emitScheduleCreate(schedule);
1165
+
1166
+ return schedule;
556
1167
  }
557
1168
  if (typeof when === "string") {
558
1169
  const nextExecutionTime = getNextCronTime(when);
@@ -565,16 +1176,20 @@ export class Agent<Env, State = unknown> extends Server<Env> {
565
1176
  )}, 'cron', ${when}, ${timestamp})
566
1177
  `;
567
1178
 
568
- await this.#scheduleNextAlarm();
1179
+ await this._scheduleNextAlarm();
569
1180
 
570
- return {
571
- id,
1181
+ const schedule: Schedule<T> = {
572
1182
  callback: callback,
573
- payload: payload as T,
574
1183
  cron: when,
1184
+ id,
1185
+ payload: payload as T,
575
1186
  time: timestamp,
576
- type: "cron",
1187
+ type: "cron"
577
1188
  };
1189
+
1190
+ emitScheduleCreate(schedule);
1191
+
1192
+ return schedule;
578
1193
  }
579
1194
  throw new Error("Invalid schedule type");
580
1195
  }
@@ -638,7 +1253,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
638
1253
  .toArray()
639
1254
  .map((row) => ({
640
1255
  ...row,
641
- payload: JSON.parse(row.payload as string) as T,
1256
+ payload: JSON.parse(row.payload as string) as T
642
1257
  })) as Schedule<T>[];
643
1258
 
644
1259
  return result;
@@ -650,18 +1265,34 @@ export class Agent<Env, State = unknown> extends Server<Env> {
650
1265
  * @returns true if the task was cancelled, false otherwise
651
1266
  */
652
1267
  async cancelSchedule(id: string): Promise<boolean> {
1268
+ const schedule = await this.getSchedule(id);
1269
+ if (schedule) {
1270
+ this.observability?.emit(
1271
+ {
1272
+ displayMessage: `Schedule ${id} cancelled`,
1273
+ id: nanoid(),
1274
+ payload: {
1275
+ callback: schedule.callback,
1276
+ id: schedule.id
1277
+ },
1278
+ timestamp: Date.now(),
1279
+ type: "schedule:cancel"
1280
+ },
1281
+ this.ctx
1282
+ );
1283
+ }
653
1284
  this.sql`DELETE FROM cf_agents_schedules WHERE id = ${id}`;
654
1285
 
655
- await this.#scheduleNextAlarm();
1286
+ await this._scheduleNextAlarm();
656
1287
  return true;
657
1288
  }
658
1289
 
659
- async #scheduleNextAlarm() {
1290
+ private async _scheduleNextAlarm() {
660
1291
  // Find the next schedule that needs to be executed
661
1292
  const result = this.sql`
662
- SELECT time FROM cf_agents_schedules
1293
+ SELECT time FROM cf_agents_schedules
663
1294
  WHERE time > ${Math.floor(Date.now() / 1000)}
664
- ORDER BY time ASC
1295
+ ORDER BY time ASC
665
1296
  LIMIT 1
666
1297
  `;
667
1298
  if (!result) return;
@@ -673,10 +1304,14 @@ export class Agent<Env, State = unknown> extends Server<Env> {
673
1304
  }
674
1305
 
675
1306
  /**
676
- * Method called when an alarm fires
677
- * Executes any scheduled tasks that are due
1307
+ * Method called when an alarm fires.
1308
+ * Executes any scheduled tasks that are due.
1309
+ *
1310
+ * @remarks
1311
+ * To schedule a task, please use the `this.schedule` method instead.
1312
+ * See {@link https://developers.cloudflare.com/agents/api-reference/schedule-tasks/}
678
1313
  */
679
- async alarm() {
1314
+ public readonly alarm = async () => {
680
1315
  const now = Math.floor(Date.now() / 1000);
681
1316
 
682
1317
  // Get all schedules that should be executed now
@@ -684,46 +1319,67 @@ export class Agent<Env, State = unknown> extends Server<Env> {
684
1319
  SELECT * FROM cf_agents_schedules WHERE time <= ${now}
685
1320
  `;
686
1321
 
687
- for (const row of result || []) {
688
- const callback = this[row.callback as keyof Agent<Env>];
689
- if (!callback) {
690
- console.error(`callback ${row.callback} not found`);
691
- continue;
692
- }
693
- await unstable_context.run(
694
- { agent: this, connection: undefined, request: undefined },
695
- async () => {
696
- try {
697
- await (
698
- callback as (
699
- payload: unknown,
700
- schedule: Schedule<unknown>
701
- ) => Promise<void>
702
- ).bind(this)(JSON.parse(row.payload as string), row);
703
- } catch (e) {
704
- console.error(`error executing callback "${row.callback}"`, e);
705
- }
1322
+ if (result && Array.isArray(result)) {
1323
+ for (const row of result) {
1324
+ const callback = this[row.callback as keyof Agent<Env>];
1325
+ if (!callback) {
1326
+ console.error(`callback ${row.callback} not found`);
1327
+ continue;
706
1328
  }
707
- );
708
- if (row.type === "cron") {
709
- // Update next execution time for cron schedules
710
- const nextExecutionTime = getNextCronTime(row.cron);
711
- const nextTimestamp = Math.floor(nextExecutionTime.getTime() / 1000);
1329
+ await agentContext.run(
1330
+ {
1331
+ agent: this,
1332
+ connection: undefined,
1333
+ request: undefined,
1334
+ email: undefined
1335
+ },
1336
+ async () => {
1337
+ try {
1338
+ this.observability?.emit(
1339
+ {
1340
+ displayMessage: `Schedule ${row.id} executed`,
1341
+ id: nanoid(),
1342
+ payload: {
1343
+ callback: row.callback,
1344
+ id: row.id
1345
+ },
1346
+ timestamp: Date.now(),
1347
+ type: "schedule:execute"
1348
+ },
1349
+ this.ctx
1350
+ );
712
1351
 
713
- this.sql`
1352
+ await (
1353
+ callback as (
1354
+ payload: unknown,
1355
+ schedule: Schedule<unknown>
1356
+ ) => Promise<void>
1357
+ ).bind(this)(JSON.parse(row.payload as string), row);
1358
+ } catch (e) {
1359
+ console.error(`error executing callback "${row.callback}"`, e);
1360
+ }
1361
+ }
1362
+ );
1363
+ if (row.type === "cron") {
1364
+ // Update next execution time for cron schedules
1365
+ const nextExecutionTime = getNextCronTime(row.cron);
1366
+ const nextTimestamp = Math.floor(nextExecutionTime.getTime() / 1000);
1367
+
1368
+ this.sql`
714
1369
  UPDATE cf_agents_schedules SET time = ${nextTimestamp} WHERE id = ${row.id}
715
1370
  `;
716
- } else {
717
- // Delete one-time schedules after execution
718
- this.sql`
1371
+ } else {
1372
+ // Delete one-time schedules after execution
1373
+ this.sql`
719
1374
  DELETE FROM cf_agents_schedules WHERE id = ${row.id}
720
1375
  `;
1376
+ }
721
1377
  }
722
1378
  }
723
1379
 
724
1380
  // Schedule the next alarm
725
- await this.#scheduleNextAlarm();
726
- }
1381
+ await this._scheduleNextAlarm();
1382
+ };
727
1383
 
728
1384
  /**
729
1385
  * Destroy the Agent, removing all state and scheduled tasks
@@ -732,22 +1388,266 @@ export class Agent<Env, State = unknown> extends Server<Env> {
732
1388
  // drop all tables
733
1389
  this.sql`DROP TABLE IF EXISTS cf_agents_state`;
734
1390
  this.sql`DROP TABLE IF EXISTS cf_agents_schedules`;
1391
+ this.sql`DROP TABLE IF EXISTS cf_agents_mcp_servers`;
1392
+ this.sql`DROP TABLE IF EXISTS cf_agents_queues`;
735
1393
 
736
1394
  // delete all alarms
737
1395
  await this.ctx.storage.deleteAlarm();
738
1396
  await this.ctx.storage.deleteAll();
1397
+ this._disposables.dispose();
1398
+ await this.mcp.dispose?.();
1399
+ this.ctx.abort("destroyed"); // enforce that the agent is evicted
1400
+
1401
+ this.observability?.emit(
1402
+ {
1403
+ displayMessage: "Agent destroyed",
1404
+ id: nanoid(),
1405
+ payload: {},
1406
+ timestamp: Date.now(),
1407
+ type: "destroy"
1408
+ },
1409
+ this.ctx
1410
+ );
739
1411
  }
740
1412
 
741
1413
  /**
742
1414
  * Get all methods marked as callable on this Agent
743
1415
  * @returns A map of method names to their metadata
744
1416
  */
745
- #isCallable(method: string): boolean {
746
- // biome-ignore lint/complexity/noBannedTypes: <explanation>
1417
+ private _isCallable(method: string): boolean {
747
1418
  return callableMetadata.has(this[method as keyof this] as Function);
748
1419
  }
1420
+
1421
+ /**
1422
+ * Connect to a new MCP Server
1423
+ *
1424
+ * @param serverName Name of the MCP server
1425
+ * @param url MCP Server SSE URL
1426
+ * @param callbackHost Base host for the agent, used for the redirect URI. If not provided, will be derived from the current request.
1427
+ * @param agentsPrefix agents routing prefix if not using `agents`
1428
+ * @param options MCP client and transport options
1429
+ * @returns authUrl
1430
+ */
1431
+ async addMcpServer(
1432
+ serverName: string,
1433
+ url: string,
1434
+ callbackHost?: string,
1435
+ agentsPrefix = "agents",
1436
+ options?: {
1437
+ client?: ConstructorParameters<typeof Client>[1];
1438
+ transport?: {
1439
+ headers?: HeadersInit;
1440
+ type?: TransportType;
1441
+ };
1442
+ }
1443
+ ): Promise<{ id: string; authUrl: string | undefined }> {
1444
+ // If callbackHost is not provided, derive it from the current request
1445
+ let resolvedCallbackHost = callbackHost;
1446
+ if (!resolvedCallbackHost) {
1447
+ const { request } = getCurrentAgent();
1448
+ if (!request) {
1449
+ throw new Error(
1450
+ "callbackHost is required when not called within a request context"
1451
+ );
1452
+ }
1453
+
1454
+ // Extract the origin from the request
1455
+ const requestUrl = new URL(request.url);
1456
+ resolvedCallbackHost = `${requestUrl.protocol}//${requestUrl.host}`;
1457
+ }
1458
+
1459
+ const callbackUrl = `${resolvedCallbackHost}/${agentsPrefix}/${camelCaseToKebabCase(this._ParentClass.name)}/${this.name}/callback`;
1460
+
1461
+ const result = await this._connectToMcpServerInternal(
1462
+ serverName,
1463
+ url,
1464
+ callbackUrl,
1465
+ options
1466
+ );
1467
+
1468
+ this.sql`
1469
+ INSERT
1470
+ OR REPLACE INTO cf_agents_mcp_servers (id, name, server_url, client_id, auth_url, callback_url, server_options)
1471
+ VALUES (
1472
+ ${result.id},
1473
+ ${serverName},
1474
+ ${url},
1475
+ ${result.clientId ?? null},
1476
+ ${result.authUrl ?? null},
1477
+ ${callbackUrl},
1478
+ ${options ? JSON.stringify(options) : null}
1479
+ );
1480
+ `;
1481
+
1482
+ this.broadcastMcpServers();
1483
+
1484
+ return result;
1485
+ }
1486
+
1487
+ private async _connectToMcpServerInternal(
1488
+ _serverName: string,
1489
+ url: string,
1490
+ callbackUrl: string,
1491
+ // it's important that any options here are serializable because we put them into our sqlite DB for reconnection purposes
1492
+ options?: {
1493
+ client?: ConstructorParameters<typeof Client>[1];
1494
+ /**
1495
+ * We don't expose the normal set of transport options because:
1496
+ * 1) we can't serialize things like the auth provider or a fetch function into the DB for reconnection purposes
1497
+ * 2) We probably want these options to be agnostic to the transport type (SSE vs Streamable)
1498
+ *
1499
+ * 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).
1500
+ */
1501
+ transport?: {
1502
+ headers?: HeadersInit;
1503
+ type?: TransportType;
1504
+ };
1505
+ },
1506
+ reconnect?: {
1507
+ id: string;
1508
+ oauthClientId?: string;
1509
+ }
1510
+ ): Promise<{
1511
+ id: string;
1512
+ authUrl: string | undefined;
1513
+ clientId: string | undefined;
1514
+ }> {
1515
+ const authProvider = new DurableObjectOAuthClientProvider(
1516
+ this.ctx.storage,
1517
+ this.name,
1518
+ callbackUrl
1519
+ );
1520
+
1521
+ if (reconnect) {
1522
+ authProvider.serverId = reconnect.id;
1523
+ if (reconnect.oauthClientId) {
1524
+ authProvider.clientId = reconnect.oauthClientId;
1525
+ }
1526
+ }
1527
+
1528
+ // Use the transport type specified in options, or default to "auto"
1529
+ const transportType: TransportType = options?.transport?.type ?? "auto";
1530
+
1531
+ // allows passing through transport headers if necessary
1532
+ // this handles some non-standard bearer auth setups (i.e. MCP server behind CF access instead of OAuth)
1533
+ let headerTransportOpts: SSEClientTransportOptions = {};
1534
+ if (options?.transport?.headers) {
1535
+ headerTransportOpts = {
1536
+ eventSourceInit: {
1537
+ fetch: (url, init) =>
1538
+ fetch(url, {
1539
+ ...init,
1540
+ headers: options?.transport?.headers
1541
+ })
1542
+ },
1543
+ requestInit: {
1544
+ headers: options?.transport?.headers
1545
+ }
1546
+ };
1547
+ }
1548
+
1549
+ const { id, authUrl, clientId } = await this.mcp.connect(url, {
1550
+ client: options?.client,
1551
+ reconnect,
1552
+ transport: {
1553
+ ...headerTransportOpts,
1554
+ authProvider,
1555
+ type: transportType
1556
+ }
1557
+ });
1558
+
1559
+ return {
1560
+ authUrl,
1561
+ clientId,
1562
+ id
1563
+ };
1564
+ }
1565
+
1566
+ async removeMcpServer(id: string) {
1567
+ this.mcp.closeConnection(id);
1568
+ this.mcp.unregisterCallbackUrl(id);
1569
+ this.sql`
1570
+ DELETE FROM cf_agents_mcp_servers WHERE id = ${id};
1571
+ `;
1572
+ this.broadcastMcpServers();
1573
+ }
1574
+
1575
+ getMcpServers(): MCPServersState {
1576
+ const mcpState: MCPServersState = {
1577
+ prompts: this.mcp.listPrompts(),
1578
+ resources: this.mcp.listResources(),
1579
+ servers: {},
1580
+ tools: this.mcp.listTools()
1581
+ };
1582
+
1583
+ const servers = this.sql<MCPServerRow>`
1584
+ SELECT id, name, server_url, client_id, auth_url, callback_url, server_options FROM cf_agents_mcp_servers;
1585
+ `;
1586
+
1587
+ if (servers && Array.isArray(servers) && servers.length > 0) {
1588
+ for (const server of servers) {
1589
+ const serverConn = this.mcp.mcpConnections[server.id];
1590
+ mcpState.servers[server.id] = {
1591
+ auth_url: server.auth_url,
1592
+ capabilities: serverConn?.serverCapabilities ?? null,
1593
+ instructions: serverConn?.instructions ?? null,
1594
+ name: server.name,
1595
+ server_url: server.server_url,
1596
+ // mark as "authenticating" because the server isn't automatically connected, so it's pending authenticating
1597
+ state: serverConn?.connectionState ?? "authenticating"
1598
+ };
1599
+ }
1600
+ }
1601
+
1602
+ return mcpState;
1603
+ }
1604
+
1605
+ private broadcastMcpServers() {
1606
+ this.broadcast(
1607
+ JSON.stringify({
1608
+ mcp: this.getMcpServers(),
1609
+ type: MessageType.CF_AGENT_MCP_SERVERS
1610
+ })
1611
+ );
1612
+ }
1613
+
1614
+ /**
1615
+ * Handle OAuth callback response using MCPClientManager configuration
1616
+ * @param result OAuth callback result
1617
+ * @param request The original request (needed for base URL)
1618
+ * @returns Response for the OAuth callback
1619
+ */
1620
+ private handleOAuthCallbackResponse(
1621
+ result: MCPClientOAuthResult,
1622
+ request: Request
1623
+ ): Response {
1624
+ const config = this.mcp.getOAuthCallbackConfig();
1625
+
1626
+ // Use custom handler if configured
1627
+ if (config?.customHandler) {
1628
+ return config.customHandler(result);
1629
+ }
1630
+
1631
+ // Use redirect URLs if configured
1632
+ if (config?.successRedirect && result.authSuccess) {
1633
+ return Response.redirect(config.successRedirect);
1634
+ }
1635
+
1636
+ if (config?.errorRedirect && !result.authSuccess) {
1637
+ return Response.redirect(
1638
+ `${config.errorRedirect}?error=${encodeURIComponent(result.authError || "Unknown error")}`
1639
+ );
1640
+ }
1641
+
1642
+ // Default behavior - redirect to base URL
1643
+ const baseUrl = new URL(request.url).origin;
1644
+ return Response.redirect(baseUrl);
1645
+ }
749
1646
  }
750
1647
 
1648
+ // A set of classes that have been wrapped with agent context
1649
+ const wrappedClasses = new Set<typeof Agent.prototype.constructor>();
1650
+
751
1651
  /**
752
1652
  * Namespace for creating Agent instances
753
1653
  * @template Agentic Type of the Agent class
@@ -785,17 +1685,17 @@ export async function routeAgentRequest<Env>(
785
1685
  const corsHeaders =
786
1686
  options?.cors === true
787
1687
  ? {
788
- "Access-Control-Allow-Origin": "*",
789
- "Access-Control-Allow-Methods": "GET, POST, HEAD, OPTIONS",
790
1688
  "Access-Control-Allow-Credentials": "true",
791
- "Access-Control-Max-Age": "86400",
1689
+ "Access-Control-Allow-Methods": "GET, POST, HEAD, OPTIONS",
1690
+ "Access-Control-Allow-Origin": "*",
1691
+ "Access-Control-Max-Age": "86400"
792
1692
  }
793
1693
  : options?.cors;
794
1694
 
795
1695
  if (request.method === "OPTIONS") {
796
1696
  if (corsHeaders) {
797
1697
  return new Response(null, {
798
- headers: corsHeaders,
1698
+ headers: corsHeaders
799
1699
  });
800
1700
  }
801
1701
  console.warn(
@@ -808,7 +1708,7 @@ export async function routeAgentRequest<Env>(
808
1708
  env as Record<string, unknown>,
809
1709
  {
810
1710
  prefix: "agents",
811
- ...(options as PartyServerOptions<Record<string, unknown>>),
1711
+ ...(options as PartyServerOptions<Record<string, unknown>>)
812
1712
  }
813
1713
  );
814
1714
 
@@ -821,24 +1721,238 @@ export async function routeAgentRequest<Env>(
821
1721
  response = new Response(response.body, {
822
1722
  headers: {
823
1723
  ...response.headers,
824
- ...corsHeaders,
825
- },
1724
+ ...corsHeaders
1725
+ }
826
1726
  });
827
1727
  }
828
1728
  return response;
829
1729
  }
830
1730
 
1731
+ export type EmailResolver<Env> = (
1732
+ email: ForwardableEmailMessage,
1733
+ env: Env
1734
+ ) => Promise<{
1735
+ agentName: string;
1736
+ agentId: string;
1737
+ } | null>;
1738
+
1739
+ /**
1740
+ * Create a resolver that uses the message-id header to determine the agent to route the email to
1741
+ * @returns A function that resolves the agent to route the email to
1742
+ */
1743
+ export function createHeaderBasedEmailResolver<Env>(): EmailResolver<Env> {
1744
+ return async (email: ForwardableEmailMessage, _env: Env) => {
1745
+ const messageId = email.headers.get("message-id");
1746
+ if (messageId) {
1747
+ const messageIdMatch = messageId.match(/<([^@]+)@([^>]+)>/);
1748
+ if (messageIdMatch) {
1749
+ const [, agentId, domain] = messageIdMatch;
1750
+ const agentName = domain.split(".")[0];
1751
+ return { agentName, agentId };
1752
+ }
1753
+ }
1754
+
1755
+ const references = email.headers.get("references");
1756
+ if (references) {
1757
+ const referencesMatch = references.match(
1758
+ /<([A-Za-z0-9+/]{43}=)@([^>]+)>/
1759
+ );
1760
+ if (referencesMatch) {
1761
+ const [, base64Id, domain] = referencesMatch;
1762
+ const agentId = Buffer.from(base64Id, "base64").toString("hex");
1763
+ const agentName = domain.split(".")[0];
1764
+ return { agentName, agentId };
1765
+ }
1766
+ }
1767
+
1768
+ const agentName = email.headers.get("x-agent-name");
1769
+ const agentId = email.headers.get("x-agent-id");
1770
+ if (agentName && agentId) {
1771
+ return { agentName, agentId };
1772
+ }
1773
+
1774
+ return null;
1775
+ };
1776
+ }
1777
+
1778
+ /**
1779
+ * Create a resolver that uses the email address to determine the agent to route the email to
1780
+ * @param defaultAgentName The default agent name to use if the email address does not contain a sub-address
1781
+ * @returns A function that resolves the agent to route the email to
1782
+ */
1783
+ export function createAddressBasedEmailResolver<Env>(
1784
+ defaultAgentName: string
1785
+ ): EmailResolver<Env> {
1786
+ return async (email: ForwardableEmailMessage, _env: Env) => {
1787
+ const emailMatch = email.to.match(/^([^+@]+)(?:\+([^@]+))?@(.+)$/);
1788
+ if (!emailMatch) {
1789
+ return null;
1790
+ }
1791
+
1792
+ const [, localPart, subAddress] = emailMatch;
1793
+
1794
+ if (subAddress) {
1795
+ return {
1796
+ agentName: localPart,
1797
+ agentId: subAddress
1798
+ };
1799
+ }
1800
+
1801
+ // Option 2: Use defaultAgentName namespace, localPart as agentId
1802
+ // Common for catch-all email routing to a single EmailAgent namespace
1803
+ return {
1804
+ agentName: defaultAgentName,
1805
+ agentId: localPart
1806
+ };
1807
+ };
1808
+ }
1809
+
1810
+ /**
1811
+ * Create a resolver that uses the agentName and agentId to determine the agent to route the email to
1812
+ * @param agentName The name of the agent to route the email to
1813
+ * @param agentId The id of the agent to route the email to
1814
+ * @returns A function that resolves the agent to route the email to
1815
+ */
1816
+ export function createCatchAllEmailResolver<Env>(
1817
+ agentName: string,
1818
+ agentId: string
1819
+ ): EmailResolver<Env> {
1820
+ return async () => ({ agentName, agentId });
1821
+ }
1822
+
1823
+ export type EmailRoutingOptions<Env> = AgentOptions<Env> & {
1824
+ resolver: EmailResolver<Env>;
1825
+ };
1826
+
1827
+ // Cache the agent namespace map for email routing
1828
+ // This maps both kebab-case and original names to namespaces
1829
+ const agentMapCache = new WeakMap<
1830
+ Record<string, unknown>,
1831
+ Record<string, unknown>
1832
+ >();
1833
+
831
1834
  /**
832
1835
  * Route an email to the appropriate Agent
833
- * @param email Email message to route
834
- * @param env Environment containing Agent bindings
835
- * @param options Routing options
1836
+ * @param email The email to route
1837
+ * @param env The environment containing the Agent bindings
1838
+ * @param options The options for routing the email
1839
+ * @returns A promise that resolves when the email has been routed
836
1840
  */
837
1841
  export async function routeAgentEmail<Env>(
838
1842
  email: ForwardableEmailMessage,
839
1843
  env: Env,
840
- options?: AgentOptions<Env>
841
- ): Promise<void> {}
1844
+ options: EmailRoutingOptions<Env>
1845
+ ): Promise<void> {
1846
+ const routingInfo = await options.resolver(email, env);
1847
+
1848
+ if (!routingInfo) {
1849
+ console.warn("No routing information found for email, dropping message");
1850
+ return;
1851
+ }
1852
+
1853
+ // Build a map that includes both original names and kebab-case versions
1854
+ if (!agentMapCache.has(env as Record<string, unknown>)) {
1855
+ const map: Record<string, unknown> = {};
1856
+ for (const [key, value] of Object.entries(env as Record<string, unknown>)) {
1857
+ if (
1858
+ value &&
1859
+ typeof value === "object" &&
1860
+ "idFromName" in value &&
1861
+ typeof value.idFromName === "function"
1862
+ ) {
1863
+ // Add both the original name and kebab-case version
1864
+ map[key] = value;
1865
+ map[camelCaseToKebabCase(key)] = value;
1866
+ }
1867
+ }
1868
+ agentMapCache.set(env as Record<string, unknown>, map);
1869
+ }
1870
+
1871
+ const agentMap = agentMapCache.get(env as Record<string, unknown>)!;
1872
+ const namespace = agentMap[routingInfo.agentName];
1873
+
1874
+ if (!namespace) {
1875
+ // Provide helpful error message listing available agents
1876
+ const availableAgents = Object.keys(agentMap)
1877
+ .filter((key) => !key.includes("-")) // Show only original names, not kebab-case duplicates
1878
+ .join(", ");
1879
+ throw new Error(
1880
+ `Agent namespace '${routingInfo.agentName}' not found in environment. Available agents: ${availableAgents}`
1881
+ );
1882
+ }
1883
+
1884
+ const agent = await getAgentByName(
1885
+ namespace as unknown as AgentNamespace<Agent<Env>>,
1886
+ routingInfo.agentId
1887
+ );
1888
+
1889
+ // let's make a serialisable version of the email
1890
+ const serialisableEmail: AgentEmail = {
1891
+ getRaw: async () => {
1892
+ const reader = email.raw.getReader();
1893
+ const chunks: Uint8Array[] = [];
1894
+
1895
+ let done = false;
1896
+ while (!done) {
1897
+ const { value, done: readerDone } = await reader.read();
1898
+ done = readerDone;
1899
+ if (value) {
1900
+ chunks.push(value);
1901
+ }
1902
+ }
1903
+
1904
+ const totalLength = chunks.reduce((sum, chunk) => sum + chunk.length, 0);
1905
+ const combined = new Uint8Array(totalLength);
1906
+ let offset = 0;
1907
+ for (const chunk of chunks) {
1908
+ combined.set(chunk, offset);
1909
+ offset += chunk.length;
1910
+ }
1911
+
1912
+ return combined;
1913
+ },
1914
+ headers: email.headers,
1915
+ rawSize: email.rawSize,
1916
+ setReject: (reason: string) => {
1917
+ email.setReject(reason);
1918
+ },
1919
+ forward: (rcptTo: string, headers?: Headers) => {
1920
+ return email.forward(rcptTo, headers);
1921
+ },
1922
+ reply: (options: { from: string; to: string; raw: string }) => {
1923
+ return email.reply(
1924
+ new EmailMessage(options.from, options.to, options.raw)
1925
+ );
1926
+ },
1927
+ from: email.from,
1928
+ to: email.to
1929
+ };
1930
+
1931
+ await agent._onEmail(serialisableEmail);
1932
+ }
1933
+
1934
+ export type AgentEmail = {
1935
+ from: string;
1936
+ to: string;
1937
+ getRaw: () => Promise<Uint8Array>;
1938
+ headers: Headers;
1939
+ rawSize: number;
1940
+ setReject: (reason: string) => void;
1941
+ forward: (rcptTo: string, headers?: Headers) => Promise<void>;
1942
+ reply: (options: { from: string; to: string; raw: string }) => Promise<void>;
1943
+ };
1944
+
1945
+ export type EmailSendOptions = {
1946
+ to: string;
1947
+ subject: string;
1948
+ body: string;
1949
+ contentType?: string;
1950
+ headers?: Record<string, string>;
1951
+ includeRoutingHeaders?: boolean;
1952
+ agentName?: string;
1953
+ agentId?: string;
1954
+ domain?: string;
1955
+ };
842
1956
 
843
1957
  /**
844
1958
  * Get or create an Agent by name
@@ -849,12 +1963,17 @@ export async function routeAgentEmail<Env>(
849
1963
  * @param options Options for Agent creation
850
1964
  * @returns Promise resolving to an Agent instance stub
851
1965
  */
852
- export function getAgentByName<Env, T extends Agent<Env>>(
1966
+ export async function getAgentByName<
1967
+ Env,
1968
+ T extends Agent<Env>,
1969
+ Props extends Record<string, unknown> = Record<string, unknown>
1970
+ >(
853
1971
  namespace: AgentNamespace<T>,
854
1972
  name: string,
855
1973
  options?: {
856
1974
  jurisdiction?: DurableObjectJurisdiction;
857
1975
  locationHint?: DurableObjectLocationHint;
1976
+ props?: Props;
858
1977
  }
859
1978
  ) {
860
1979
  return getServerByName<Env, T>(namespace, name, options);
@@ -864,13 +1983,13 @@ export function getAgentByName<Env, T extends Agent<Env>>(
864
1983
  * A wrapper for streaming responses in callable methods
865
1984
  */
866
1985
  export class StreamingResponse {
867
- #connection: Connection;
868
- #id: string;
869
- #closed = false;
1986
+ private _connection: Connection;
1987
+ private _id: string;
1988
+ private _closed = false;
870
1989
 
871
1990
  constructor(connection: Connection, id: string) {
872
- this.#connection = connection;
873
- this.#id = id;
1991
+ this._connection = connection;
1992
+ this._id = id;
874
1993
  }
875
1994
 
876
1995
  /**
@@ -878,17 +1997,17 @@ export class StreamingResponse {
878
1997
  * @param chunk The data to send
879
1998
  */
880
1999
  send(chunk: unknown) {
881
- if (this.#closed) {
2000
+ if (this._closed) {
882
2001
  throw new Error("StreamingResponse is already closed");
883
2002
  }
884
2003
  const response: RPCResponse = {
885
- type: "rpc",
886
- id: this.#id,
887
- success: true,
888
- result: chunk,
889
2004
  done: false,
2005
+ id: this._id,
2006
+ result: chunk,
2007
+ success: true,
2008
+ type: MessageType.RPC
890
2009
  };
891
- this.#connection.send(JSON.stringify(response));
2010
+ this._connection.send(JSON.stringify(response));
892
2011
  }
893
2012
 
894
2013
  /**
@@ -896,17 +2015,17 @@ export class StreamingResponse {
896
2015
  * @param finalChunk Optional final chunk of data to send
897
2016
  */
898
2017
  end(finalChunk?: unknown) {
899
- if (this.#closed) {
2018
+ if (this._closed) {
900
2019
  throw new Error("StreamingResponse is already closed");
901
2020
  }
902
- this.#closed = true;
2021
+ this._closed = true;
903
2022
  const response: RPCResponse = {
904
- type: "rpc",
905
- id: this.#id,
906
- success: true,
907
- result: finalChunk,
908
2023
  done: true,
2024
+ id: this._id,
2025
+ result: finalChunk,
2026
+ success: true,
2027
+ type: MessageType.RPC
909
2028
  };
910
- this.#connection.send(JSON.stringify(response));
2029
+ this._connection.send(JSON.stringify(response));
911
2030
  }
912
2031
  }