chore: refine capture output

Author: dkattan

agents.md

@@ -32,7 +32,6 @@ This is a VS Code extension that integrates with GitHub Copilot to provide debug
 - **Extension entry point**: `src/extension.ts` - Main activation logic and tool registration
 - **Language Model Tools**: Classes implementing VS Code's `LanguageModelTool` interface
   - `StartDebuggerTool` - Thin wrapper; delegates validation & launch resolution to `startDebuggingAndWaitForStop`
-  - `WaitForBreakpointTool` - Waits for breakpoint hits using Debug Adapter Protocol monitoring
   - `GetVariablesTool` - Retrieves all variables from active debug sessions using DAP
   - `ExpandVariableTool` - Expands specific variables to show detailed contents and immediate children
 - **Tool registration**: Registers tools with VS Code's language model system via `vscode.lm.registerTool()`
@@ -50,7 +49,6 @@ This is a VS Code extension that integrates with GitHub Copilot to provide debug
 
 - `src/extension.ts` - Main extension logic, activation, and tool registration only
 - `src/startDebuggerTool.ts` - StartDebuggerTool class and interface
-- `src/waitForBreakpointTool.ts` - WaitForBreakpointTool class and interface (requires debug-tracker-vscode)
 - `src/debugUtils.ts` - Shared DAP interfaces, types, and DAPHelpers utility class
 - `src/getVariablesTool.ts` - GetVariablesTool class and interface
 - `src/expandVariableTool.ts` - ExpandVariableTool class and interface
@@ -61,19 +59,11 @@ This is a VS Code extension that integrates with GitHub Copilot to provide debug
 
 ## Extension Configuration
 
-The extension contributes language model tools that allow Copilot to interact with VS Code's debugging system:
-
-- **`set_breakpoint`** - Sets breakpoints by specifying file path and line number
-- **`start_debugger`** - Starts debugging sessions with optional configuration name
-- **`wait_for_breakpoint`** - Waits for the debugger to hit a breakpoint or stop execution
-- **`get_variables`** - Retrieves all variables from the current debug session when stopped
-- **`expand_variable`** - Expands a specific variable to show its detailed contents and immediate child properties
-
-Tools are automatically available to Copilot when the extension is active.
+The extension contributes language model tools that allow Copilot to interact with VS Code's debugging system. Tools are automatically available when the extension is active.
 
 ### Breakpoint Features
 
-All breakpoint-related tools (`start_debugger` and `resume_debug_session`) support advanced breakpoint configurations:
+All breakpoint-related tools (`startDebugSessionWithBreakpoints` and `resumeDebugSession`) support advanced breakpoint configurations:
 
 - **Conditional Breakpoints**: Set `condition` to specify an expression that must evaluate to true for the breakpoint to trigger
   - Example: `condition: "$i -ge 3"` (PowerShell) or `condition: "x > 5"` (JavaScript)
@@ -88,7 +78,7 @@ All three properties are optional and can be combined with basic breakpoints tha
 
 ### Workspace Folder Semantics
 
-`start_debugger` requires a `workspaceFolder` parameter that must be an absolute path exactly matching one of the open workspace folder roots (`workspace.workspaceFolders[].uri.fsPath`).
+`startDebugSessionWithBreakpoints` requires a `workspaceFolder` parameter that must be an absolute path exactly matching one of the open workspace folder roots (`workspace.workspaceFolders[].uri.fsPath`).
 
 Simplifications implemented:
 
@@ -119,16 +109,6 @@ Example workspace setting:
 
 You can simulate startup delay via a `preLaunchTask` (e.g. `sleep-build-delay`) in `launch.json`. The test suite uses this with `Run timeoutTest.js` to validate timeout behavior.
 
-## Prerequisites
-
-This extension requires the **debug-tracker-vscode** extension to be installed for the `wait_for_breakpoint` tool to function:
-
-1. **Automatic Installation**: The extension will attempt to auto-install if not present
-2. **Manual Installation**: Install from VS Code marketplace: `mcu-debug.debug-tracker-vscode`
-3. **Command**: Use Quick Open (`Ctrl+P`) and search for "debug-tracker-vscode"
-
-The debug tracker extension provides API services for monitoring debug sessions and is required for breakpoint waiting functionality.
-
 ## Implementation Notes
 
 - When adding new tools, define the interface in `package.json` under `languageModelTools`
@@ -198,7 +178,7 @@ The debug tracker extension provides API services for monitoring debug sessions
 
 ### Promise-based Tool Implementation
 
