agents 0.0.0-e48e5f9 → 0.0.0-e75ec71

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