agents 0.2.13 → 0.2.15

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