-- For tools that wait for events (like `wait_for_breakpoint`), return a Promise from `invoke()`
+- For tools that wait for events, return a Promise from `invoke()`
 - Use proper Promise constructor with resolve/reject for event-driven operations
 - Implement cleanup logic in both success and error paths
 - Handle race conditions between timeouts and actual events

package.json

@@ -14,6 +14,7 @@
   "bugs": {
     "url": "https://github.com/dkattan/Copilot-Breakpoint-Debugger/issues"
   },
+        "when": "debugState == 'running'",
   "keywords": [
     "copilot",
     "debug",
@@ -117,10 +118,10 @@
       }
     },
     "languageModelTools": [
-      {
-        "name": "start_debugger_with_breakpoints",
+        {
+          "name": "startDebugSessionWithBreakpoints",
         "displayName": "Start Debugger",
-        "toolReferenceName": "startDebugger",
+        "toolReferenceName": "startDebugSessionWithBreakpoints",
         "canBeReferencedInPrompt": true,
         "userDescription": "Start a debug session, set breakpoints, and wait until a breakpoint is hit. Supports onHit behaviors: break (pause & return), captureAndContinue (collect variables & interpolated log messages then resume automatically), stopDebugging (terminate after hit). Supports serverReady.action types: httpRequest | shellCommand | vscodeCommand (auto-run after readiness trigger). Exact numeric hitCount pauses on that occurrence.",
         "modelDescription": "Start a debug session using the configured default launch configuration or an explicitly provided configurationName. Auto-selects sole launch config when none specified and no default setting is present. Each breakpoint can specify an onHit: break (pause), captureAndContinue (non-blocking gather of variables & interpolation of {var} placeholders in logMessage then continue), or stopDebugging (terminate immediately after hit). Supports serverReady with trigger {path+line | pattern | omitted attach} and action.type httpRequest | shellCommand | vscodeCommand. Conditional expressions and exact numeric hitCount only. variableFilter required only for captureAndContinue; omit to capture all locals up to captureMaxVariables.",
@@ -327,11 +328,10 @@
           ]
         }
       },
-      {
-        "name": "resume_debug_session",
+        {
+          "name": "resumeDebugSession",
         "displayName": "Resume Debug Session",
         "toolReferenceName": "resumeDebugSession",
-        "when": "debugState == 'running'",
         "canBeReferencedInPrompt": true,
         "userDescription": "Resume a paused debug session optionally waiting for the next breakpoint. Supports actions (break, capture, stopDebugging) and numeric hitCount shorthand when adding new breakpoints during resume.",
         "modelDescription": "Resume execution of the specified debug session. Optionally wait for next stop and set/clear breakpoints before continuing. Each new breakpoint may specify action (break | capture | stopDebugging), conditional expressions, exact numeric hitCount, and logMessage interpolation for capture.",
@@ -404,8 +404,8 @@
           ]
         }
       },
-      {
-        "name": "get_variables",
+        {
+          "name": "getVariables",
         "displayName": "Get Variables",
         "toolReferenceName": "getVariables",
         "canBeReferencedInPrompt": true,
@@ -416,8 +416,8 @@
           "properties": {}
         }
       },
-      {
-        "name": "expand_variable",
+        {
+          "name": "expandVariable",
         "displayName": "Expand Variable",
         "toolReferenceName": "expandVariable",
         "canBeReferencedInPrompt": true,
@@ -436,8 +436,8 @@
           ]
         }
       },
-      {
-        "name": "evaluate_expression",
+        {
+          "name": "evaluateExpression",
         "displayName": "Evaluate Expression",
         "toolReferenceName": "evaluateExpression",
         "canBeReferencedInPrompt": true,
@@ -460,8 +460,8 @@
           ]
         }
       },
