agents 0.0.0-54e1986 → 0.0.0-569680f

package/src/index.ts

@@ -1,34 +1,32 @@
+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 { EmailMessage } from "cloudflare:email";
 import {
-  Server,
-  routePartykitRequest,
-  type PartyServerOptions,
-  getServerByName,
   type Connection,
   type ConnectionContext,
+  type PartyServerOptions,
+  Server,
   type WSMessage,
+  getServerByName,
+  routePartykitRequest,
 } 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 +110,6 @@ export type CallableMetadata = {
   streaming?: boolean;
 };
 
-// biome-ignore lint/complexity/noBannedTypes: <explanation>
 const callableMetadata = new Map<Function, CallableMetadata>();
 
 /**
@@ -122,6 +119,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 +192,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;
 };
 
 /**
@@ -315,6 +318,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
@@ -395,15 +403,15 @@ 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,
             });
           }
 
@@ -424,7 +432,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
           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));
           }
@@ -448,7 +456,6 @@ export class Agent<Env, State = unknown> extends Server<Env> {
                 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 +467,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);
@@ -499,19 +523,31 @@ 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(),
               })
             );
 
+            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,8 +563,8 @@ 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(
                 server.name,
@@ -543,15 +579,14 @@ export class Agent<Env, State = unknown> extends Server<Env> {
                 }
               );
             })
-          );
-
-          this.broadcast(
-            JSON.stringify({
-              type: "cf_agent_mcp_servers",
-              mcp: this._getMcpServerStateInternal(),
-            })
-          );
-
+          ).then((_results) => {
+            this.broadcast(
+              JSON.stringify({
+                mcp: this.getMcpServers(),
+                type: "cf_agent_mcp_servers",
+              })
+            );
+          });
           await this._tryCatch(() => _onStart());
         }
       );
@@ -562,6 +597,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
     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,8 +609,8 @@ 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] : []
     );
@@ -583,6 +619,19 @@ export class Agent<Env, State = unknown> extends Server<Env> {
       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);
         }
       );
@@ -602,23 +651,44 @@ 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
   }
 
   /**
    * Called when the Agent receives an email
+   * Override this method to handle incoming emails
    * @param email Email message to process
    */
-  onEmail(email: ForwardableEmailMessage) {
+  async onEmail(email: ForwardableEmailMessage) {
     return agentContext.run(
       { agent: this, connection: undefined, request: undefined },
       async () => {
-        console.error("onEmail not implemented");
+        console.log("Received email from:", email.from, "to:", email.to);
+        console.log("Subject:", email.headers.get("subject"));
+        console.log("Override onEmail() in your agent to process emails");
       }
     );
   }
 
+  async sendEmail(
+    emailBinding: SendEmail,
+    from: string,
+    fromName: string,
+    options: Omit<EmailSendOptions, "agentName" | "agentId">
+  ): Promise<void> {
+    const agentName = camelCaseToKebabCase(this._ParentClass.name);
+    const agentId = this.name;
+
+    return sendEmailWithRouting(emailBinding, from, fromName, {
+      ...options,
+      agentName,
+      agentId,
+      includeRoutingHeaders: true,
+    });
+  }
+
   private async _tryCatch<T>(fn: () => T | Promise<T>) {
     try {
       return await fn();
@@ -676,6 +746,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");
     }
@@ -695,13 +777,17 @@ export class Agent<Env, State = unknown> extends Server<Env> {
 
       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);
@@ -716,14 +802,18 @@ export class Agent<Env, State = unknown> extends Server<Env> {
 
       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);
@@ -738,14 +828,18 @@ export class Agent<Env, State = unknown> extends Server<Env> {
 
       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,6 +915,19 @@ 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();
@@ -869,6 +976,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,
@@ -912,10 +1030,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
+    );
   }
 
+  /**
+   * Get all methods marked as callable on this Agent
+   * @returns A map of method names to their metadata
+   */
   private _isCallable(method: string): boolean {
-    // biome-ignore lint/complexity/noBannedTypes: <explanation>
     return callableMetadata.has(this[method as keyof this] as Function);
   }
 
@@ -948,11 +1081,24 @@ export class Agent<Env, State = unknown> extends Server<Env> {
       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(),
       })
     );
 
@@ -960,7 +1106,7 @@ export class Agent<Env, State = unknown> extends Server<Env> {
   }
 
   async _connectToMcpServerInternal(
-    serverName: string,
+    _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 +1127,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 +1164,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 +1186,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(),
       })
     );
   }
 
-  private _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 +1205,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 +1258,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;
@@ -1159,17 +1301,170 @@ export async function routeAgentRequest<Env>(
   return response;
 }
 
