agents 0.0.0-ac0e999 → 0.0.0-ac74811

package/src/index.ts

@@ -1,34 +1,31 @@
+import { AsyncLocalStorage } from "node:async_hooks";
+import type { Client } from "@modelcontextprotocol/sdk/client/index.js";
+import type { SSEClientTransportOptions } from "@modelcontextprotocol/sdk/client/sse.js";
+
+import type {
+  Prompt,
+  Resource,
+  ServerCapabilities,
+  Tool,
+} from "@modelcontextprotocol/sdk/types.js";
+import { parseCronExpression } from "cron-schedule";
+import { nanoid } from "nanoid";
 import {
-  Server,
-  routePartykitRequest,
-  type PartyServerOptions,
-  getServerByName,
   type Connection,
   type ConnectionContext,
+  getServerByName,
+  type PartyServerOptions,
+  routePartykitRequest,
+  Server,
   type WSMessage,
 } from "partyserver";
-
-import { parseCronExpression } from "cron-schedule";
-import { nanoid } from "nanoid";
-
-import { AsyncLocalStorage } from "node:async_hooks";
-import { MCPClientManager } from "./mcp/client";
-import {
-  DurableObjectOAuthClientProvider,
-  type AgentsOAuthProvider,
-} from "./mcp/do-oauth-client-provider";
-import type {
-  Tool,
-  Resource,
-  Prompt,
-} from "@modelcontextprotocol/sdk/types.js";
-
-import type { Client } from "@modelcontextprotocol/sdk/client/index.js";
-import type { SSEClientTransportOptions } from "@modelcontextprotocol/sdk/client/sse.js";
-
 import { camelCaseToKebabCase } from "./client";
+import { MCPClientManager } from "./mcp/client";
+// import type { MCPClientConnection } from "./mcp/client-connection";
+import { DurableObjectOAuthClientProvider } from "./mcp/do-oauth-client-provider";
+import { genericObservability, type Observability } from "./observability";
 
