feat: report usage and cost if available (#595)

Author: ereslibre

packages/agent/src/commands/run.ts

@@ -11,6 +11,7 @@ import {
   type StepResult,
   type WorkflowRunner,
   type OnStepComplete,
+  type UsageReport,
 } from 'rover-core';
 import {
   ROVER_LOG_FILENAME,
@@ -26,6 +27,35 @@ import { createAgent } from '../lib/agents/index.js';
 import { cpSync, existsSync, mkdirSync, readFileSync } from 'node:fs';
 import { join } from 'node:path';
 
+/**
+ * Build display properties for a UsageReport, if any metrics are present.
+ */
+function usageProperties(
+  usage: UsageReport | undefined
+): Record<string, string> {
+  const props: Record<string, string> = {};
+  if (!usage) return props;
+
+  if (usage.inputTokens !== undefined) {
+    props['Input Tokens'] = colors.cyan(usage.inputTokens.toLocaleString());
+  }
+  if (usage.outputTokens !== undefined) {
+    props['Output Tokens'] = colors.cyan(usage.outputTokens.toLocaleString());
+  }
+  if (usage.totalTokens !== undefined) {
+    props['Total Tokens'] = colors.cyan(usage.totalTokens.toLocaleString());
+  }
+  if (usage.cost !== undefined) {
+    const currency = usage.currency ?? 'USD';
+    props['Cost'] = colors.yellow(`${usage.cost.toFixed(4)} ${currency}`);
+  }
+  if (usage.model) {
+    props['Model'] = colors.gray(usage.model);
+  }
+
+  return props;
+}
+
 /**
  * Helper function to display step results consistently
  */
@@ -40,6 +70,7 @@ function displayStepResults(
     ID: colors.cyan(result.id),
     Status: result.success ? colors.green('✓ Success') : colors.red('✗ Failed'),
     Duration: colors.yellow(`${result.duration.toFixed(2)}s`),
+    ...usageProperties(result.usage),
   };
 
   if (result.error) {
@@ -494,6 +525,7 @@ export const runCommand = async (
           'Failed Steps': colors.red(failedSteps.toString()),
           'Skipped Steps': colors.yellow(skippedSteps.toString()),
           Status: status,
+          ...usageProperties(runResult.usage),
         });
 
         // Mark workflow as completed in status file

packages/agent/src/lib/__tests__/acp-provider.test.ts

@@ -1,7 +1,7 @@
 import { describe, it, expect, vi, beforeEach } from 'vitest';
 
 vi.mock('../acp-invoke.js', () => ({
-  acpInvoke: vi.fn().mockResolvedValue('mock response'),
+  acpInvoke: vi.fn().mockResolvedValue({ response: 'mock response' }),
 }));
 
 vi.mock('rover-prompts', () => ({
@@ -42,7 +42,7 @@ const mockedAcpInvoke = vi.mocked(acpInvoke);
 describe('ACPProvider', () => {
   beforeEach(() => {
     mockedAcpInvoke.mockClear();
-    mockedAcpInvoke.mockResolvedValue('mock response');
+    mockedAcpInvoke.mockResolvedValue({ response: 'mock response' });
   });
 
   describe('systemPrompt', () => {

packages/agent/src/lib/acp-invoke.ts

@@ -15,6 +15,8 @@ import colors from 'ansi-colors';
 import { VERBOSE, launch } from 'rover-core';
 import { ACPClient } from './acp-client.js';
 import { GeminiOrQwenACPClient } from './gemini-or-qwen-acp-client.js';
+import type { InvokeResult } from 'rover-core';
+import type { UsageReport } from 'rover-schemas';
 
 /**
  * Format an error into a human-readable string.
@@ -134,9 +136,11 @@ export interface ACPInvokeConfig {
 /**
  * One-shot ACP invocation: spawn agent -> init -> session -> prompt -> capture -> cleanup.
  *
- * Returns the captured agent response text.
+ * Returns the captured agent response text along with usage metrics.
  */
-export async function acpInvoke(config: ACPInvokeConfig): Promise<string> {
+export async function acpInvoke(
+  config: ACPInvokeConfig
+): Promise<InvokeResult> {
   const { agentName, prompt, cwd, model, systemPrompt } = config;
 
   const finalPrompt = systemPrompt
@@ -278,7 +282,41 @@ export async function acpInvoke(config: ACPInvokeConfig): Promise<string> {
 
     const response = client.stopCapturing(sessionId);
 
-    return response;
+    // Extract usage metrics from the ACP response and client cost tracking
+    let usage: UsageReport | undefined;
+
+    const promptUsage = promptResult.usage;
+    const promptCost = client.getLastPromptCost(sessionId);
+
+    if (promptUsage || promptCost.amount > 0) {
+      const inputTokens = promptUsage?.inputTokens
+        ? Number(promptUsage.inputTokens)
+        : undefined;
+      const outputTokens = promptUsage?.outputTokens
+        ? Number(promptUsage.outputTokens)
+        : undefined;
+      const cachedRead = promptUsage?.cachedReadTokens
+        ? Number(promptUsage.cachedReadTokens)
+        : 0;
+      const cachedWrite = promptUsage?.cachedWriteTokens
+        ? Number(promptUsage.cachedWriteTokens)
+        : 0;
+
+      const totalTokens =
+        inputTokens !== undefined || outputTokens !== undefined
+          ? (inputTokens ?? 0) + (outputTokens ?? 0) + cachedRead + cachedWrite
+          : undefined;
+
+      usage = {
+        inputTokens,
+        outputTokens,
+        totalTokens,
+        cost: promptCost.amount > 0 ? promptCost.amount : undefined,
+        currency: promptCost.amount > 0 ? promptCost.currency : undefined,
+      };
+    }
+
+    return { response, usage };
   } catch (error) {
     if (VERBOSE) {
       console.error(colors.red('[ACP] Error:'), colors.red(formatError(error)));

packages/agent/src/lib/acp-provider.ts

@@ -14,6 +14,7 @@ import { UserSettingsManager } from 'rover-core';
 import { acpInvoke } from './acp-invoke.js';
 import { parseJsonResponse } from './json-parser.js';
 import { PromptBuilder, type IPromptTask } from 'rover-prompts';
+import type { InvokeResult } from 'rover-core';
 
 export interface ACPProviderConfig {
   /** Agent name (claude, codex, cursor, gemini, qwen, copilot, opencode). */
@@ -51,7 +52,8 @@ export class ACPProvider {
   }
 
   /**
-   * Send a prompt to the agent via ACP and return the response.
+   * Send a prompt to the agent via ACP and return the response
+   * along with usage metrics.
    */
   async invoke(
     prompt: string,
@@ -61,7 +63,7 @@ export class ACPProvider {
       model?: string;
       systemPrompt?: string;
     } = {}
-  ): Promise<string> {
+  ): Promise<InvokeResult> {
     const { json = false, cwd, model, systemPrompt } = options;
 
     let finalPrompt = prompt;
@@ -94,11 +96,11 @@ You MUST output a valid JSON string as an output. Just output the JSON string an
     );
 
     try {
-      const response = await this.invoke(prompt, {
+      const result = await this.invoke(prompt, {
         json: true,
         cwd: projectPath,
       });
-      return parseJsonResponse<IPromptTask>(response);
+      return parseJsonResponse<IPromptTask>(result.response);
     } catch (error) {
       console.error(`Failed to expand task with ${this.agentName}:`, error);
       return null;
@@ -122,8 +124,8 @@ You MUST output a valid JSON string as an output. Just output the JSON string an
     );
 
     try {
-      const response = await this.invoke(prompt, { json: true });
-      return parseJsonResponse<IPromptTask>(response);
+      const result = await this.invoke(prompt, { json: true });
+      return parseJsonResponse<IPromptTask>(result.response);
     } catch (error) {
       console.error(
         `Failed to expand iteration instructions with ${this.agentName}:`,
@@ -149,14 +151,14 @@ You MUST output a valid JSON string as an output. Just output the JSON string an
         recentCommits,
         summaries
       );
-      const response = await this.invoke(prompt);
+      const result = await this.invoke(prompt);
 
-      if (!response) {
+      if (!result.response) {
         return null;
       }
 
       // Clean up the response to get just the commit message
-      const lines = response
+      const lines = result.response
         .split('\n')
         .filter((line: string) => line.trim() !== '');
       return lines[0] || null;
@@ -179,9 +181,9 @@ You MUST output a valid JSON string as an output. Just output the JSON string an
         diffContext,
         conflictedContent
       );
-      const response = await this.invoke(prompt);
+      const result = await this.invoke(prompt);
 
-      return response;
+      return result.response;
     } catch (err) {
       return null;
     }
@@ -200,8 +202,8 @@ You MUST output a valid JSON string as an output. Just output the JSON string an
     );
 
     try {
-      const response = await this.invoke(prompt, { json: true });
-      return parseJsonResponse<Record<string, any>>(response);
+      const result = await this.invoke(prompt, { json: true });
+      return parseJsonResponse<Record<string, any>>(result.response);
     } catch (error) {
       console.error(
         `Failed to extract GitHub inputs with ${this.agentName}:`,

packages/agent/src/lib/acp-runner.ts

@@ -31,6 +31,7 @@ import {
   showList,
   type StepResult,
 } from 'rover-core';
+import type { UsageReport } from 'rover-schemas';
 import { ACPClient } from './acp-client.js';
 import { GeminiOrQwenACPClient } from './gemini-or-qwen-acp-client.js';
 import { createAgent } from './agents/index.js';
@@ -286,8 +287,7 @@ export class ACPRunner {
   ): Promise<{
     stopReason: string;
     response: string;
-    tokens?: number;
-    cost?: number;
+    usage?: UsageReport;
   }> {
     if (!this.isConnectionInitialized || !this.connection) {
       throw new Error(
@@ -380,18 +380,43 @@ export class ACPRunner {
       const response = this.client.stopCapturing(sessionId);
 
       // Extract usage stats from the ACP response
-      const tokens = promptResult.usage
-        ? (promptResult.usage.inputTokens ?? 0) +
-          (promptResult.usage.outputTokens ?? 0) +
-          (promptResult.usage.cachedReadTokens ?? 0) +
-          (promptResult.usage.cachedWriteTokens ?? 0)
-        : undefined;
-
-      // Get per-prompt cost delta from the client's tracked usage_update events
+      let usage: UsageReport | undefined;
+
+      const promptUsage = promptResult.usage;
       const promptCost = this.client.getLastPromptCost(sessionId);
-      const cost = promptCost.amount > 0 ? promptCost.amount : undefined;
 
-      return { stopReason: promptResult.stopReason, response, tokens, cost };
+      if (promptUsage || promptCost.amount > 0) {
+        const inputTokens = promptUsage?.inputTokens
+          ? Number(promptUsage.inputTokens)
+          : undefined;
+        const outputTokens = promptUsage?.outputTokens
+          ? Number(promptUsage.outputTokens)
+          : undefined;
+        const cachedRead = promptUsage?.cachedReadTokens
+          ? Number(promptUsage.cachedReadTokens)
+          : 0;
+        const cachedWrite = promptUsage?.cachedWriteTokens
+          ? Number(promptUsage.cachedWriteTokens)
+          : 0;
+
+        const totalTokens =
+          inputTokens !== undefined || outputTokens !== undefined
+            ? (inputTokens ?? 0) +
+              (outputTokens ?? 0) +
+              cachedRead +
+              cachedWrite
+            : undefined;
+
+        usage = {
+          inputTokens,
+          outputTokens,
+          totalTokens,
+          cost: promptCost.amount > 0 ? promptCost.amount : undefined,
+          currency: promptCost.amount > 0 ? promptCost.currency : undefined,
+        };
+      }
+
+      return { stopReason: promptResult.stopReason, response, usage };
     } catch (error) {
       console.log(
         colors.red('[ACP] Prompt failed:'),
@@ -547,11 +572,14 @@ export class ACPRunner {
       // Send the prompt via ACP session
       const promptResult = await this.sendPrompt(sessionId, prompt);
 
-      // Track usage stats from ACP response
-      const tokens = promptResult.tokens;
-      const cost = promptResult.cost;
-      // Use the model set for this step, or the default model
+      // Build usage report from ACP response
       const model = stepModel || this.defaultModel;
+      let usage: UsageReport | undefined = promptResult.usage;
+      if (usage) {
+        usage = { ...usage, model };
+      } else if (model) {
+        usage = { model };
+      }
 
       if (VERBOSE) {
         console.log(
@@ -588,18 +616,19 @@ export class ACPRunner {
         stepName: step.name,
         agent: this.tool,
         duration,
-        tokens,
-        cost,
-        model,
+        tokens: usage?.totalTokens,
+        inputTokens: usage?.inputTokens,
+        outputTokens: usage?.outputTokens,
+        cost: usage?.cost,
+        currency: usage?.currency,
+        model: usage?.model,
       });
 
       return {
         id: step.id,
         success: true,
         duration,
-        tokens,
-        cost,
-        model,
+        usage,
         outputs,
       };
     } catch (error) {

packages/agent/src/lib/agents/claude.ts

@@ -189,7 +189,7 @@ export class ClaudeAgent extends BaseAgent {
   }
 
   toolArguments(): string[] {
-    return ['-y', '@zed-industries/claude-code-acp'];
+    return ['-y', '@zed-industries/claude-agent-acp'];
   }
 
   toolInteractiveArguments(

packages/cli/src/lib/agents/acp-agent-base.ts

@@ -12,7 +12,7 @@
  * - getEnvironmentVariables(): Docker environment variables
  */
 
-import { launch } from 'rover-core';
+import { launch, type InvokeResult } from 'rover-core';
 import type { WorkflowInput } from 'rover-schemas';
 import { ACPProvider, type IPromptTask } from '@endorhq/agent';
 
@@ -42,7 +42,7 @@ export abstract class ACPAgentBase {
   async invoke(
     prompt: string,
     options: { json?: boolean; cwd?: string; model?: string } = {}
-  ): Promise<string> {
+  ): Promise<InvokeResult> {
     try {
       return await this.provider.invoke(prompt, options);
     } catch (error) {