-/**
- * Route an email to the appropriate Agent
- * @param email Email message to route
- * @param env Environment containing Agent bindings
- * @param options Routing options
- */
+export type EmailResolver<Env> = (
+  email: ForwardableEmailMessage,
+  env: Env
+) => Promise<{
+  agentName: string;
+  agentId: string;
+} | null>;
+
+export function createHeaderBasedResolver<Env>(): EmailResolver<Env> {
+  return async (email: ForwardableEmailMessage, _env: Env) => {
+    const messageId = email.headers.get("message-id");
+    if (messageId) {
+      const messageIdMatch = messageId.match(/<([^@]+)@([^>]+)>/);
+      if (messageIdMatch) {
+        const [, agentId, domain] = messageIdMatch;
+        const agentName = domain.split(".")[0];
+        return { agentName, agentId };
+      }
+    }
+
+    const references = email.headers.get("references");
+    if (references) {
+      const referencesMatch = references.match(
+        /<([A-Za-z0-9+/]{43}=)@([^>]+)>/
+      );
+      if (referencesMatch) {
+        const [, base64Id, domain] = referencesMatch;
+        const agentId = Buffer.from(base64Id, "base64").toString("hex");
+        const agentName = domain.split(".")[0];
+        return { agentName, agentId };
+      }
+    }
+
+    const agentName = email.headers.get("x-agent-name");
+    const agentId = email.headers.get("x-agent-id");
+    if (agentName && agentId) {
+      return { agentName, agentId };
+    }
+
+    return null;
+  };
+}
+
+export function createAddressBasedResolver<Env>(
+  defaultAgentName: string
+): EmailResolver<Env> {
+  return async (email: ForwardableEmailMessage, _env: Env) => {
+    const emailMatch = email.to.match(/^([^+@]+)(?:\+([^@]+))?@(.+)$/);
+    if (!emailMatch) {
+      return null;
+    }
+
+    const [, localPart, subAddress] = emailMatch;
+
+    if (subAddress) {
+      return {
+        agentName: localPart,
+        agentId: subAddress,
+      };
+    }
+
+    // Option 2: Use defaultAgentName namespace, localPart as agentId
+    // Common for catch-all email routing to a single EmailAgent namespace
+    return {
+      agentName: defaultAgentName,
+      agentId: localPart,
+    };
+  };
+}
+
+export function createCatchAllResolver<Env>(
+  agentName: string,
+  agentId: string
+): EmailResolver<Env> {
+  return async () => ({ agentName, agentId });
+}
+
+export type EmailRoutingOptions<Env> = AgentOptions<Env> & {
+  resolver: EmailResolver<Env>;
+};
+
 export async function routeAgentEmail<Env>(
   email: ForwardableEmailMessage,
   env: Env,
-  options?: AgentOptions<Env>
-): Promise<void> {}
+  options: EmailRoutingOptions<Env>
+): Promise<void> {
+  const routingInfo = await options.resolver(email, env);
+
+  if (!routingInfo) {
+    console.warn("No routing information found for email, dropping message");
+    return;
+  }
+
+  const namespaceBinding = env[routingInfo.agentName as keyof Env];
+  if (!namespaceBinding) {
+    console.error(
+      `Agent namespace '${routingInfo.agentName}' not found in environment`
+    );
+    return;
+  }
+
+  // Type guard to check if this is actually a DurableObjectNamespace (AgentNamespace)
+  if (
+    typeof namespaceBinding !== "object" ||
+    !("idFromName" in namespaceBinding) ||
+    typeof namespaceBinding.idFromName !== "function"
+  ) {
+    console.error(
+      `Environment binding '${routingInfo.agentName}' is not an AgentNamespace (found: ${typeof namespaceBinding})`
+    );
+    return;
+  }
+
+  // Safe cast after runtime validation
+  const namespace = namespaceBinding as unknown as AgentNamespace<Agent<Env>>;
+
+  const agent = await getAgentByName(namespace, routingInfo.agentId);
+  await agent.onEmail(email);
+}
+
+export type EmailSendOptions = {
+  to: string;
+  subject: string;
+  body: string;
+  contentType?: string;
+  headers?: Record<string, string>;
+  includeRoutingHeaders?: boolean;
+  agentName?: string;
+  agentId?: string;
+  domain?: string;
+};
+
+export async function sendEmailWithRouting(
+  emailBinding: SendEmail,
+  from: string,
+  fromName: string,
+  options: EmailSendOptions
+): Promise<void> {
+  const { createMimeMessage } = await import("mimetext");
+  const msg = createMimeMessage();
+  msg.setSender({ addr: from, name: fromName });
+  msg.setRecipient(options.to);
+  msg.setSubject(options.subject);
+  msg.addMessage({
+    contentType: options.contentType || "text/plain",
+    data: options.body,
+  });
+
+  if (options.includeRoutingHeaders && options.agentName && options.agentId) {
+    const domain = options.domain || from.split("@")[1];
+    const messageId = `<${options.agentId}@${domain}>`;
+    msg.setHeader("Message-ID", messageId);
+    msg.setHeader("X-Agent-Name", options.agentName);
+    msg.setHeader("X-Agent-ID", options.agentId);
+  }
+
+  if (options.headers) {
+    for (const [key, value] of Object.entries(options.headers)) {
+      msg.setHeader(key, value);
+    }
+  }
+
+  await emailBinding.send(new EmailMessage(from, options.to, msg.asRaw()));
+}
 
 /**
  * Get or create an Agent by name
@@ -1213,11 +1508,11 @@ export class StreamingResponse {
       throw new Error("StreamingResponse is already closed");
     }
     const response: RPCResponse = {
-      type: "rpc",
+      done: false,
       id: this._id,
-      success: true,
       result: chunk,
-      done: false,
+      success: true,
+      type: "rpc",
     };
     this._connection.send(JSON.stringify(response));
   }
@@ -1232,11 +1527,11 @@ export class StreamingResponse {
     }
     this._closed = true;
     const response: RPCResponse = {
-      type: "rpc",
+      done: true,
       id: this._id,
-      success: true,
       result: finalChunk,
-      done: true,
+      success: true,
+      type: "rpc",
     };
     this._connection.send(JSON.stringify(response));
   }