@tonyclaw/agent-inspector 3.0.44 → 3.0.46

package/src/cli/templates/skill-onboard.ts

@@ -24,6 +24,22 @@ export type SkillOnboardContext = {
   readonly version: string;
   /** The default proxy port (mirrors `DEFAULT_PORT` in `src/cli.ts`). */
   readonly port: number;
+  /** Public backend control/agent Base URL, including the configured Base Path. */
+  readonly baseUrl: string;
+  /** Optional composed or standalone UI URL. Undefined preserves the legacy composed default. */
+  readonly uiUrl?: string | null;
+  /** REST/SSE Base URL. Falls back to baseUrl for compatibility. */
+  readonly controlBaseUrl?: string;
+  /** Proxy/MCP Base URL. Falls back to baseUrl for compatibility. */
+  readonly agentBaseUrl?: string;
+  /** MCP config key selected by onboarding. */
+  readonly mcpName?: string;
+  /** Selected onboarding target type. */
+  readonly targetKind?: "default" | "instance" | "base-url";
+  /** Normalized registry name for a named target. */
+  readonly instanceName?: string | null;
+  /** CLI arguments that reproduce the selected target. */
+  readonly onboardTargetArguments?: string;
   /**
    * One-line "detected tools" summary written into the Preflight phase so the
    * skill's instructions match the user's actual environment. Empty string
@@ -47,9 +63,70 @@ export const REQUIRED_PHASE_HEADINGS = [
 
 export function renderSkillOnboard(ctx: SkillOnboardContext): string {
   const { version, port, detectedSummary } = ctx;
+  const controlBaseUrl = ctx.controlBaseUrl ?? ctx.baseUrl;
+  const agentBaseUrl = ctx.agentBaseUrl ?? ctx.baseUrl;
+  const uiUrl = ctx.uiUrl === undefined ? ctx.baseUrl : ctx.uiUrl;
+  const mcpName = ctx.mcpName ?? "agent-inspector";
+  const targetKind = ctx.targetKind ?? "default";
+  const targetArguments = ctx.onboardTargetArguments ?? "";
+  const instanceName = ctx.instanceName ?? null;
+  const healthUrl = `${controlBaseUrl}/api/health`;
+  const runtimeUrl = `${controlBaseUrl}/api/runtime`;
+  const configUrl = `${controlBaseUrl}/api/config`;
+  const anthropicProxyUrl = `${agentBaseUrl}/proxy`;
+  const openAiProxyUrl = `${agentBaseUrl}/proxy/v1`;
+  const mcpUrl = `${agentBaseUrl}/api/mcp`;
+  const logsUrl = `${controlBaseUrl}/api/logs`;
+  const providersUrl = `${controlBaseUrl}/api/providers`;
+  const statusCommand = `agent-inspector onboard --status${targetArguments}`;
+  const refreshCommand = `agent-inspector onboard --force${targetArguments}`;
+  const startCommand =
+    targetKind === "instance" && instanceName !== null
+      ? `agent-inspector instance start ${instanceName}`
+      : targetKind === "base-url"
+        ? `# Explicit control target ${controlBaseUrl}: do not start a replacement local runtime.`
+        : "agent-inspector --mode simple --background --no-open";
+  const fullModeCommand =
+    targetKind === "instance" && instanceName !== null
+      ? `agent-inspector instance restart ${instanceName} --mode full`
+      : targetKind === "base-url"
+        ? "ask the target operator to enable Full capture mode"
+        : "agent-inspector --mode full --force-restart";
+  const bashStartSnippet =
+    targetKind === "base-url" ? startCommand : `${startCommand} > /tmp/agent-inspector.log 2>&1`;
+  const windowsStartArguments =
+    targetKind === "instance" && instanceName !== null
+      ? `instance start ${instanceName}`
+      : "--mode simple --background --no-open";
+  const powershellStartSnippet =
+    targetKind === "base-url"
+      ? startCommand
+      : `$found = Get-Command agent-inspector -ErrorAction SilentlyContinue
+if (-not $found) { throw 'agent-inspector is not on PATH' }
+& $found.Source ${windowsStartArguments}`;
+  const startExplanation =
+    targetKind === "base-url"
+      ? `The selected Inspector target uses control Base URL \`${controlBaseUrl}\` and agent Base URL \`${agentBaseUrl}\`. Do not launch a default local runtime as a substitute; verify the selected target and ask its operator for help if it is unavailable.`
+      : `Start or reuse the selected Inspector backend. Its public control and agent endpoints preserve the selected Base Path; a Web UI may be composed at the same URL, hosted separately, or intentionally absent in backend-only mode. Use \`${fullModeCommand}\` only when the user needs raw headers, raw response, or SSE chunks.`;
+  const stopSnippet =
+    targetKind === "instance" && instanceName !== null
+      ? `agent-inspector instance stop ${instanceName}`
+      : targetKind === "base-url"
+        ? `# Ask the operator of ${controlBaseUrl} to stop the selected runtime.`
+        : `# Unix / macOS\n  lsof -ti:${String(port)} | xargs -r kill -9\n\n  # Windows PowerShell\n  Get-NetTCPConnection -LocalPort ${String(port)} | ForEach-Object { Stop-Process -Id $_.OwningProcess -Force }`;
+  const providerScopeGuidance =
+    targetKind === "default"
+      ? "The unmanaged default target owns the local Agent Inspector data directory used by the file checks below."
+      : `The selected target is not the unmanaged default data directory. Do not inspect or edit local ~/.agent-inspector Provider files as a substitute. Query \`${providersUrl}\`, use the selected target's MCP Provider tools with explicit approval, or ask its operator to configure Providers. Skip local-file commands below.`;
+  const selectedUi =
+    uiUrl === null ? "not supplied (do not infer one from a backend URL)" : `\`${uiUrl}\``;
+  const uiTour =
+    uiUrl === null
+      ? "not supplied; continue with MCP/REST, and ask the operator for a standalone UI URL only if the user needs one"
+      : `\`${uiUrl}\` — use this explicit composed or standalone browser URL; do not replace it with the control or agent Base URL`;
   return `---
 name: agent-inspector-onboard
-description: Guided setup for Agent Inspector v${version}: start the proxy, wire your AI coding tool, capture your first request, and learn the Web UI.
+description: Guided setup for Agent Inspector v${version}: start or select the backend, wire your AI coding tool, and capture your first request with or without a Web UI.
 metadata:
   author: agent-inspector
   version: ${version}
@@ -57,12 +134,16 @@ metadata:
 
 # Agent Inspector onboard
 
-Guide the user from "I just installed Agent Inspector" to "I can see my AI tool's traffic in the Web UI". This is a teaching experience: you'll do real work in their environment while explaining each step.
+Guide the user from "I just installed Agent Inspector" to "my coding agent can use the proxy, REST API, and MCP surface". The backend works in composed and headless deployments; treat the Web UI as an optional presentation surface.
 
 Environment detected by the installer:
 ${detectedSummary || "  (no known AI tool detected — the user can still use the generic curl example in Phase 4)"}
 
-Default proxy port: \`${port}\` (override with \`PORT=<n> agent-inspector\` or \`--port <n>\`).
+Selected Inspector surfaces:
+- UI URL: ${selectedUi}
+- Control Base URL: \`${controlBaseUrl}\`
+- Agent Base URL: \`${agentBaseUrl}\`
+- MCP key: \`${mcpName}\`
 
 > **PAUSE protocol.** Every \`**PAUSE**\` marker in this skill is a real stop.
 > Use the \`AskUserQuestion\` tool to actually wait for the user before
@@ -77,22 +158,24 @@ Default proxy port: \`${port}\` (override with \`PORT=<n> agent-inspector\` or \
 **EXPLAIN:** "Before we do anything, let me see what's already set up. If some of the steps are already done, we can skip them."
 
 **DO:** First check whether the generated onboarding files match the installed npm package. If any
-entry is \`outdated\` or \`missing\`, tell the user to run \`agent-inspector onboard --force\` before
+entry is \`outdated\` or \`missing\`, tell the user to run \`${refreshCommand}\` before
 continuing so they are not guided by stale instructions.
 
 \`\`\`bash
-agent-inspector onboard --status
+${statusCommand}
 \`\`\`
 
 \`\`\`powershell
-agent-inspector onboard --status
+${statusCommand}
 \`\`\`
 
 **DO:** Then probe the three pieces of state this skill touches. Use targeted checks — do **not** read large JSON files into the conversation.
 
+**DO:** ${providerScopeGuidance}
+
 \`\`\`bash
-# 1. Is the proxy already up?
-curl -fsS "http://localhost:${port}/api/health" 2>/dev/null && echo "PROXY: up" || echo "PROXY: down"
+# 1. Is the backend already up?
+curl -fsS "${healthUrl}" 2>/dev/null && echo "BACKEND: up" || echo "BACKEND: down"
 
 # 2. Does the provider config have a real provider key?
 agent_inspector_data_dir() {
@@ -123,9 +206,9 @@ fi
 # 3. Is the MCP server already wired? (project .mcp.json wins)
 PROJ_MCP=".mcp.json"
 HOME_MCP="$HOME/.claude.json"
-if [ -f "$PROJ_MCP" ] && grep -q '"agent-inspector"' "$PROJ_MCP"; then
+if [ -f "$PROJ_MCP" ] && grep -q '"${mcpName}"' "$PROJ_MCP"; then
   echo "MCP: wired in $PROJ_MCP"
-elif [ -f "$HOME_MCP" ] && grep -q '"agent-inspector"' "$HOME_MCP"; then
+elif [ -f "$HOME_MCP" ] && grep -q '"${mcpName}"' "$HOME_MCP"; then
   echo "MCP: wired in $HOME_MCP"
 else
   echo "MCP: not wired"
@@ -153,12 +236,12 @@ $dataDir = Resolve-AgentInspectorDataDir
 $providers = Join-Path $dataDir 'providers.json'
 $legacyConfig = Join-Path $dataDir 'config.json'
 
-# 1. Is the proxy already up?
+# 1. Is the backend already up?
 try {
-  $null = Invoke-RestMethod -Uri "http://localhost:$port/api/health" -TimeoutSec 2 -ErrorAction Stop
-  Write-Host 'PROXY: up'
+  $null = Invoke-RestMethod -Uri "${healthUrl}" -TimeoutSec 2 -ErrorAction Stop
+  Write-Host 'BACKEND: up'
 } catch {
-  Write-Host 'PROXY: down'
+  Write-Host 'BACKEND: down'
 }
 
 # 2. Does the config have a real provider key?
@@ -180,9 +263,9 @@ if ((Test-Path $providers) -or (Test-Path $legacyConfig)) {
 # 3. Is the MCP server already wired? (project .mcp.json wins)
 $projMcp = Join-Path (Get-Location) '.mcp.json'
 $homeMcp = Join-Path $env:USERPROFILE '.claude.json'
-if ((Test-Path $projMcp) -and (Select-String -Path $projMcp -Pattern 'agent-inspector' -Quiet)) {
+if ((Test-Path $projMcp) -and (Select-String -Path $projMcp -SimpleMatch '${mcpName}' -Quiet)) {
   Write-Host "MCP: wired in $projMcp"
-} elseif ((Test-Path $homeMcp) -and (Select-String -Path $homeMcp -Pattern 'agent-inspector' -Quiet)) {
+} elseif ((Test-Path $homeMcp) -and (Select-String -Path $homeMcp -SimpleMatch '${mcpName}' -Quiet)) {
   Write-Host "MCP: wired in $homeMcp"
 } else {
   Write-Host 'MCP: not wired'
@@ -228,7 +311,7 @@ node -e "const fs=require('node:fs'),p=require('node:path');const names=process.
 \`\`\`
 ## Welcome to Agent Inspector!
 
-Agent Inspector is an agent observability and knowledge-capture platform for AI coding tools. The \`agent-inspector\` CLI runs a transparent local proxy + Web UI, so you can see model requests and responses, system prompts, tool definitions, message history, timing, and token counts captured live in a browser tab.
+Agent Inspector is an agent observability and knowledge-capture platform for AI coding tools. Its backend owns the transparent model proxy, REST/SSE APIs, capture storage, and MCP server. The default CLI composes a Web UI at the same public Base URL, while \`--backend-only\` keeps every Coding Agent surface available without serving UI files.
 
 Agent Inspector starts in **Simple mode** by default. Simple mode is the right habit for everyday use: it keeps requests, responses, tools, timing, and token usage while avoiding heavier raw headers, raw response, and detailed SSE chunk artifacts. Use **Full mode** only when the user is debugging provider headers, raw response payloads, or SSE stream details.
 
@@ -248,6 +331,8 @@ Ready? Let's start with the provider.
 
 ## Phase 2: Provider setup
 
+**DO:** ${providerScopeGuidance}
+
 **EXPLAIN:** "A 'provider' is an upstream LLM endpoint — Anthropic, OpenAI, MiniMax, etc. agent-inspector routes each request to the right upstream based on the model name. You need at least one provider configured for the proxy to forward traffic."
 
 **DO:** First, re-check whether \`<dataDir>/providers.json\` already has a real key (Phase 0 may have raced with a manual edit). Use the same data-dir resolution and \`grep -qE '"apiKey":"sk-'\` (bash) or \`Select-String\` (PowerShell) check from Phase 0. If a real key is present, skip the rest of this phase.
@@ -341,58 +426,46 @@ $json | Set-Content -Path $file -Encoding UTF8
 
 ## Phase 3: Start proxy
 
-**EXPLAIN:** "Time to start the proxy. It binds to port ${port} by default, starts in Simple mode for lower overhead, reuses an already-running healthy agent-inspector, and prints the URL. Use \`--force-restart\` only when you intentionally want to replace the existing process. If the user is diagnosing raw headers, raw response, or SSE chunks, restart with \`agent-inspector --mode full\`."
+**EXPLAIN:** "${startExplanation}"
 
-**DO:** Skip this phase entirely if the Phase 0 health check already reported \`PROXY: up\` and the user opted to skip done phases.
+**DO:** Skip this phase entirely if the Phase 0 health check already reported \`BACKEND: up\` and the user opted to skip done phases.
 
-**DO:** Otherwise, start the proxy with the explicit \`--background --no-open\` flags. On Windows, resolve the npm shim first and launch it through \`Start-Process -WindowStyle Hidden\` so setup does not flash a command window.
+**DO:** Otherwise, use the selected target command below. An explicit wrapper Base URL is connection-only and must not cause a replacement local runtime to start.
 
 \`\`\`bash
-# Unix / macOS / WSL
-agent-inspector --mode simple --background --no-open > /tmp/agent-inspector.log 2>&1
+${bashStartSnippet}
 \`\`\`
 
 \`\`\`powershell
-# Windows PowerShell — single-quoted so $env: expands correctly.
-# Locate the binary on PATH first (works for npm, pnpm, yarn, volta, fnm).
-# If not on PATH, fall back to the common npm global shim at $env:APPDATA.
-# As a last resort, let cmd /c resolve it through PATHEXT.
-$log = Join-Path $env:TEMP 'agent-inspector.log'
-$err = Join-Path $env:TEMP 'agent-inspector.err.log'
-$found = Get-Command agent-inspector -ErrorAction SilentlyContinue
-if ($found) {
-  $shim = $found.Source
-  $args = '--mode','simple','--background','--no-open'
-} elseif (Test-Path (Join-Path $env:APPDATA 'npm/agent-inspector.cmd')) {
-  $shim = Join-Path $env:APPDATA 'npm/agent-inspector.cmd'
-  $args = '--mode','simple','--background','--no-open'
-} else {
-  # bin not on PATH and not at the default npm prefix — let cmd resolve it
-  $shim = 'cmd.exe'
-  $args = '/c','agent-inspector','--mode','simple','--background','--no-open'
-}
-Start-Process -FilePath $shim -ArgumentList $args -RedirectStandardOutput $log -RedirectStandardError $err -WindowStyle Hidden
+# Windows PowerShell
+${powershellStartSnippet}
 \`\`\`
 
-Then wait for the port to be ready:
+Then wait for the selected backend health URL to be ready:
 
 \`\`\`bash
 for i in $(seq 1 20); do
-  curl -fsS "http://localhost:${port}/api/health" >/dev/null 2>&1 && echo "ready" && break
+  curl -fsS "${healthUrl}" >/dev/null 2>&1 && echo "ready" && break
   sleep 0.5
 done
 \`\`\`
 
-**DO:** Hit the health endpoint to confirm the proxy is alive:
+**DO:** Hit the health endpoint to confirm the backend is alive:
 
 \`\`\`bash
-curl -sS "http://localhost:${port}/api/health"
+curl -sS "${healthUrl}"
 \`\`\`
 
-**DO:** Read \`/api/config\` and tell the user which capture mode is active. If it is not \`simple\` during onboarding, explain that an existing process is already running and offer to restart with \`agent-inspector --mode simple --force-restart\`.
+**DO:** Read the token-free runtime discovery document. Report \`deploymentMode\` and capabilities; do not treat \`backend-only\` as a failure or infer that a UI is present.
 
 \`\`\`bash
-curl -sS "http://localhost:${port}/api/config" | grep -o '"captureMode":"[^"]*"'
+curl -sS "${runtimeUrl}"
+\`\`\`
+
+**DO:** Read \`/api/config\` and tell the user which capture mode is active. If deeper capture is required, offer \`${fullModeCommand}\`.
+
+\`\`\`bash
+curl -sS "${configUrl}" | grep -o '"captureMode":"[^"]*"'
 \`\`\`
 
 > **PAUSE** — if the health check fails, show the user the log file (\`/tmp/agent-inspector.log\` or \`%TEMP%\\agent-inspector.log\`) and diagnose. Common issues: another process on the port, firewall, missing providers. Use \`AskUserQuestion\` with header \`Proxy up?\` and options \`["Yes, proxy is up", "No, I see an error in the log"]\`. Wait for the answer.
@@ -407,18 +480,18 @@ curl -sS "http://localhost:${port}/api/config" | grep -o '"captureMode":"[^"]*"'
 
 \`\`\`bash
 # Claude Code
-export ANTHROPIC_BASE_URL=http://localhost:${port}/proxy
+export ANTHROPIC_BASE_URL=${anthropicProxyUrl}
 claude
 
 # OpenCode
-export LLM_BASE_URL=http://localhost:${port}/proxy
+export LLM_BASE_URL=${openAiProxyUrl}
 opencode
 
 # MiMo Code
-export OPENAI_BASE_URL=http://localhost:${port}/proxy
+export OPENAI_BASE_URL=${openAiProxyUrl}
 mimo
 
-# Cursor / Cody — set the OpenAI base URL in each tool's settings panel to http://localhost:${port}/proxy
+# Cursor / Cody — set the OpenAI base URL in each tool's settings panel to ${openAiProxyUrl}
 \`\`\`
 
 **Container/network note:** If the AI tool runs in a different container, VM, WSL distro, or host
@@ -434,32 +507,32 @@ For a tool that wasn't auto-detected, fall through to the generic curl test in t
 
 ## Phase 4.5: Wire MCP server
 
-**EXPLAIN:** "The proxy also exposes an MCP server at \`http://localhost:${port}/api/mcp\`. Your AI agent can query logs, replay requests, and test providers through it — no need to leave the editor."
+**EXPLAIN:** "The proxy also exposes an MCP server at \`${mcpUrl}\`. Your AI agent can query logs, replay requests, and test providers through it — no need to leave the editor."
 
 **DO:** Skip this phase if Phase 0 reported \`MCP: wired in <path>\` and the user opted to skip done phases.
 
 **DO:** Otherwise, check the project-level \`.mcp.json\` first (preferred — modern Claude Code convention), then fall back to \`~/.claude.json\`. Use the \`Read\` tool to inspect; do **not** \`cat\` a 40 KB file into the conversation.
 
-If neither has an \`agent-inspector\` entry, add one. The simplest path is to write to project \`.mcp.json\` (create it if missing):
+If neither has a \`${mcpName}\` entry, add one. The simplest path is to write to project \`.mcp.json\` (create it if missing):
 
 \`\`\`json
 // .mcp.json  (project root)
 {
   "mcpServers": {
-    "agent-inspector": {
+    "${mcpName}": {
       "type": "http",
-      "url": "http://localhost:${port}/api/mcp"
+      "url": "${mcpUrl}"
     }
   }
 }
 \`\`\`
 
-If \`mcpServers\` already exists in \`.mcp.json\`, merge the \`agent-inspector\` key into it via the \`Edit\` tool — do not overwrite other entries. If you can't create a project \`.mcp.json\` (no project root, permission, etc.), fall back to merging into \`~/.claude.json\` using the same \`Read\`/\`Edit\` pattern.
+If \`mcpServers\` already exists in \`.mcp.json\`, merge only the \`${mcpName}\` key into it via the \`Edit\` tool — do not overwrite other entries. If you can't create a project \`.mcp.json\` (no project root, permission, etc.), fall back to merging into \`~/.claude.json\` using the same \`Read\`/\`Edit\` pattern.
 
 **DO:** Verify the handshake. The MCP \`initialize\` request should return 200 with a \`serverInfo\` payload — that proves the server is mounted and reachable:
 
 \`\`\`bash
-curl -sS -X POST "http://localhost:${port}/api/mcp" \\
+curl -sS -X POST "${mcpUrl}" \\
   -H "Content-Type: application/json" \\
   -H "Accept: application/json, text/event-stream" \\
   -d '{
@@ -489,7 +562,7 @@ The \`grep -o '"name":"agent-inspector"'\` extracts only the serverInfo name —
 Fire a minimal Anthropic-format request through the proxy:
 
 \`\`\`bash
-curl -sS -X POST "http://localhost:${port}/proxy/v1/messages" \\
+curl -sS -X POST "${anthropicProxyUrl}/v1/messages" \\
   -H "Content-Type: application/json" \\
   -H "anthropic-version: 2023-06-01" \\
   -H "x-api-key: \${AGENT_INSPECTOR_API_KEY:-sk-no-key-needed-for-routing}" \\
@@ -501,7 +574,7 @@ curl -sS -X POST "http://localhost:${port}/proxy/v1/messages" \\
 
 \`\`\`bash
 for i in $(seq 1 10); do
-  resp=$(curl -sS "http://localhost:${port}/api/logs?limit=1")
+  resp=$(curl -sS "${logsUrl}?limit=1")
   count=$(echo "$resp" | grep -o '"total":[0-9]*' | head -1 | grep -o '[0-9]*$')
   if [ "\${count:-0}" -ge 1 ]; then
     echo "captured"
@@ -528,25 +601,22 @@ done
 
 ## Phase 6: Tour & wrap
 
-**EXPLAIN:** "Everything's working. Here's the cheat sheet for the Web UI and the supporting surfaces:"
+**EXPLAIN:** "Everything's working. Here's the cheat sheet for the backend surfaces and the optional Web UI:"
 
-- **Web UI**: \`http://localhost:${port}/\` — collapsible log rows, per-tab Copy/Expand in the log header, Diff with Raw (request body), Diff with Previous (compare adjacent requests), Replay (re-send a request), Export (JSON ZIP).
-- **MCP server**: \`http://localhost:${port}/api/mcp\` — connect from your coding agent to query logs, replay, and test providers without leaving the editor. Look for the "MCP Ready" badge in the Web UI header.
+- **Runtime discovery**: \`${runtimeUrl}\` — token-free deployment mode, UI Base Path, control/agent Base URLs, and capabilities.
+- **Web UI**: ${uiTour}.
+- **MCP server**: \`${mcpUrl}\` — connect from the coding agent to query logs, replay, and test providers; it does not require a Web UI process.
 - **REST API**: \`/api/logs\`, \`/api/sessions\`, \`/api/providers\` — for scripting and shell-based inspection.
 - **Stop the proxy**:
 
   \`\`\`bash
-  # Unix / macOS
-  lsof -ti:${port} | xargs -r kill -9
-
-  # Windows PowerShell — single-quoted so $env: expands correctly
-  Get-NetTCPConnection -LocalPort $port | ForEach-Object { Stop-Process -Id $_.OwningProcess -Force }
+${stopSnippet}
   \`\`\`
 
-- **Re-run onboard**: \`agent-inspector onboard --force\` refreshes this skill.
-- **Check onboard files**: \`agent-inspector onboard --status\` shows whether generated skills are
+- **Re-run onboard**: \`${refreshCommand}\` refreshes this skill.
+- **Check onboard files**: \`${statusCommand}\` shows whether generated skills are
   current, outdated, missing, newer, or custom.
-- **Full docs**: see the project README (linked from the Web UI footer).
+- **Full docs**: see the project README; do not depend on a UI footer being available.
 
 > **PAUSE** — use \`AskUserQuestion\` with header \`All set?\` and options \`["All set, I'm done", "Wait, I want to revisit a phase"]\`. Wait for the answer.