agents 0.0.0-d72c6a2 → 0.0.0-d7a460e

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