agent-inspect 3.5.2 → 3.5.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # Changelog
2
2
 
3
+ ## 3.5.4
4
+
5
+ ### Patch Changes
6
+
7
+ - 1ffe989: v3.5.4 README adoption polish: centered brand header, product-loop visual, npm package files for linked docs/assets. Docs-only; no runtime API changes.
8
+
9
+ ## 3.5.3
10
+
11
+ ### Patch Changes
12
+
13
+ - 05546b5: v3.5.3 docs hygiene: lean docs index, archive stale files, remove unavailable hero SVG from npm package files. Docs-only.
14
+
3
15
  ## 3.5.2
4
16
 
5
17
  ### Patch Changes
@@ -44,9 +56,9 @@
44
56
 
45
57
  ## Unreleased
46
58
 
47
- Post-v3.5 adoption polish (docs, package READMEs, npm presentation). No runtime feature changes planned without a new RFC.
59
+ README adoption polish (brand header, product-loop visual, npm link hygiene). Docs-only; no runtime feature changes.
48
60
 
49
- See [docs/implementation/release-trains/V3.5.X-ADOPTION-POLISH-PLAN.md](docs/implementation/release-trains/V3.5.X-ADOPTION-POLISH-PLAN.md).
61
+ See [docs/implementation/reviews/README-ADOPTION-POLISH-REVIEW.md](docs/implementation/reviews/README-ADOPTION-POLISH-REVIEW.md).
50
62
 
51
63
  ---
52
64
 
package/README.md CHANGED
@@ -1,13 +1,37 @@
1
- # agent-inspect
1
+ <p align="center">
2
+ <picture>
3
+ <source media="(prefers-color-scheme: dark)" srcset="docs/assets/agent-inspect-logo-dark.svg">
4
+ <img src="docs/assets/agent-inspect-logo.svg" width="240" alt="AgentInspect">
5
+ </picture>
6
+ </p>
2
7
 
3
- **Local-first TypeScript toolkit: trace what happened, check what should have happened, redact what must not leave your machine.**
8
+ <h1 align="center">agent-inspect</h1>
4
9
 
5
- No account · no upload · no hosted dashboard · metadata-only by default
10
+ <p align="center">
11
+ <strong>Trace, check, and safely share TypeScript AI-agent runs locally.</strong>
12
+ </p>
6
13
 