-      {
-        "name": "stop_debug_session",
+        {
+          "name": "stopDebugSession",
         "displayName": "Stop Debug Session",
         "toolReferenceName": "stopDebugSession",
         "canBeReferencedInPrompt": true,

src/session.ts

@@ -37,6 +37,20 @@ const normalizeFsPath = (value: string) => {
   return process.platform === "win32" ? normalized.toLowerCase() : normalized;
 };
 
+const reorderScopesForCapture = <T extends { name?: string }>(scopes: T[]): T[] => {
+  const locals: T[] = [];
+  const others: T[] = [];
+  for (const scope of scopes) {
+    const name = scope?.name?.trim();
+    if (name && /^locals?$/i.test(name)) {
+      locals.push(scope);
+    } else {
+      others.push(scope);
+    }
+  }
+  return [...locals, ...others];
+};
+
 /**
  * Variables grouped by scope
  */
@@ -2072,8 +2086,10 @@ export const startDebuggingAndWaitForStop = async (
       finalStop.session,
       finalStop.threadId
     );
+    const orderedScopes = reorderScopesForCapture(debugContext.scopes ?? []);
+    debugContext = { ...debugContext, scopes: orderedScopes };
     const scopeVariables: ScopeVariables[] = [];
-    for (const scope of debugContext.scopes ?? []) {
+    for (const scope of orderedScopes) {
       const variables = await DAPHelpers.getVariablesFromReference(
         finalStop.session,
         scope.variablesReference

src/startDebuggerTool.ts

@@ -107,6 +107,7 @@ export class StartDebuggerTool
         success = false;
       }
       const providedFilters = stopInfo.hitBreakpoint.variableFilter ?? [];
+      const hasExplicitFilters = providedFilters.length > 0;
       let activeFilters: string[] = [...providedFilters];
       const maxAuto = config.captureMaxVariables ?? 40;
       const capturedLogs = stopInfo.capturedLogMessages ?? [];
@@ -124,9 +125,14 @@ export class StartDebuggerTool
         const names: string[] = [];
         const scopesUsed: string[] = [];
         for (const scope of scopes) {
-          const nonTrivialVars = scope.variables?.filter(
-            (variable) => !isTrivial(variable.name)
-          );
+          const nonTrivialVars = scope.variables?.filter((variable) => {
+            if (isTrivial(variable.name)) {
+              return false;
+            }
+            const isFunction =
+              (variable.type ?? "").toLowerCase() === "function";
+            return !isFunction;
+          });
           if (!nonTrivialVars || nonTrivialVars.length === 0) {
             continue;
           }
@@ -176,14 +182,24 @@ export class StartDebuggerTool
         }
       }
 
-      const truncate = (val: string) => {
-        const max = 120;
-        return val.length > max ? `${val.slice(0, max)}…(${val.length})` : val;
+      const maxValueLength = 100;
+      const shouldTruncateValues = !hasExplicitFilters;
+      let truncatedVariables = false;
+      const formatValue = (val: string) => {
+        if (!shouldTruncateValues) {
+          return val;
+        }
+        if (val.length > maxValueLength) {
+          truncatedVariables = true;
+          return `${val.slice(0, maxValueLength)}…(${val.length})`;
+        }
+        return val;
       };
       const variableStr = flattened
         .map((v) => {
           const typePart = v.type ? `:${v.type}` : "";
-          return `${v.name}=${truncate(v.value)} (${v.scope}${typePart})`;
+          const displayValue = formatValue(v.value);
+          return `${v.name}=${displayValue} (${v.scope}${typePart})`;
         })
         .join("; ");
       const fileName = summary.file
@@ -221,11 +237,11 @@ export class StartDebuggerTool
         const sessionLabel = state.sessionName ?? state.sessionId ?? "unknown";
         switch (state.status) {
           case "paused":
-            return `Debugger State: paused on '${sessionLabel}'. Recommended tools: resume_debug_session, get_variables, expand_variable, evaluate_expression, stop_debug_session.`;
+            return `Debugger State: paused on '${sessionLabel}'. Recommended tools: resumeDebugSession, getVariables, expandVariable, evaluateExpression, stopDebugSession.`;
           case "terminated":
-            return "Debugger State: terminated. Recommended tool: start_debugger_with_breakpoints to begin a new session.";
+            return "Debugger State: terminated. Recommended tool: startDebugSessionWithBreakpoints to begin a new session.";
           case "running":
-            return `Debugger State: running. (onHit 'captureAndContinue' continued session '${sessionLabel}'). Recommended tools: wait_for_breakpoint or resume_debug_session with new breakpoints.`;
+            return `Debugger State: running. (onHit 'captureAndContinue' continued session '${sessionLabel}'). Recommended tool: resumeDebugSession with new breakpoints.`;
         }
       })();
 
@@ -256,6 +272,12 @@ export class StartDebuggerTool
         );
       }
 
+      if (truncatedVariables) {
+        guidance.push(
+          "Tip: Values were truncated to 100 characters. Provide variableFilter to return full values without truncation."
+        );
+      }
+
       const guidanceSection =
         guidance.length > 0 ? `Guidance:\n- ${guidance.join("\n- ")}` : "";