agents 0.0.0-feef082 → 0.0.0-ff45307

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