7
- [![npm version](https://img.shields.io/npm/v/agent-inspect.svg)](https://www.npmjs.com/package/agent-inspect)
8
- [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
14
+ <p align="center">
15
+ <sub>No account · no upload · no hosted dashboard · metadata-only by default</sub>
16
+ </p>
9
17
 
10
- ![AgentInspect loop: trace → check → redact](docs/assets/agent-inspect-loop.svg)
18
+ <p align="center">
19
+ <a href="https://agentinspect.vercel.app/">Website</a> ·
20
+ <a href="https://agentinspect.vercel.app/docs/">Docs</a> ·
21
+ <a href="https://www.npmjs.com/package/agent-inspect">npm</a> ·
22
+ <a href="https://github.com/rajudandigam/agent-inspect">GitHub</a>
23
+ </p>
24
+
25
+ <p align="center">
26
+ <a href="https://www.npmjs.com/package/agent-inspect"><img src="https://img.shields.io/npm/v/agent-inspect.svg" alt="npm version"></a>
27
+ <a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="MIT license"></a>
28
+ <a href="package.json"><img src="https://img.shields.io/badge/node-%3E%3D20-brightgreen" alt="Node.js >= 20"></a>
29
+ <a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-strict-3178c6" alt="TypeScript"></a>
30
+ </p>
31
+
32
+ agent-inspect turns AI-agent runs into readable **local execution trees**: framework events, observed objects, tool calls, LLM steps, retries, failures, timings, sessions, and CI artifacts — without an account, collector, or hosted dashboard.
33
+
34
+ **Default loop:** capture locally → inspect / report / diff → check in CI → redact before sharing.
11
35
 
12
36
  ```bash
13
37
  npm install agent-inspect
@@ -24,46 +48,56 @@ npx agent-inspect report <run-id> --dir .agent-inspect
24
48
  npx agent-inspect verify-safe --dir .agent-inspect
25
49
  ```
26
50
 
27
- **North star:** install → one trace → one failure check → one share-safe artifact in under five minutes. See [First trace in 5 minutes](docs/FIRST-TRACE-IN-5-MINUTES.md).
51
+ Install → one trace → one failure check → one share-safe artifact in under five minutes.
52
+ Guide: [First trace in 5 minutes](https://agentinspect.vercel.app/docs/getting-started/) · [repo](docs/FIRST-TRACE-IN-5-MINUTES.md)
53
+
54
+ <p align="center">
55
+ <img src="docs/assets/readme-product-loop.svg" alt="Capture, inspect, check, redact — local JSONL only" width="720">
56
+ </p>
28
57
 
29
58
  ## Choose your path
30
59
 
31
- | Path | When | Start here |
32
- | ---- | ---- | ---------- |
60
+ | Path | Use when | Start |
61
+ | ---- | -------- | ----- |
33
62
  | **AI SDK** | Vercel AI SDK `generateText` / `streamText` | [`@agent-inspect/ai-sdk`](packages/ai-sdk/README.md) · [guide](docs/AI-SDK-ADOPTION.md) |
34
- | **OpenAI Agents** | OpenAI Agents JS local tracing | [`@agent-inspect/openai-agents`](packages/openai-agents/README.md) · [guide](docs/OPENAI-AGENTS-LOCAL.md) |
35
- | **LangChain** | Callback adapter, LangGraph-via-LangChain | [`@agent-inspect/langchain`](packages/langchain/README.md) |
36
- | **Observe** | Existing class with `run` / `execute` | [Getting started § observe](docs/GETTING-STARTED.md) |
37
- | **Manual** | Custom control flow | `inspectRun` + `step` in [API](docs/API.md) |
63
+ | **OpenAI Agents** | OpenAI Agents JS | [`@agent-inspect/openai-agents`](packages/openai-agents/README.md) · [guide](docs/OPENAI-AGENTS-LOCAL.md) |
64
+ | **LangChain** | Callbacks / LangGraph-via-LangChain | [`@agent-inspect/langchain`](packages/langchain/README.md) |
65
+ | **Observe** | Object/class with `run` / `execute` / `invoke` | [Getting started](docs/GETTING-STARTED.md) |
66
+ | **Manual** | Custom spans and nesting | `inspectRun` + `step` in [API](docs/API.md) |
38
67
  | **Logs** | Structured logs already emitted | [Log-to-tree](docs/LOG-TO-TREE-QUICKSTART.md) |
39
- | **CI / tests** | Failed test artifacts | [`@agent-inspect/vitest`](packages/vitest/README.md) · [`@agent-inspect/jest`](packages/jest/README.md) |
40
- | **Real projects** | Fixture harness | [`@agent-inspect/harness`](packages/harness/README.md) |
68
+ | **CI / tests** | Failed-test artifacts | [`@agent-inspect/vitest`](packages/vitest/README.md) · [`@agent-inspect/jest`](packages/jest/README.md) |
69
+ | **Real projects** | Fixture runner / bootstrap | [`@agent-inspect/harness`](packages/harness/README.md) · [NestJS](docs/NESTJS.md) |
41
70
 
42
71
  Blessed starters (no API keys): [examples/starters](https://github.com/rajudandigam/agent-inspect/tree/main/examples/starters)
43
72
 
44
73
  ## What it helps with
45
74
 
46
- - **Wrong tool call** — see tool steps, args metadata, and parent run in the tree
47
- - **Baseline vs candidate** — `diff` two runs locally
48
- - **Eval / test failures** — `check`, `eval`, Vitest/Jest reporters
49
- - **PR artifacts** — [CI artifacts](docs/CI-ARTIFACTS.md) + `redact --profile share`
75
+ - **Wrong tool call** — tool steps, args metadata, and parent run in one tree
76
+ - **Failed eval / test** — `check`, `eval`, Vitest/Jest reporters on failure
77
+ - **Baseline vs candidate** — local `diff` of two runs
78
+ - **PR trace artifact** — [CI artifacts](docs/CI-ARTIFACTS.md) + `redact --profile share`
79
+ - **Safe incident handoff** — [safe sharing](https://agentinspect.vercel.app/docs/safe-sharing/) before Slack or GitHub
50
80
  - **Multi-agent / sessions** — `sessions`, `search`, handoff metadata
51
- - **MCP tools** — [`@agent-inspect/mcp`](packages/mcp/README.md) client tracing
52
- - **VS Code** — in-repo extension (`packages/vscode`); [dev guide](docs/VSCODE.md) Marketplace listing manual
81
+ - **MCP tool calls** — [`@agent-inspect/mcp`](packages/mcp/README.md) client tracing
82
+ - **VS Code review** — in-repo extension ([dev guide](docs/VSCODE.md); Marketplace not published yet)
83
+ - **Existing logs** — parse structured logs when you cannot instrument
53
84
 
54
85
  ## Real-world scenarios
55
86
 
56
- | Scenario | Doc |
57
- | -------- | --- |
58
- | Local debugging | [USE-CASES.md](docs/USE-CASES.md) |
59
- | CI failure review | [REAL-WORLD-SCENARIOS.md](docs/REAL-WORLD-SCENARIOS.md) |
60
- | Team adoption | [TEAM-WORKFLOWS.md](docs/TEAM-WORKFLOWS.md) · [Design partners](docs/DESIGN-PARTNER-GUIDE.md) |
87
+ | Scenario | Where to start |
88
+ | -------- | -------------- |
89
+ | Local debugging | [Use cases](docs/USE-CASES.md) · [broken-agent starter](https://github.com/rajudandigam/agent-inspect/tree/main/examples/starters/broken-agent-debugging) |
90
+ | CI failure review | [CI artifacts](docs/CI-ARTIFACTS.md) · [ci-eval-redact](https://github.com/rajudandigam/agent-inspect/tree/main/examples/starters/ci-eval-redact) |
91
+ | Team adoption | [Team workflows](docs/TEAM-WORKFLOWS.md) · [Design partners](docs/DESIGN-PARTNER-GUIDE.md) |
92
+ | Safe sharing | [Safe sharing](https://agentinspect.vercel.app/docs/safe-sharing/) · [repo](docs/SAFE-TRACE-SHARING.md) |
93
+ | Framework-native tracing | [Adapters](docs/ADAPTERS.md) · package READMEs above |
94
+ | Design partner trial | [Design partner guide](docs/DESIGN-PARTNER-GUIDE.md) · [Demo script](docs/DEMO-SCRIPT.md) |
61
95
 
62
96
  ## Package map
63
97
 
64
98
  | Package | Purpose |
65
99
  | ------- | ------- |
66
- | [`agent-inspect`](https://www.npmjs.com/package/agent-inspect) | Core + CLI |
100
+ | [`agent-inspect`](https://www.npmjs.com/package/agent-inspect) | Core APIs + CLI |
67
101
  | [`@agent-inspect/ai-sdk`](packages/ai-sdk/README.md) | AI SDK telemetry |
68
102
  | [`@agent-inspect/openai-agents`](packages/openai-agents/README.md) | OpenAI Agents processor |
69
103
  | [`@agent-inspect/langchain`](packages/langchain/README.md) | LangChain callbacks |
@@ -75,45 +109,51 @@ Blessed starters (no API keys): [examples/starters](https://github.com/rajudandi
75
109
  | [`@agent-inspect/mcp`](packages/mcp/README.md) | MCP client tracing |
76
110
  | [`@agent-inspect/mcp-server`](packages/mcp-server/README.md) | Read-only trace MCP server |
77
111
  | [`@agent-inspect/guardrails`](packages/guardrails/README.md) | Deterministic guardrail rules |
78
- | [`@agent-inspect/circuit`](packages/circuit/README.md) | Loop/retry/timeout analyzers |
112
+ | [`@agent-inspect/circuit`](packages/circuit/README.md) | Loop / retry / timeout analyzers |
79
113
  | [`@agent-inspect/viewer`](packages/viewer/README.md) | Localhost viewer |
80
114
  | [`@agent-inspect/adapter-sdk`](packages/adapter-sdk/README.md) | Third-party adapters |
81
115
  | [`@agent-inspect/tui`](packages/tui/README.md) | Optional terminal UI |
82
- | `agent-inspect-vscode` | VS Code extension (in-repo, not on Marketplace yet) |
116
+ | `agent-inspect-vscode` | VS Code extension (in-repo; not on Marketplace yet) |
83
117
 
84
118
  ## Safety model
85
119
 
86
- - Traces are **local JSONL files** under `.agent-inspect/` (or `AGENT_INSPECT_TRACE_DIR`)
120
+ - Traces are **local JSONL** under `.agent-inspect/` (or `AGENT_INSPECT_TRACE_DIR`)
87
121
  - **Metadata-only by default** — no raw prompts/outputs unless you opt in
88
122
  - **No hidden upload** — AgentInspect does not send traces to the cloud
89
- - **Redaction profiles** — `local` / `share` / `strict` via [`@agent-inspect/redact`](packages/redact/README.md) or CLI
123
+ - **Redaction profiles** — `local` / `share` / `strict` via CLI or [`@agent-inspect/redact`](packages/redact/README.md)
90
124
  - **`scan` / `verify-safe`** — check artifacts before sharing
91
- - **Not** a chain-of-thought recorder or compliance engine
125
+ - **Not** a chain-of-thought recorder or compliance engine — review exports before posting
92
126
 
93
- Details: [Safe trace sharing](docs/SAFE-TRACE-SHARING.md) · [Security](SECURITY.md)
127
+ Details: [Safe sharing](https://agentinspect.vercel.app/docs/safe-sharing/) · [repo](docs/SAFE-TRACE-SHARING.md) · [Security](SECURITY.md)
94
128
 
95
129
  ## Documentation
96
130
 
97
- | Start | Reference | Adoption |
98
- | ----- | --------- | -------- |
99
- | [Getting started](docs/GETTING-STARTED.md) | [API](docs/API.md) | [Adoption](docs/ADOPTION.md) |
100
- | [One-page quickstart](docs/ONE-PAGE-QUICKSTART.md) | [CLI](docs/CLI.md) | [Demo script](docs/DEMO-SCRIPT.md) |
101
- | [First trace in 5 min](docs/FIRST-TRACE-IN-5-MINUTES.md) | [Adapters](docs/ADAPTERS.md) | [Compare](docs/COMPARE.md) |
102
- | [Examples](https://github.com/rajudandigam/agent-inspect/tree/main/examples) | [Performance](docs/PERFORMANCE.md) | [Pitch](docs/PITCH.md) |
131
+ | | Website | Repo |
132
+ | - | ------- | ---- |
133
+ | Getting started | [docs/getting-started](https://agentinspect.vercel.app/docs/getting-started/) | [GETTING-STARTED.md](docs/GETTING-STARTED.md) |
134
+ | Safe sharing | [docs/safe-sharing](https://agentinspect.vercel.app/docs/safe-sharing/) | [SAFE-TRACE-SHARING.md](docs/SAFE-TRACE-SHARING.md) |
135
+ | Compare | [docs/compare](https://agentinspect.vercel.app/docs/compare/) | [COMPARE.md](docs/COMPARE.md) |
136
+ | API / CLI | — | [API.md](docs/API.md) · [CLI.md](docs/CLI.md) |
137
+ | Adoption | — | [ADOPTION.md](docs/ADOPTION.md) · [USE-CASES.md](docs/USE-CASES.md) |
138
+ | Technical guide | — | [TECHNICAL-GUIDE.md](docs/TECHNICAL-GUIDE.md) |
139
+ | Examples | — | [starters](https://github.com/rajudandigam/agent-inspect/tree/main/examples/starters) |
140
+ | Visual demos | — | [SCREENSHOTS.md](docs/SCREENSHOTS.md) |
103
141
 
104
- Full index: [docs/README.md](docs/README.md) · Visual demos: [SCREENSHOTS.md](docs/SCREENSHOTS.md)
142
+ Full index: [docs/README.md](docs/README.md)
105
143
 
106
144
  ## What AgentInspect is not
107
145
 
108
146
  - Hosted SaaS or dashboard product
109
147
  - Production APM replacement (use LangSmith, Langfuse, OTel, etc. alongside)
110
148
  - Eval dataset platform or LLM-as-judge service
111
- - Prompt registry or pricing engine
149
+ - Prompt registry or provider pricing engine
112
150
  - Default telemetry uploader or replay engine
113
151
 
152
+ See [Compare](https://agentinspect.vercel.app/docs/compare/).
153
+
114
154
  ## Install details
115
155
 
116
- Current release: **3.5.0** (sixteen linked npm packages). Persisted trace schema **1.0**.
156
+ Current release: **3.5.3** (sixteen linked npm packages). Persisted trace schema **1.0**. Requires **Node.js >= 20**.
117
157
 
118
158
  ```bash
119
159
  pnpm add agent-inspect
package/SECURITY.md CHANGED
@@ -93,5 +93,5 @@ For a practical pre-share workflow, see `docs/SAFE-TRACE-SHARING.md`. For schema
93
93
  - Does not invoke user agent tools or mutate traces.
94
94
  - Configure via `AGENT_INSPECT_TRACE_DIR` and `AGENT_INSPECT_MCP_REDACTION_PROFILE` when documented.
95
95
 
96
- IDE marketplace extension is **deferred** — see [docs/IDE-SURFACES.md](docs/IDE-SURFACES.md).
96
+ IDE extension: see [VSCODE.md](docs/VSCODE.md) (in-repo; Marketplace deferred).
97
97
 
package/docs/ADAPTERS.md CHANGED
@@ -494,7 +494,7 @@ import { runReadOnlyMcpServer } from "@agent-inspect/mcp-server";
494
494
  await runReadOnlyMcpServer({ redactionProfile: "share" });
495
495
  ```
496
496
 
497
- Recipe: [examples/recipes/read-only-mcp-server](../examples/recipes/read-only-mcp-server/). IDE extension deferred: [IDE-SURFACES.md](./IDE-SURFACES.md).
497
+ Recipe: [examples/recipes/read-only-mcp-server](../examples/recipes/read-only-mcp-server/). VS Code: [VSCODE.md](./VSCODE.md).
498
498
 
499
499
  ---
500
500
 
package/docs/ADOPTION.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  AgentInspect is **local-first**: traces stay on disk, checks run in CI, and sharing is opt-in via redaction. This guide is the blessed path from zero to a working team workflow.
4
4
 
5
+ **Website:** [https://agentinspect.vercel.app/](https://agentinspect.vercel.app/) · **Docs:** [https://agentinspect.vercel.app/docs/](https://agentinspect.vercel.app/docs/) · **Getting started:** [https://agentinspect.vercel.app/docs/getting-started/](https://agentinspect.vercel.app/docs/getting-started/)
6
+
5
7
  ## Who this is for
6
8
 
7
9
  - TypeScript/Node teams shipping AI agents (not toy demos)
@@ -10,7 +12,7 @@ AgentInspect is **local-first**: traces stay on disk, checks run in CI, and shar
10
12
 
11
13
  ## 5-minute path
12
14
 
13
- See [FIRST-TRACE-IN-5-MINUTES.md](./FIRST-TRACE-IN-5-MINUTES.md).
15
+ See [FIRST-TRACE-IN-5-MINUTES.md](./FIRST-TRACE-IN-5-MINUTES.md) or the [docs site getting started](https://agentinspect.vercel.app/docs/getting-started/).
14
16
 
15
17
  ```bash
16
18
  npm install agent-inspect
@@ -0,0 +1,109 @@
1
+ # AI SDK adoption guide
2
+
3
+ Blessed path for **Vercel AI SDK** + AgentInspect — local traces only, metadata-first by default.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ npm install agent-inspect @agent-inspect/ai-sdk ai
9
+ ```
10
+
11
+ Or bootstrap a project:
12
+
13
+ ```bash
14
+ npx agent-inspect init --framework ai-sdk
15
+ ```
16
+
17
+ ## Minimal `generateText`
18
+
19
+ ```ts
20
+ import { generateText } from "ai";
21
+ import { agentInspect } from "@agent-inspect/ai-sdk";
22
+
23
+ await generateText({
24
+ model: yourModel,
25
+ prompt: "Hello",
26
+ experimental_telemetry: {
27
+ isEnabled: true,
28
+ recordInputs: false,
29
+ recordOutputs: false,
30
+ integrations: [
31
+ agentInspect({
32
+ traceDir: ".agent-inspect",
33
+ runName: "support-agent",
34
+ capture: "metadata-only",
35
+ }),
36
+ ],
37
+ },
38
+ });
39
+ ```
40
+
41
+ ## `streamText` (metadata-only)
42
+
43
+ ```ts
44
+ import { streamText } from "ai";
45
+ import { agentInspect } from "@agent-inspect/ai-sdk";
46
+
47
+ const result = streamText({
48
+ model: yourModel,
49
+ prompt: "Hello",
50
+ experimental_telemetry: {
51
+ isEnabled: true,
52
+ recordInputs: false,
53
+ recordOutputs: false,
54
+ integrations: [
55
+ agentInspect({
56
+ traceDir: ".agent-inspect",
57
+ runName: "stream-demo",
58
+ capture: "metadata-only",
59
+ }),
60
+ ],
61
+ },
62
+ });
63
+
64
+ for await (const _chunk of result.textStream) {
65
+ // consume stream
66
+ }
67
+ ```
68
+
69
+ Streaming lifecycle metadata is captured; raw token streams are not persisted by default.
70
+
71
+ ## Tool calls
72
+
73
+ Tool spans appear when the model invokes tools. Keep `recordInputs` / `recordOutputs` false unless you explicitly accept content capture risk.
74
+
75
+ ## Next.js route handler
76
+
77
+ See [examples/recipes/ai-sdk-next-route](../../examples/recipes/ai-sdk-next-route/) — one `agentInspect()` integration per request, no network, metadata-only defaults.
78
+
79
+ ## Privacy controls
80
+
81
+ | Setting | Required default | Why |
82
+ | ------- | ---------------- | --- |
83
+ | `recordInputs: false` | yes | Prevents AI SDK from recording prompts into telemetry payloads |
84
+ | `recordOutputs: false` | yes | Prevents model output capture in telemetry |
85
+ | `capture: "metadata-only"` | yes (adapter) | AgentInspect adapter redacts/bounds persisted fields |
86
+
87
+ ## Inspect locally
88
+
89
+ ```bash
90
+ npx agent-inspect list --dir .agent-inspect
91
+ npx agent-inspect open .agent-inspect/<run>.jsonl
92
+ npx agent-inspect check .agent-inspect/<run>.jsonl
93
+ ```
94
+
95
+ ## Troubleshooting
96
+
97
+ | Symptom | Fix |
98
+ | ------- | --- |
99
+ | No trace file | Ensure `experimental_telemetry.isEnabled: true` and integrations include `agentInspect()` |
100
+ | Empty trace | Confirm `AGENT_INSPECT` is not `0` |
101
+ | Prompts in trace | Set `recordInputs: false` and `recordOutputs: false` on the AI SDK call |
102
+ | Wrong directory | Pass `traceDir` to `agentInspect()` or set `AGENT_INSPECT_TRACE_DIR` |
103
+
104
+ ## Recipes (no network)
105
+
106
+ - [ai-sdk-local-telemetry](../../examples/recipes/ai-sdk-local-telemetry/)
107
+ - [ai-sdk-next-route](../../examples/recipes/ai-sdk-next-route/)
108
+
109
+ See also [ADAPTERS.md](./ADAPTERS.md) and [ADAPTER-CONFORMANCE.md](./ADAPTER-CONFORMANCE.md).
@@ -1,5 +1,7 @@
1
1
  ## Architecture
2
2
 
3
+ > **Adoption-focused overview:** see [TECHNICAL-GUIDE.md](./TECHNICAL-GUIDE.md) for a comprehensive technical guide (v3.5.3) suitable for blogs and outreach.
4
+
3
5
  AgentInspect is a **local-first execution-tree debugger**: manual traces and log ingest produce inspectable step trees stored as JSONL on disk (default `.agent-inspect-runs/`), with a CLI for list/view/clean/logs/tail/export/diff workflows.
4
6
 
5
7
  ### Package layout
@@ -1,5 +1,7 @@
1
1
  # CI trace artifacts
2
2
 
3
+ **Docs site:** [https://agentinspect.vercel.app/docs/ci/](https://agentinspect.vercel.app/docs/ci/)
4
+
3
5
  AgentInspect helps you **write and export traces locally** in CI. Uploading artifacts is done by **your CI platform** (e.g. GitHub Actions `upload-artifact`) — AgentInspect does not upload anywhere.
4
6
 
5
7
  ## Quick pattern
package/docs/COMPARE.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  AgentInspect is a local-first execution-tree debugger for TypeScript AI agents. It’s designed for inner-loop debugging, deterministic local eval heuristics, redaction, and quick inspection — not as a replacement for hosted observability, dataset evaluation, or production monitoring platforms.
4
4
 
5
+ **Docs site:** [https://agentinspect.vercel.app/docs/compare/](https://agentinspect.vercel.app/docs/compare/)
6
+
5
7
  ## AgentInspect vs console.log
6
8
 
7
9
  - **console.log is flat**: logs are a stream of lines without run grouping or step boundaries.
@@ -0,0 +1,87 @@
1
+ # Live demo script (~3 minutes)
2
+
3
+ **Audience:** TypeScript developers debugging AI agents.
4
+ **Prereqs:** Node 20+. Consumers: `npm install agent-inspect`. Monorepo: `pnpm build` at repo root.
5
+ **Website:** [https://agentinspect.vercel.app/](https://agentinspect.vercel.app/)
6
+
7
+ **Blessed demo starter:** [broken-agent-debugging](../examples/starters/broken-agent-debugging/) — intentional tool failure, no API keys.
8
+
9
+ ## Setup (before the call)
10
+
11
+ ```bash
12
+ cd examples/starters/broken-agent-debugging
13
+ pnpm install && pnpm start
14
+ npx agent-inspect list --dir .agent-inspect
15
+ ```
16
+
17
+ Copy a `<run-id>` for beats below.
18
+
19
+ ## Beat 1 — Problem (30s)
20
+
21
+ "Console logs are flat. When an agent picks the wrong tool or a step throws, you can't see parent/child relationships or which step failed first."
22
+
23
+ ## Beat 2 — Capture (45s)
24
+
25
+ ```bash
26
+ pnpm start # writes failing trace to .agent-inspect/
27
+ npx agent-inspect list --dir .agent-inspect
28
+ ```
29
+
30
+ Point out: run id, status, duration — **no upload**, metadata-only by default.
31
+
32
+ ## Beat 3 — Inspect (45s)
33
+
34
+ ```bash
35
+ npx agent-inspect report <run-id> --dir .agent-inspect
36
+ npx agent-inspect view <run-id> --dir .agent-inspect
37
+ npx agent-inspect timeline <run-id> --dir .agent-inspect
38
+ ```
39
+
40
+ Optional: `npx agent-inspect serve --dir .agent-inspect` for browser viewer.
41
+
42
+ ## Beat 4 — Verify (30s)
43
+
44
+ ```bash
45
+ npx agent-inspect check .agent-inspect/*.jsonl --require-completed
46
+ ```
47
+
48
+ Mention `--detect-stalls` and `--max-step-duration 30s` for long-running agents.
49
+
50
+ ## Beat 5 — Share safely (30s)
51
+
52
+ ```bash
53
+ npx agent-inspect redact .agent-inspect/*.jsonl --profile share -o safe.jsonl
54
+ npx agent-inspect verify-safe safe.jsonl
55
+ ```
56
+
57
+ "Redacted copy is safe to attach to a GitHub issue or Slack."
58
+
59
+ ## Beat 6 — Fix and diff (optional, 30s)
60
+
61
+ ```bash
62
+ pnpm run fixed
63
+ npx agent-inspect diff .agent-inspect/<broken-run>.jsonl .agent-inspect/<fixed-run>.jsonl
64
+ ```
65
+
66
+ ## Beat 7 — Close (15s)
67
+
68
+ "Starters for AI SDK, OpenAI Agents, LangChain, CI, and NestJS harness are in `examples/starters/`. Fresh repos: `npx agent-inspect init --yes`."
69
+
70
+ ## Alternative opener (zero clone)
71
+
72
+ ```bash
73
+ npm install agent-inspect
74
+ npx agent-inspect init --yes
75
+ node examples/agent-inspect-demo.mjs
76
+ npx agent-inspect list --dir .agent-inspect
77
+ ```
78
+
79
+ See [FIRST-TRACE-IN-5-MINUTES.md](./FIRST-TRACE-IN-5-MINUTES.md).
80
+
81
+ ## Optional beats
82
+
83
+ - **VS Code:** F5 from `packages/vscode` (dev host) — Marketplace listing pending
84
+ - **Doctor:** `npx agent-inspect doctor` when onboarding fails
85
+ - **Framework:** switch to `examples/starters/ai-sdk` for adapter path
86
+
87
+ Related: [VIDEO-WALKTHROUGH-SCRIPT.md](./VIDEO-WALKTHROUGH-SCRIPT.md) · [SCREENSHOTS.md](./SCREENSHOTS.md)
@@ -0,0 +1,71 @@
1
+ # Design partner guide
2
+
3
+ Thank you for trying AgentInspect early. This doc is the **evaluation contract** — what we ask you to try, what we measure, and what we won't do.
4
+
5
+ **Website:** [https://agentinspect.vercel.app/](https://agentinspect.vercel.app/) · **Docs:** [https://agentinspect.vercel.app/docs/](https://agentinspect.vercel.app/docs/)
6
+
7
+ ## What we're validating
8
+
9
+ 1. **First trace < 30 minutes** from `npm install` (with `init` + a starter)
10
+ 2. **First CI check** on a real or fixture trace
11
+ 3. **Share-safe workflow** — redacted artifact attached to an issue or PR
12
+ 4. **Framework fit** — AI SDK, OpenAI Agents, or LangChain path feels native enough
13
+
14
+ ## Your path
15
+
16
+ | Week | Task | Success signal |
17
+ | ---- | ---- | -------------- |
18
+ | 1 | Run `init` + one starter | `list` shows a run |
19
+ | 1 | `doctor` clean | No failed checks |
20
+ | 2 | Wire adapter or `observe()` in your app | Real trace captured |
21
+ | 2 | `check` or `eval` in CI | Job fails on bad fixture |
22
+ | 3 | `redact --profile share` | Comfortable posting trace externally |
23
+ | 4 | Feedback session | Case study draft or structured notes |
24
+
25
+ ## What we provide
26
+
27
+ - Starters: [examples/starters/](../examples/starters/README.md)
28
+ - Office hours async via GitHub Discussions / Issues
29
+ - [DEMO-SCRIPT.md](./DEMO-SCRIPT.md) for internal team demos
30
+
31
+ ## What we ask from you
32
+
33
+ - **Structured feedback** (template below) — not vague "looks good"
34
+ - **Redacted traces** only — never raw secrets
35
+ - Permission to quote anonymously unless you approve public case study
36
+
37
+ ## Feedback template
38
+
39
+ ```markdown
40
+ ### Environment
41
+ - Node version:
42
+ - Framework:
43
+ - AgentInspect version:
44
+
45
+ ### First trace
46
+ - Time to first trace:
47
+ - Blockers:
48
+
49
+ ### CI
50
+ - check/eval used?
51
+ - Rules that mattered:
52
+
53
+ ### Gaps
54
+ - Missing docs:
55
+ - Missing framework coverage:
56
+ - Would not adopt because:
57
+ ```
58
+
59
+ ## Metrics (no hidden telemetry)
60
+
61
+ We track adoption from **public signals** and **your reports** only. See [product/ADOPTION-METRICS.md](./product/ADOPTION-METRICS.md).
62
+
63
+ ## Out of scope for partners
64
+
65
+ - Hosted dashboards or SaaS
66
+ - Custom adapter development on our roadmap without demand gates
67
+ - SLAs — this is open-source MIT software
68
+
69
+ ## Contact
70
+
71
+ Open a GitHub issue with label `design-partner` or email the maintainer listed in the repo.
@@ -2,6 +2,14 @@
2
2
 
3
3
  Goal: install → one trace → one check → one share-safe artifact.
4
4
 
5
+ **Docs site:** [https://agentinspect.vercel.app/docs/getting-started/](https://agentinspect.vercel.app/docs/getting-started/)
6
+
7
+ ```bash
8
+ npm install agent-inspect && npx agent-inspect init --yes && node examples/agent-inspect-demo.mjs
9
+ npx agent-inspect list --dir .agent-inspect && npx agent-inspect report <run-id> --dir .agent-inspect
10
+ npx agent-inspect check .agent-inspect/*.jsonl && npx agent-inspect verify-safe --dir .agent-inspect
11
+ ```
12
+
5
13
  ## Minutes 0–1: Install
6
14
 
7
15
  ```bash
@@ -53,4 +61,4 @@ Attach redacted JSONL to a PR or issue — not raw traces.
53
61
  | CI tests | [CI artifacts](./CI-ARTIFACTS.md) |
54
62
  | Broken agent demo | [broken-agent-debugging starter](../examples/starters/broken-agent-debugging/README.md) |
55
63
 
56
- Full index: [docs/README.md](./README.md)
64
+ Full index: [docs/README.md](./README.md) · Website docs: [agentinspect.vercel.app/docs](https://agentinspect.vercel.app/docs/)
@@ -2,6 +2,8 @@
2
2
 
3
3
  AgentInspect is a **local-first execution-tree debugger** for TypeScript AI agents. It helps you produce and inspect an execution tree of steps, safely and deterministically, without uploading data anywhere.
4
4
 
5
+ **Website:** [https://agentinspect.vercel.app/](https://agentinspect.vercel.app/) · **Docs site:** [https://agentinspect.vercel.app/docs/getting-started/](https://agentinspect.vercel.app/docs/getting-started/)
6
+
5
7
  **Visual demos:** [SCREENSHOTS.md](./SCREENSHOTS.md)
6
8
 
7
9
  ## 1. Install
@@ -12,7 +14,7 @@ pnpm add agent-inspect
12
14
 
13
15
  ### Quick bootstrap (v3.1+)
14
16
 
15
- See also [FIRST-TRACE-IN-5-MINUTES.md](./FIRST-TRACE-IN-5-MINUTES.md) and [ONE-PAGE-QUICKSTART.md](./ONE-PAGE-QUICKSTART.md).
17
+ See also [FIRST-TRACE-IN-5-MINUTES.md](./FIRST-TRACE-IN-5-MINUTES.md).
16
18
 
17
19
  ```bash
18
20
  npx agent-inspect init --yes
package/docs/MIGRATION.md CHANGED
@@ -73,7 +73,7 @@ v3.0 is a **linked npm major** for the public package family. **Persisted trace
73
73
  ### What changes
74
74
 
75
75
  - New optional package [`@agent-inspect/adapter-sdk`](https://www.npmjs.com/package/@agent-inspect/adapter-sdk) for third-party adapter authoring (registration, conformance, privacy checklist, transform/renderer/indexer contracts).
76
- - Community extension process documented in [COMMUNITY-EXTENSION-REGISTRY.md](./COMMUNITY-EXTENSION-REGISTRY.md).
76
+ - Community extensions: [ADAPTER-CONFORMANCE.md](./ADAPTER-CONFORMANCE.md) and [`@agent-inspect/adapter-sdk`](../packages/adapter-sdk/README.md).
77
77
  - Extension interfaces are versioned in `@agent-inspect/adapter-sdk@3.x`; breaking extension API changes ship there, not in silent root patches.
78
78
 
79
79
  ### What stays the same
package/docs/NESTJS.md ADDED
@@ -0,0 +1,46 @@
1
+ # NestJS + AgentInspect (harness path)
2
+
3
+ AgentInspect does **not** ship a production NestJS interceptor in v3.2. Use **`@agent-inspect/harness`** to bootstrap real Nest apps for local fixture runs.
4
+
5
+ ## Recommended path (v3.2)
6
+
7
+ 1. `npx agent-inspect init` or use [examples/starters/harness-nestjs](../examples/starters/harness-nestjs/)
8
+ 2. Wire `createFixtureRunner()` with your `TestingModule` / app bootstrap
9
+ 3. Run targets with JSON fixtures — no real model calls by default
10
+
11
+ ```ts
12
+ import { createFixtureRunner, defineTarget } from "@agent-inspect/harness";
13
+
14
+ await createFixtureRunner({
15
+ name: "nestjs-support",
16
+ trace: { mode: "run-if-enabled", traceDir: ".agent-inspect" },
17
+ bootstrap: async () => {
18
+ const moduleRef = await Test.createTestingModule({ /* ... */ }).compile();
19
+ return moduleRef.createNestApplication();
20
+ },
21
+ shutdown: async (app) => {
22
+ await app?.close?.();
23
+ },
24
+ targets: {
25
+ ask: defineTarget({
26
+ resolve: (app) => app.get(SupportAgent),
27
+ invoke: (agent, input) => agent.run(input),
28
+ }),
29
+ },
30
+ }).runFromArgv();
31
+ ```
32
+
33
+ ## Out of scope (v3.2)
34
+
35
+ - `@agent-inspect/nestjs` production package (demand-gated)
36
+ - Redis/SQS mocking in harness
37
+ - Global monkey-patching of Nest providers
38
+
39
+ ## Structured logs alternative
40
+
41
+ If you only need log ingestion, see [examples/recipes/nestjs-json-logging](../examples/recipes/nestjs-json-logging/).
42
+
43
+ ## Related
44
+
45
+ - [`@agent-inspect/harness`](../packages/harness/README.md)
46
+ - [examples/starters/harness-nestjs](../examples/starters/harness-nestjs/)