-export type { Connection, WSMessage, ConnectionContext } from "partyserver";
+export type { Connection, ConnectionContext, WSMessage } from "partyserver";
 
 /**
  * RPC request message from client
@@ -112,7 +109,6 @@ export type CallableMetadata = {
   streaming?: boolean;
 };
 
-// biome-ignore lint/complexity/noBannedTypes: <explanation>
 const callableMetadata = new Map<Function, CallableMetadata>();
 
 /**
@@ -122,6 +118,7 @@ const callableMetadata = new Map<Function, CallableMetadata>();
 export function unstable_callable(metadata: CallableMetadata = {}) {
   return function callableDecorator<This, Args extends unknown[], Return>(
     target: (this: This, ...args: Args) => Return,
+    // biome-ignore lint/correctness/noUnusedFunctionParameters: later
     context: ClassMethodDecoratorContext
   ) {
     if (!callableMetadata.has(target)) {
@@ -194,7 +191,12 @@ export type MCPServer = {
   name: string;
   server_url: string;
   auth_url: string | null;
+  // This state is specifically about the temporary process of getting a token (if needed).
+  // Scope outside of that can't be relied upon because when the DO sleeps, there's no way
+  // to communicate a change to a non-ready state.
   state: "authenticating" | "connecting" | "ready" | "discovering" | "failed";
+  instructions: string | null;
+  capabilities: ServerCapabilities | null;
 };
 
 /**
@@ -253,10 +255,10 @@ export function getCurrentAgent<
 export class Agent<Env, State = unknown> extends Server<Env> {
   private _state = DEFAULT_STATE as State;
 
-  private ParentClass: typeof Agent<Env, State> =
+  private _ParentClass: typeof Agent<Env, State> =
     Object.getPrototypeOf(this).constructor;
 
-  mcp: MCPClientManager = new MCPClientManager(this.ParentClass.name, "0.0.1");
+  mcp: MCPClientManager = new MCPClientManager(this._ParentClass.name, "0.0.1");
 
   /**
    * Initial state for the Agent
@@ -315,6 +317,11 @@ export class Agent<Env, State = unknown> extends Server<Env> {
     hibernate: true, // default to hibernate
   };
 
+  /**
+   * The observability implementation to use for the Agent
+   */
+  observability?: Observability = genericObservability;
+
   /**
    * Execute SQL queries against the Agent's database
    * @template T Type of the returned rows
@@ -352,7 +359,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
     `;
 
     void this.ctx.blockConcurrencyWhile(async () => {
-      return this.tryCatch(async () => {
+      return this._tryCatch(async () => {
         // Create alarms table if it doesn't exist
         this.sql`
         CREATE TABLE IF NOT EXISTS cf_agents_schedules (
@@ -395,19 +402,19 @@ export class Agent<Env, State = unknown> extends Server<Env> {
             // after the MCP connection handshake, we can send updated mcp state
             this.broadcast(
               JSON.stringify({
+                mcp: this.getMcpServers(),
                 type: "cf_agent_mcp_servers",
-                mcp: this.#getMcpServerStateInternal(),
               })
             );
 
             // We probably should let the user configure this response/redirect, but this is fine for now.
             return new Response("<script>window.close();</script>", {
-              status: 200,
               headers: { "content-type": "text/html" },
+              status: 200,
             });
           }
 
-          return this.tryCatch(() => _onRequest(request));
+          return this._tryCatch(() => _onRequest(request));
         }
       );
     };
@@ -418,19 +425,19 @@ export class Agent<Env, State = unknown> extends Server<Env> {
         { agent: this, connection, request: undefined },
         async () => {
           if (typeof message !== "string") {
-            return this.tryCatch(() => _onMessage(connection, message));
+            return this._tryCatch(() => _onMessage(connection, message));
           }
 
           let parsed: unknown;
           try {
             parsed = JSON.parse(message);
-          } catch (e) {
+          } catch (_e) {
             // silently fail and let the onMessage handler handle it
-            return this.tryCatch(() => _onMessage(connection, message));
+            return this._tryCatch(() => _onMessage(connection, message));
           }
 
           if (isStateUpdateMessage(parsed)) {
-            this.setStateInternal(parsed.state as State, connection);
+            this._setStateInternal(parsed.state as State, connection);
             return;
           }
 
@@ -444,11 +451,10 @@ export class Agent<Env, State = unknown> extends Server<Env> {
                 throw new Error(`Method ${method} does not exist`);
               }
 
-              if (!this.isCallable(method)) {
+              if (!this._isCallable(method)) {
                 throw new Error(`Method ${method} is not callable`);
               }
 
-              // biome-ignore lint/complexity/noBannedTypes: <explanation>
               const metadata = callableMetadata.get(methodFn as Function);
 
               // For streaming methods, pass a StreamingResponse object
@@ -460,22 +466,39 @@ export class Agent<Env, State = unknown> extends Server<Env> {
 
               // For regular methods, execute and send response
               const result = await methodFn.apply(this, args);
+
+              this.observability?.emit(
+                {
+                  displayMessage: `RPC call to ${method}`,
+                  id: nanoid(),
+                  payload: {
+                    args,
+                    method,
+                    streaming: metadata?.streaming,
+                    success: true,
+                  },
+                  timestamp: Date.now(),
+                  type: "rpc",
+                },
+                this.ctx
+              );
+
               const response: RPCResponse = {
-                type: "rpc",
+                done: true,
                 id,
-                success: true,
                 result,
-                done: true,
+                success: true,
+                type: "rpc",
               };
               connection.send(JSON.stringify(response));
             } catch (e) {
               // Send error response
               const response: RPCResponse = {
-                type: "rpc",
-                id: parsed.id,
-                success: false,
                 error:
                   e instanceof Error ? e.message : "Unknown error occurred",
+                id: parsed.id,
+                success: false,
+                type: "rpc",
               };
               connection.send(JSON.stringify(response));
               console.error("RPC error:", e);
@@ -483,7 +506,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
             return;
           }
 
-          return this.tryCatch(() => _onMessage(connection, message));
+          return this._tryCatch(() => _onMessage(connection, message));
         }
       );
     };
@@ -499,20 +522,32 @@ export class Agent<Env, State = unknown> extends Server<Env> {
             if (this.state) {
               connection.send(
                 JSON.stringify({
-                  type: "cf_agent_state",
                   state: this.state,
+                  type: "cf_agent_state",
                 })
               );
             }
 
             connection.send(
               JSON.stringify({
+                mcp: this.getMcpServers(),
                 type: "cf_agent_mcp_servers",
-                mcp: this.#getMcpServerStateInternal(),
               })
             );
 
-            return this.tryCatch(() => _onConnect(connection, ctx));
+            this.observability?.emit(
+              {
+                displayMessage: "Connection established",
+                id: nanoid(),
+                payload: {
+                  connectionId: connection.id,
+                },
+                timestamp: Date.now(),
+                type: "connect",
+              },
+              this.ctx
+            );
+            return this._tryCatch(() => _onConnect(connection, ctx));
           }, 20);
         }
       );
@@ -527,10 +562,10 @@ export class Agent<Env, State = unknown> extends Server<Env> {
             SELECT id, name, server_url, client_id, auth_url, callback_url, server_options FROM cf_agents_mcp_servers;
           `;
 
-          // from DO storage, reconnect to all servers using our saved auth information
-          await Promise.allSettled(
+          // from DO storage, reconnect to all servers not currently in the oauth flow using our saved auth information
+          Promise.allSettled(
             servers.map((server) => {
-              return this.#connectToMcpServerInternal(
+              return this._connectToMcpServerInternal(
                 server.name,
                 server.server_url,
                 server.callback_url,
@@ -543,25 +578,25 @@ export class Agent<Env, State = unknown> extends Server<Env> {
                 }
               );
             })
-          );
-
-          this.broadcast(
-            JSON.stringify({
-              type: "cf_agent_mcp_servers",
-              mcp: this.#getMcpServerStateInternal(),
-            })
-          );
-
-          await this.tryCatch(() => _onStart());
+          ).then((_results) => {
+            this.broadcast(
+              JSON.stringify({
+                mcp: this.getMcpServers(),
+                type: "cf_agent_mcp_servers",
+              })
+            );
+          });
+          await this._tryCatch(() => _onStart());
         }
       );
     };
   }
 
-  private setStateInternal(
+  private _setStateInternal(
     state: State,
     source: Connection | "server" = "server"
   ) {
+    const previousState = this._state;
     this._state = state;
     this.sql`
     INSERT OR REPLACE INTO cf_agents_state (id, state)
@@ -573,16 +608,29 @@ export class Agent<Env, State = unknown> extends Server<Env> {
   `;
     this.broadcast(
       JSON.stringify({
-        type: "cf_agent_state",
         state: state,
+        type: "cf_agent_state",
       }),
       source !== "server" ? [source.id] : []
     );
-    return this.tryCatch(() => {
+    return this._tryCatch(() => {
       const { connection, request } = agentContext.getStore() || {};
       return agentContext.run(
         { agent: this, connection, request },
         async () => {
+          this.observability?.emit(
+            {
+              displayMessage: "State updated",
+              id: nanoid(),
+              payload: {
+                previousState,
+                state,
+              },
+              timestamp: Date.now(),
+              type: "state:update",
+            },
+            this.ctx
+          );
           return this.onStateUpdate(state, source);
         }
       );
@@ -594,7 +642,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
    * @param state New state to set
    */
   setState(state: State) {
-    this.setStateInternal(state, "server");
+    this._setStateInternal(state, "server");
   }
 
   /**
@@ -602,6 +650,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
    * @param state Updated state
    * @param source Source of the state update ("server" or a client connection)
    */
+  // biome-ignore lint/correctness/noUnusedFunctionParameters: overridden later
   onStateUpdate(state: State | undefined, source: Connection | "server") {
     // override this to handle state updates
   }
@@ -610,6 +659,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
    * Called when the Agent receives an email
    * @param email Email message to process
    */
+  // biome-ignore lint/correctness/noUnusedFunctionParameters: overridden later
   onEmail(email: ForwardableEmailMessage) {
     return agentContext.run(
       { agent: this, connection: undefined, request: undefined },
@@ -619,7 +669,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
     );
   }
 
-  private async tryCatch<T>(fn: () => T | Promise<T>) {
+  private async _tryCatch<T>(fn: () => T | Promise<T>) {
     try {
       return await fn();
     } catch (e) {
@@ -676,6 +726,18 @@ export class Agent<Env, State = unknown> extends Server<Env> {
   ): Promise<Schedule<T>> {
     const id = nanoid(9);
 
+    const emitScheduleCreate = (schedule: Schedule<T>) =>
+      this.observability?.emit(
+        {
+          displayMessage: `Schedule ${schedule.id} created`,
+          id: nanoid(),
+          payload: schedule,
+          timestamp: Date.now(),
+          type: "schedule:create",
+        },
+        this.ctx
+      );
+
     if (typeof callback !== "string") {
       throw new Error("Callback must be a string");
     }
@@ -693,15 +755,19 @@ export class Agent<Env, State = unknown> extends Server<Env> {
         )}, 'scheduled', ${timestamp})
       `;
 
-      await this.scheduleNextAlarm();
+      await this._scheduleNextAlarm();
 
-      return {
-        id,
+      const schedule: Schedule<T> = {
         callback: callback,
+        id,
         payload: payload as T,
         time: timestamp,
         type: "scheduled",
       };
+
+      emitScheduleCreate(schedule);
+
+      return schedule;
     }
     if (typeof when === "number") {
       const time = new Date(Date.now() + when * 1000);
@@ -714,16 +780,20 @@ export class Agent<Env, State = unknown> extends Server<Env> {
         )}, 'delayed', ${when}, ${timestamp})
       `;
 
-      await this.scheduleNextAlarm();
+      await this._scheduleNextAlarm();
 
-      return {
-        id,
+      const schedule: Schedule<T> = {
         callback: callback,
-        payload: payload as T,
         delayInSeconds: when,
+        id,
+        payload: payload as T,
         time: timestamp,
         type: "delayed",
       };
+
+      emitScheduleCreate(schedule);
+
+      return schedule;
     }
     if (typeof when === "string") {
       const nextExecutionTime = getNextCronTime(when);
@@ -736,16 +806,20 @@ export class Agent<Env, State = unknown> extends Server<Env> {
         )}, 'cron', ${when}, ${timestamp})
       `;
 
-      await this.scheduleNextAlarm();
+      await this._scheduleNextAlarm();
 
-      return {
-        id,
+      const schedule: Schedule<T> = {
         callback: callback,
-        payload: payload as T,
         cron: when,
+        id,
+        payload: payload as T,
         time: timestamp,
         type: "cron",
       };
+
+      emitScheduleCreate(schedule);
+
+      return schedule;
     }
     throw new Error("Invalid schedule type");
   }
@@ -821,13 +895,26 @@ export class Agent<Env, State = unknown> extends Server<Env> {
    * @returns true if the task was cancelled, false otherwise
    */
   async cancelSchedule(id: string): Promise<boolean> {
+    const schedule = await this.getSchedule(id);
+    if (schedule) {
+      this.observability?.emit(
+        {
+          displayMessage: `Schedule ${id} cancelled`,
+          id: nanoid(),
+          payload: schedule,
+          timestamp: Date.now(),
+          type: "schedule:cancel",
+        },
+        this.ctx
+      );
+    }
     this.sql`DELETE FROM cf_agents_schedules WHERE id = ${id}`;
 
-    await this.scheduleNextAlarm();
+    await this._scheduleNextAlarm();
     return true;
   }
 
-  private async scheduleNextAlarm() {
+  private async _scheduleNextAlarm() {
     // Find the next schedule that needs to be executed
     const result = this.sql`
       SELECT time FROM cf_agents_schedules 
@@ -869,6 +956,17 @@ export class Agent<Env, State = unknown> extends Server<Env> {
         { agent: this, connection: undefined, request: undefined },
         async () => {
           try {
+            this.observability?.emit(
+              {
+                displayMessage: `Schedule ${row.id} executed`,
+                id: nanoid(),
+                payload: row,
+                timestamp: Date.now(),
+                type: "schedule:execute",
+              },
+              this.ctx
+            );
+
             await (
               callback as (
                 payload: unknown,
@@ -897,7 +995,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
     }
 
     // Schedule the next alarm
-    await this.scheduleNextAlarm();
+    await this._scheduleNextAlarm();
   };
 
   /**
@@ -912,10 +1010,25 @@ export class Agent<Env, State = unknown> extends Server<Env> {
     // delete all alarms
     await this.ctx.storage.deleteAlarm();
     await this.ctx.storage.deleteAll();
+    this.ctx.abort("destroyed"); // enforce that the agent is evicted
+
+    this.observability?.emit(
+      {
+        displayMessage: "Agent destroyed",
+        id: nanoid(),
+        payload: {},
+        timestamp: Date.now(),
+        type: "destroy",
+      },
+      this.ctx
+    );
   }
 
-  private isCallable(method: string): boolean {
-    // biome-ignore lint/complexity/noBannedTypes: <explanation>
+  /**
+   * Get all methods marked as callable on this Agent
+   * @returns A map of method names to their metadata
+   */
+  private _isCallable(method: string): boolean {
     return callableMetadata.has(this[method as keyof this] as Function);
   }
 
@@ -940,27 +1053,40 @@ export class Agent<Env, State = unknown> extends Server<Env> {
       };
     }
   ): Promise<{ id: string; authUrl: string | undefined }> {
-    const callbackUrl = `${callbackHost}/${agentsPrefix}/${camelCaseToKebabCase(this.ParentClass.name)}/${this.name}/callback`;
+    const callbackUrl = `${callbackHost}/${agentsPrefix}/${camelCaseToKebabCase(this._ParentClass.name)}/${this.name}/callback`;
 
-    const result = await this.#connectToMcpServerInternal(
+    const result = await this._connectToMcpServerInternal(
       serverName,
       url,
       callbackUrl,
       options
     );
+    this.sql`
+        INSERT
+        OR REPLACE INTO cf_agents_mcp_servers (id, name, server_url, client_id, auth_url, callback_url, server_options)
+      VALUES (
+        ${result.id},
+        ${serverName},
+        ${url},
+        ${result.clientId ?? null},
+        ${result.authUrl ?? null},
+        ${callbackUrl},
+        ${options ? JSON.stringify(options) : null}
+        );
+    `;
 
     this.broadcast(
       JSON.stringify({
+        mcp: this.getMcpServers(),
         type: "cf_agent_mcp_servers",
-        mcp: this.#getMcpServerStateInternal(),
       })
     );
 
     return result;
   }
 
-  async #connectToMcpServerInternal(
-    serverName: string,
+  async _connectToMcpServerInternal(
+    _serverName: string,
     url: string,
     callbackUrl: string,
     // it's important that any options here are serializable because we put them into our sqlite DB for reconnection purposes
@@ -981,7 +1107,11 @@ export class Agent<Env, State = unknown> extends Server<Env> {
       id: string;
       oauthClientId?: string;
     }
-  ): Promise<{ id: string; authUrl: string | undefined }> {
+  ): Promise<{
+    id: string;
+    authUrl: string | undefined;
+    clientId: string | undefined;
+  }> {
     const authProvider = new DurableObjectOAuthClientProvider(
       this.ctx.storage,
       this.name,
@@ -1014,30 +1144,18 @@ export class Agent<Env, State = unknown> extends Server<Env> {
     }
 
     const { id, authUrl, clientId } = await this.mcp.connect(url, {
+      client: options?.client,
       reconnect,
       transport: {
         ...headerTransportOpts,
         authProvider,
       },
-      client: options?.client,
     });
 
-    this.sql`
-      INSERT OR REPLACE INTO cf_agents_mcp_servers (id, name, server_url, client_id, auth_url, callback_url, server_options)
-      VALUES (
-        ${id},
-        ${serverName},
-        ${url},
-        ${clientId ?? null},
-        ${authUrl ?? null},
-        ${callbackUrl},
-        ${options ? JSON.stringify(options) : null}
-      );
-    `;
-
     return {
-      id,
       authUrl,
+      clientId,
+      id,
     };
   }
 
@@ -1048,18 +1166,18 @@ export class Agent<Env, State = unknown> extends Server<Env> {
     `;
     this.broadcast(
       JSON.stringify({
+        mcp: this.getMcpServers(),
         type: "cf_agent_mcp_servers",
-        mcp: this.#getMcpServerStateInternal(),
       })
     );
   }
 
-  #getMcpServerStateInternal(): MCPServersState {
+  getMcpServers(): MCPServersState {
     const mcpState: MCPServersState = {
-      servers: {},
-      tools: this.mcp.listTools(),
       prompts: this.mcp.listPrompts(),
       resources: this.mcp.listResources(),
+      servers: {},
+      tools: this.mcp.listTools(),
     };
 
     const servers = this.sql<MCPServerRow>`
@@ -1067,11 +1185,15 @@ export class Agent<Env, State = unknown> extends Server<Env> {
     `;
 
     for (const server of servers) {
+      const serverConn = this.mcp.mcpConnections[server.id];
       mcpState.servers[server.id] = {
+        auth_url: server.auth_url,
+        capabilities: serverConn?.serverCapabilities ?? null,
+        instructions: serverConn?.instructions ?? null,
         name: server.name,
         server_url: server.server_url,
-        auth_url: server.auth_url,
-        state: this.mcp.mcpConnections[server.id].connectionState,
+        // mark as "authenticating" because the server isn't automatically connected, so it's pending authenticating
+        state: serverConn?.connectionState ?? "authenticating",
       };
     }
 
@@ -1116,9 +1238,9 @@ export async function routeAgentRequest<Env>(
   const corsHeaders =
     options?.cors === true
       ? {
-          "Access-Control-Allow-Origin": "*",
-          "Access-Control-Allow-Methods": "GET, POST, HEAD, OPTIONS",
           "Access-Control-Allow-Credentials": "true",
+          "Access-Control-Allow-Methods": "GET, POST, HEAD, OPTIONS",
+          "Access-Control-Allow-Origin": "*",
           "Access-Control-Max-Age": "86400",
         }
       : options?.cors;
@@ -1166,9 +1288,9 @@ export async function routeAgentRequest<Env>(
  * @param options Routing options
  */
 export async function routeAgentEmail<Env>(
-  email: ForwardableEmailMessage,
-  env: Env,
-  options?: AgentOptions<Env>
+  _email: ForwardableEmailMessage,
+  _env: Env,
+  _options?: AgentOptions<Env>
 ): Promise<void> {}
 
 /**
@@ -1195,13 +1317,13 @@ export async function getAgentByName<Env, T extends Agent<Env>>(
  * A wrapper for streaming responses in callable methods
  */
 export class StreamingResponse {
-  private connection: Connection;
-  private id: string;
-  private closed = false;
+  private _connection: Connection;
+  private _id: string;
+  private _closed = false;
 
   constructor(connection: Connection, id: string) {
-    this.connection = connection;
-    this.id = id;
+    this._connection = connection;
+    this._id = id;
   }
 
   /**
@@ -1209,17 +1331,17 @@ export class StreamingResponse {
    * @param chunk The data to send
    */
   send(chunk: unknown) {
-    if (this.closed) {
+    if (this._closed) {
       throw new Error("StreamingResponse is already closed");
     }
     const response: RPCResponse = {
-      type: "rpc",
-      id: this.id,
-      success: true,
-      result: chunk,
       done: false,
+      id: this._id,
+      result: chunk,
+      success: true,
+      type: "rpc",
     };
-    this.connection.send(JSON.stringify(response));
+    this._connection.send(JSON.stringify(response));
   }
 
   /**
@@ -1227,17 +1349,17 @@ export class StreamingResponse {
    * @param finalChunk Optional final chunk of data to send
    */
   end(finalChunk?: unknown) {
-    if (this.closed) {
+    if (this._closed) {
       throw new Error("StreamingResponse is already closed");
     }
-    this.closed = true;
+    this._closed = true;
     const response: RPCResponse = {
-      type: "rpc",
-      id: this.id,
-      success: true,
-      result: finalChunk,
       done: true,
+      id: this._id,
+      result: finalChunk,
+      success: true,
+      type: "rpc",
     };
-    this.connection.send(JSON.stringify(response));
+    this._connection.send(JSON.stringify(response));
   }
 }