agent-inspect 6.17.1 → 6.17.2
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 +6 -0
- package/README.md +144 -177
- package/docs/CLI.md +1 -0
- package/docs/GOLDEN-PATH.md +1 -1
- package/docs/SCREENSHOTS.md +35 -204
- package/docs/SUPPORT-LEVELS.md +16 -5
- package/package.json +1 -1
- package/packages/cli/dist/{chunk-LFSBMUCD.mjs → chunk-FXGWXSFV.mjs} +20 -5
- package/packages/cli/dist/chunk-FXGWXSFV.mjs.map +1 -0
- package/packages/cli/dist/index.cjs +83 -24
- package/packages/cli/dist/index.cjs.map +1 -1
- package/packages/cli/dist/index.mjs +68 -24
- package/packages/cli/dist/index.mjs.map +1 -1
- package/packages/cli/dist/{src-5J2HPOJ3.mjs → src-EW7KW2BK.mjs} +3 -3
- package/packages/cli/dist/{src-5J2HPOJ3.mjs.map → src-EW7KW2BK.mjs.map} +1 -1
- package/packages/core/dist/advanced.cjs +18 -3
- package/packages/core/dist/advanced.cjs.map +1 -1
- package/packages/core/dist/advanced.mjs +1 -1
- package/packages/core/dist/checks.cjs +18 -3
- package/packages/core/dist/checks.cjs.map +1 -1
- package/packages/core/dist/checks.mjs +1 -1
- package/packages/core/dist/{chunk-NF4ZHNTC.mjs → chunk-UFP54T7F.mjs} +20 -5
- package/packages/core/dist/chunk-UFP54T7F.mjs.map +1 -0
- package/packages/cli/dist/chunk-LFSBMUCD.mjs.map +0 -1
- package/packages/core/dist/chunk-NF4ZHNTC.mjs.map +0 -1
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -5,23 +5,23 @@
|
|
|
5
5
|
</picture>
|
|
6
6
|
</p>
|
|
7
7
|
|
|
8
|
-
<
|
|
8
|
+
<p align="center"><strong>Local-first evidence for TypeScript AI agents</strong></p>
|
|
9
9
|
|
|
10
|
-
<
|
|
11
|
-
|
|
12
|
-
|
|
10
|
+
<h1 align="center">
|
|
11
|
+
See what your agent did.<br>
|
|
12
|
+
Catch the wrong path in CI.<br>
|
|
13
|
+
Keep the evidence local.
|
|
14
|
+
</h1>
|
|
13
15
|
|
|
14
16
|
<p align="center">
|
|
15
|
-
AgentInspect
|
|
17
|
+
AgentInspect turns TypeScript agent runs into readable execution trees,
|
|
18
|
+
deterministic trajectory checks, and portable Evidence v2—without requiring
|
|
19
|
+
an account, collector, or default upload.
|
|
16
20
|
</p>
|
|
17
21
|
|
|
18
|
-
<p align="center">
|
|
19
|
-
<em>See what your agent did. Prove the fix. Keep the evidence.</em>
|
|
20
|
-
</p>
|
|
22
|
+
<p align="center"><strong>Capture once. Debug, prevent, and share from the same local trace.</strong></p>
|
|
21
23
|
|
|
22
|
-
<p align="center">
|
|
23
|
-
<sub>No account · no collector · no default upload · metadata-only by default</sub>
|
|
24
|
-
</p>
|
|
24
|
+
<p align="center"><sub>No account · no collector · no default upload · metadata-only by default</sub></p>
|
|
25
25
|
|
|
26
26
|
<p align="center">
|
|
27
27
|
<a href="https://agentinspect.vercel.app/">Website</a> ·
|
|
@@ -32,234 +32,201 @@
|
|
|
32
32
|
|
|
33
33
|
<p align="center">
|
|
34
34
|
<a href="https://www.npmjs.com/package/agent-inspect"><img src="https://img.shields.io/npm/v/agent-inspect.svg" alt="npm version"></a>
|
|
35
|
-
<a href="LICENSE"><img src="https://img.shields.io/badge/
|
|
36
|
-
<a href="package.json"><img src="https://img.shields.io/badge/node-%3E%3D20-brightgreen" alt="Node.js
|
|
37
|
-
<a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-strict-3178c6" alt="TypeScript"></a>
|
|
35
|
+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT license"></a>
|
|
36
|
+
<a href="package.json"><img src="https://img.shields.io/badge/node-%3E%3D20-brightgreen" alt="Node.js 20 or newer"></a>
|
|
38
37
|
</p>
|
|
39
38
|
|
|
40
39
|
```bash
|
|
41
40
|
npm install agent-inspect
|
|
42
41
|
```
|
|
43
42
|
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
| **Test behavior deterministically** | TraceFacts, TraceContract, checks, suites, gates, and experimental Vitest/Jest matchers |
|
|
50
|
-
| **Produce portable evidence** | Offline Evidence v2 with integrity verification and share-policy disclosure |
|
|
51
|
-
| **Debug with coding assistants locally** | Read-only MCP over the same TraceFacts — no collector required |
|
|
52
|
-
|
|
53
|
-
```text
|
|
54
|
-
1. Capture one real run
|
|
55
|
-
2. Find the causal failure
|
|
56
|
-
3. Ask your coding agent to inspect it
|
|
57
|
-
4. Lock the fix with a contract
|
|
58
|
-
5. Attach the share-checked evidence
|
|
59
|
-
```
|
|
43
|
+
<p align="center">
|
|
44
|
+
<img src="https://raw.githubusercontent.com/rajudandigam/agent-inspect/main/docs/assets/showcase/gif/debug-tree.gif" alt="AgentInspect lists a local demo-good run, then you inspect the execution tree from the same JSONL" width="900">
|
|
45
|
+
</p>
|
|
46
|
+
|
|
47
|
+
Agent code rarely fails as one function call. It plans, retrieves, calls tools, invokes a model, retries, and produces side effects. Flat logs show fragments. AgentInspect keeps the run as local JSONL and gives you one evidence loop from the same trace.
|
|
60
48
|
|
|
61
49
|
<p align="center">
|
|
62
|
-
<img src="https://raw.githubusercontent.com/rajudandigam/agent-inspect/main/docs/assets/
|
|
50
|
+
<img src="https://raw.githubusercontent.com/rajudandigam/agent-inspect/main/docs/assets/showcase/diagrams/value-loop.svg" alt="Capture or import one local trace, then debug the run, prevent trajectory regressions, and prepare share-checked evidence" width="900">
|
|
63
51
|
</p>
|
|
64
52
|
|
|
65
|
-
##
|
|
53
|
+
## One trace. Three jobs.
|
|
66
54
|
|
|
67
|
-
|
|
55
|
+
### Debug — read the execution path
|
|
68
56
|
|
|
69
|
-
|
|
70
|
-
npm install agent-inspect
|
|
71
|
-
npx agent-inspect init --yes
|
|
72
|
-
# or: npx agent-inspect init --framework langgraph --yes
|
|
73
|
-
node examples/agent-inspect-demo.mjs
|
|
74
|
-
npx agent-inspect list --dir .agent-inspect
|
|
75
|
-
```
|
|
57
|
+
See nested steps, tool calls, LLM calls, model and token metadata, durations, errors, and the first causal failure without sending the trace to an AgentInspect service.
|
|
76
58
|
|
|
77
59
|
```bash
|
|
78
|
-
|
|
60
|
+
npx agent-inspect view <run-id> --dir .agent-inspect --summary
|
|
79
61
|
npx agent-inspect report <run-id> --dir .agent-inspect
|
|
80
|
-
npx agent-inspect
|
|
81
|
-
npx agent-inspect bundle <run-id> --dir .agent-inspect --profile share
|
|
82
|
-
npx agent-inspect verify-safe <run-id> --dir .agent-inspect
|
|
83
|
-
npx agent-inspect bundle verify .agent-inspect/bundles/<run-id>
|
|
84
|
-
# Optional coding-agent loop (dry-run by default):
|
|
85
|
-
npx agent-inspect mcp configure --client cursor
|
|
62
|
+
npx agent-inspect explain <run-id> --dir .agent-inspect
|
|
86
63
|
```
|
|
87
64
|
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
## Why AgentInspect
|
|
91
|
-
|
|
92
|
-
**Category:** the local evidence debugger and trajectory-test toolkit for TypeScript AI agents — not a hosted APM, eval host, or prompt registry. Complements LangSmith/Langfuse/Phoenix; owns the laptop → PR loop.
|
|
93
|
-
|
|
94
|
-
**Proof (public-safe):** Validated against production-shaped NestJS/LangGraph integrations. Fixture-backed across official adapters and packed consumer workflows.
|
|
65
|
+
Use manual instrumentation, official adapters, supported standards files, or structured logs you already emit.
|
|
95
66
|
|
|
96
|
-
|
|
97
|
-
| --------- | ------------ |
|
|
98
|
-
| Faithful execution trees | Nested steps, tools, LLMs, status, duration on disk |
|
|
99
|
-
| TraceFacts / logical projection | Canonical tool identity and semantic parity without inventing hierarchy |
|
|
100
|
-
| Deterministic checks / TraceContract (Beta) | Trajectory expectations without an LLM judge |
|
|
101
|
-
| Experimental Vitest/Jest matchers | `toPassTraceContract` · `toHaveRequiredTool` |
|
|
102
|
-
| Share-checked Evidence v2 | `bundle` + `bundle verify` with optional TraceFacts semantics |
|
|
103
|
-
| Read-only MCP coding-agent loop (Preview) | `get_trace_facts` and related tools over local traces |
|
|
67
|
+
### Prevent — fail CI on the wrong trajectory
|
|
104
68
|
|
|
105
|
-
|
|
69
|
+
<p align="center">
|
|
70
|
+
<img src="https://raw.githubusercontent.com/rajudandigam/agent-inspect/main/docs/assets/showcase/gif/check-pass-fail.gif" alt="The same deterministic AgentInspect check exits zero for demo-good and one for demo-regression" width="900">
|
|
71
|
+
</p>
|
|
106
72
|
|
|
107
|
-
|
|
108
|
-
| ---- | -------- | ----- |
|
|
109
|
-
| **Manual / observe** | Custom nesting or object methods | [Getting started](https://github.com/rajudandigam/agent-inspect/blob/main/docs/GETTING-STARTED.md) |
|
|
110
|
-
| **AI SDK** | Vercel AI SDK `generateText` / `streamText` | [`@agent-inspect/ai-sdk`](https://www.npmjs.com/package/@agent-inspect/ai-sdk) |
|
|
111
|
-
| **OpenAI Agents** | OpenAI Agents JS | [`@agent-inspect/openai-agents`](https://www.npmjs.com/package/@agent-inspect/openai-agents) |
|
|
112
|
-
| **LangChain / LangGraph** | Callbacks / LangGraph | [`@agent-inspect/langchain`](https://www.npmjs.com/package/@agent-inspect/langchain) · `init --framework langgraph` |
|
|
113
|
-
| **Structured logs** | Logs already emitted | [Log-to-tree](https://github.com/rajudandigam/agent-inspect/blob/main/docs/LOG-TO-TREE-QUICKSTART.md) |
|
|
114
|
-
| **Harness** | Fixture runner for real projects | [`@agent-inspect/harness`](https://www.npmjs.com/package/@agent-inspect/harness) |
|
|
115
|
-
| **CI reporters + matchers** | Failed-test artifacts and contracts | [`vitest`](https://www.npmjs.com/package/@agent-inspect/vitest) · [`jest`](https://www.npmjs.com/package/@agent-inspect/jest) |
|
|
116
|
-
| **Standards files** | OpenInference / OTLP JSON | [Standards](https://github.com/rajudandigam/agent-inspect/blob/main/docs/STANDARDS.md) |
|
|
73
|
+
Checks are deterministic and provider-free: the same trace and rules produce the same result. Start with a preset, then extend it with the expectations that matter to the workflow.
|
|
117
74
|
|
|
118
|
-
|
|
75
|
+
```bash
|
|
76
|
+
npx agent-inspect check <run-id> --dir .agent-inspect \
|
|
77
|
+
--preset trajectory \
|
|
78
|
+
--required-tool retrieve_policy \
|
|
79
|
+
--fail-on-observation failed
|
|
80
|
+
```
|
|
119
81
|
|
|
120
|
-
|
|
82
|
+
A passing check exits `0`; a rule failure exits `1`. Invalid configuration and unreadable/unsupported inputs use separate documented exit codes. Use TraceContract, suites, cohorts, Vitest/Jest reporters, or `--evidence-on fail` when the workflow needs more than one CLI check.
|
|
121
83
|
|
|
122
|
-
|
|
84
|
+
### Share — create reviewable offline evidence
|
|
123
85
|
|
|
124
|
-
|
|
86
|
+
<p align="center">
|
|
87
|
+
<img src="https://raw.githubusercontent.com/rajudandigam/agent-inspect/main/docs/assets/showcase/gif/evidence-bundle.gif" alt="AgentInspect writes a share-checked Evidence v2 bundle to ./evidence and verifies the listed file hashes offline" width="900">
|
|
88
|
+
</p>
|
|
125
89
|
|
|
126
|
-
|
|
90
|
+
```bash
|
|
91
|
+
npx agent-inspect verify-safe <run-id> --dir .agent-inspect
|
|
92
|
+
npx agent-inspect bundle <run-id> --dir .agent-inspect --profile share --out ./evidence
|
|
93
|
+
npx agent-inspect bundle verify ./evidence
|
|
94
|
+
```
|
|
127
95
|
|
|
128
|
-
|
|
96
|
+
`verify-safe` is a best-effort local assessment and can report `SAFE`, `SAFE WITH WARNINGS`, `UNSAFE`, or `UNKNOWN`. `bundle` writes a redacted artifact and manifest; `bundle verify` rechecks the listed file hashes offline. “Share-checked” is not compliance certification—review the artifact before attaching it to a PR, incident, or support handoff.
|
|
129
97
|
|
|
130
|
-
|
|
98
|
+
## First local trace
|
|
131
99
|
|
|
132
|
-
|
|
100
|
+
The generated demo is synthetic, keyless, and local. `npm install agent-inspect` does not copy repository examples; `init` writes them into the project.
|
|
133
101
|
|
|
134
|
-
|
|
102
|
+
```bash
|
|
103
|
+
npm install agent-inspect
|
|
104
|
+
npx agent-inspect init --yes
|
|
105
|
+
node examples/agent-inspect-demo.mjs
|
|
106
|
+
npx agent-inspect list --dir .agent-inspect
|
|
107
|
+
```
|
|
135
108
|
|
|
136
|
-
|
|
137
|
-
| -------- | ----- |
|
|
138
|
-
| Wrong tool / intentional failure | [broken-agent-debugging](https://github.com/rajudandigam/agent-inspect/tree/main/examples/starters/broken-agent-debugging) |
|
|
139
|
-
| Coding-agent MCP debug loop | [coding-agent-debug-loop](https://github.com/rajudandigam/agent-inspect/tree/main/examples/starters/coding-agent-debug-loop) · [CODING-AGENT-LOOP](https://github.com/rajudandigam/agent-inspect/blob/main/docs/CODING-AGENT-LOOP.md) |
|
|
140
|
-
| CI trajectory gate + Evidence | [ci-eval-redact](https://github.com/rajudandigam/agent-inspect/tree/main/examples/starters/ci-eval-redact) · [langgraph-gate-evidence](https://github.com/rajudandigam/agent-inspect/tree/main/examples/recipes/langgraph-gate-evidence) |
|
|
141
|
-
| Safe incident handoff | [Safe sharing](https://github.com/rajudandigam/agent-inspect/blob/main/docs/SAFE-TRACE-SHARING.md) |
|
|
142
|
-
| Multi-agent / session retry | [Sessions & outcomes](https://github.com/rajudandigam/agent-inspect/blob/main/docs/SESSIONS-AND-OUTCOMES.md) |
|
|
143
|
-
| Customer-owned team review | [Self-hosting](https://github.com/rajudandigam/agent-inspect/blob/main/docs/SELF-HOSTING.md) · Studio (optional) |
|
|
109
|
+
Copy the printed run ID, then inspect it:
|
|
144
110
|
|
|
145
|
-
|
|
111
|
+
```bash
|
|
112
|
+
npx agent-inspect view <run-id> --dir .agent-inspect --summary
|
|
113
|
+
npx agent-inspect check <run-id> --dir .agent-inspect --preset trajectory
|
|
114
|
+
npx agent-inspect verify-safe <run-id> --dir .agent-inspect
|
|
115
|
+
```
|
|
146
116
|
|
|
147
|
-
-
|
|
148
|
-
- **Metadata-only by default** — no raw prompts/outputs unless you opt in
|
|
149
|
-
- **No hidden upload** — core does not send traces to AgentInspect
|
|
150
|
-
- **Customer-owned Studio ingestion** is disabled by default and explicit when enabled
|
|
151
|
-
- **MCP server** exposes configured local evidence to the connected client (Preview)
|
|
152
|
-
- **Standards export** only when you run/configure it
|
|
153
|
-
- Redaction is **best-effort**, not certification — review before posting
|
|
154
|
-
- **Not** a chain-of-thought recorder
|
|
117
|
+
For a fixed good/regression/PII walkthrough with stable run ids (`demo-good`, `demo-regression`, `demo-pii`), use the [canonical keyless showcase](https://github.com/rajudandigam/agent-inspect/tree/main/examples/starters/broken-agent-debugging). The richer [blessed starters](https://github.com/rajudandigam/agent-inspect/tree/main/examples/starters) cover framework-specific paths.
|
|
155
118
|
|
|
156
|
-
|
|
119
|
+
## Use it with your stack
|
|
157
120
|
|
|
158
|
-
|
|
121
|
+
| Stack | Install / command | Start |
|
|
122
|
+
| --- | --- | --- |
|
|
123
|
+
| Custom functions or classes | `agent-inspect` | [Getting started](https://github.com/rajudandigam/agent-inspect/blob/main/docs/GETTING-STARTED.md) |
|
|
124
|
+
| LangChain / LangGraph | `agent-inspect` + `@agent-inspect/langchain` | [LangGraph guide](https://github.com/rajudandigam/agent-inspect/blob/main/docs/LANGGRAPH.md) |
|
|
125
|
+
| AI SDK | `agent-inspect` + `@agent-inspect/ai-sdk` | [AI SDK guide](https://github.com/rajudandigam/agent-inspect/blob/main/docs/AI-SDK-ADOPTION.md) |
|
|
126
|
+
| OpenAI Agents JS | `agent-inspect` + `@agent-inspect/openai-agents` | [Local processor guide](https://github.com/rajudandigam/agent-inspect/blob/main/docs/OPENAI-AGENTS-LOCAL.md) |
|
|
127
|
+
| Existing structured logs | `npx agent-inspect logs ...` | [Log-to-tree quickstart](https://github.com/rajudandigam/agent-inspect/blob/main/docs/LOG-TO-TREE-QUICKSTART.md) |
|
|
128
|
+
| OpenInference / OTLP JSON | `npx agent-inspect open ...` | [Standards](https://github.com/rajudandigam/agent-inspect/blob/main/docs/STANDARDS.md) |
|
|
129
|
+
| Vitest / Jest CI | `@agent-inspect/vitest` / `@agent-inspect/jest` | [CI artifacts](https://github.com/rajudandigam/agent-inspect/blob/main/docs/CI-ARTIFACTS.md) |
|
|
159
130
|
|
|
160
|
-
|
|
131
|
+
See [support levels](https://github.com/rajudandigam/agent-inspect/blob/main/docs/SUPPORT-LEVELS.md) for Stable, Supported, Beta, Preview, and Experimental surfaces.
|
|
161
132
|
|
|
162
|
-
|
|
133
|
+
## Programmatic trajectory checks
|
|
163
134
|
|
|
164
|
-
|
|
135
|
+
```ts
|
|
136
|
+
import { openTraceFile } from "agent-inspect/readers";
|
|
137
|
+
import {
|
|
138
|
+
defineTraceContract,
|
|
139
|
+
evaluateTraceContractRead,
|
|
140
|
+
} from "agent-inspect/checks";
|
|
165
141
|
|
|
166
|
-
|
|
142
|
+
const read = await openTraceFile("./trace.jsonl");
|
|
143
|
+
const contract = defineTraceContract({
|
|
144
|
+
run: { requireCompleted: true },
|
|
145
|
+
tools: { required: ["retrieve_policy"] },
|
|
146
|
+
});
|
|
167
147
|
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
- Prompt registry, pricing engine, or replay engine
|
|
172
|
-
- Universal standards exporter
|
|
173
|
-
- Compliance certification
|
|
148
|
+
const result = evaluateTraceContractRead(read, contract);
|
|
149
|
+
if (result.status !== "pass") process.exitCode = 1;
|
|
150
|
+
```
|
|
174
151
|
|
|
175
|
-
See [
|
|
152
|
+
The full API also exposes TraceFacts for bounded, logical analysis of supported traces. See [programmatic trace analysis](https://github.com/rajudandigam/agent-inspect/blob/main/docs/PROGRAMMATIC-TRACE-ANALYSIS.md).
|
|
176
153
|
|
|
177
|
-
|
|
178
|
-
<summary><strong>Package family (18 linked packages · tiered presentation)</strong></summary>
|
|
154
|
+
## Where AgentInspect fits
|
|
179
155
|
|
|
180
|
-
|
|
156
|
+
AgentInspect owns the laptop-to-PR evidence loop. It complements hosted observability, production trace retention, and broad eval platforms rather than replacing them.
|
|
181
157
|
|
|
182
|
-
|
|
158
|
+
| Need | Best fit |
|
|
159
|
+
| --- | --- |
|
|
160
|
+
| Inspect one local TypeScript agent run immediately | AgentInspect |
|
|
161
|
+
| Enforce deterministic tool/order/completion expectations in CI | AgentInspect |
|
|
162
|
+
| Attach a redacted, hash-verifiable offline artifact | AgentInspect |
|
|
163
|
+
| Monitor a production fleet with hosted dashboards and retention | Hosted observability / APM |
|
|
164
|
+
| Manage prompts, datasets, and online LLM-judge experiments | Eval / prompt platforms |
|
|
183
165
|
|
|
184
|
-
|
|
185
|
-
| ------- | ------- |
|
|
186
|
-
| [`agent-inspect`](https://www.npmjs.com/package/agent-inspect) | Core APIs + CLI + evidence |
|
|
187
|
-
| [`@agent-inspect/redact`](https://www.npmjs.com/package/@agent-inspect/redact) | Deterministic redaction |
|
|
188
|
-
| [`@agent-inspect/mcp-server`](https://www.npmjs.com/package/@agent-inspect/mcp-server) | Read-only MCP coding-agent loop (Preview) |
|
|
166
|
+
See the factual [comparison guide](https://github.com/rajudandigam/agent-inspect/blob/main/docs/COMPARE.md).
|
|
189
167
|
|
|
190
|
-
|
|
168
|
+
## Safety and network behavior
|
|
191
169
|
|
|
192
|
-
|
|
170
|
+
- Traces are local JSONL under `.agent-inspect/` or `AGENT_INSPECT_TRACE_DIR`.
|
|
171
|
+
- Capture is metadata-only by default; raw prompts and outputs require opt-in.
|
|
172
|
+
- Write-time redaction is enabled by default. The `redact` command creates a separate redacted copy and does not mutate its source.
|
|
173
|
+
- Core capture and inspection do not require an AgentInspect account, collector, or default upload.
|
|
174
|
+
- Redaction and `verify-safe` are best-effort controls, not privacy, security, or compliance certification.
|
|
175
|
+
- Optional MCP, standards export, and customer-owned Studio surfaces are explicit and have their own network boundaries.
|
|
176
|
+
- AgentInspect is not a chain-of-thought recorder.
|
|
193
177
|
|
|
194
|
-
|
|
195
|
-
| ------- | ------- |
|
|
196
|
-
| [`@agent-inspect/ai-sdk`](https://www.npmjs.com/package/@agent-inspect/ai-sdk) | AI SDK telemetry |
|
|
197
|
-
| [`@agent-inspect/openai-agents`](https://www.npmjs.com/package/@agent-inspect/openai-agents) | OpenAI Agents processor |
|
|
198
|
-
| [`@agent-inspect/langchain`](https://www.npmjs.com/package/@agent-inspect/langchain) | LangChain / LangGraph callbacks |
|
|
178
|
+
Read [network behavior](https://github.com/rajudandigam/agent-inspect/blob/main/docs/NETWORK-BEHAVIOR.md), [no-egress policy](https://github.com/rajudandigam/agent-inspect/blob/main/docs/NO-EGRESS-POLICY.md), and [safe trace sharing](https://github.com/rajudandigam/agent-inspect/blob/main/docs/SAFE-TRACE-SHARING.md).
|
|
199
179
|
|
|
200
|
-
|
|
180
|
+
## Optional coding-agent loop
|
|
201
181
|
|
|
202
|
-
|
|
203
|
-
| ------- | ------- |
|
|
204
|
-
| [`@agent-inspect/harness`](https://www.npmjs.com/package/@agent-inspect/harness) | Fixture runner |
|
|
205
|
-
| [`@agent-inspect/eval`](https://www.npmjs.com/package/@agent-inspect/eval) | Local eval heuristics |
|
|
206
|
-
| [`@agent-inspect/vitest`](https://www.npmjs.com/package/@agent-inspect/vitest) | Vitest reporter + experimental matchers |
|
|
207
|
-
| [`@agent-inspect/jest`](https://www.npmjs.com/package/@agent-inspect/jest) | Jest reporter + experimental matchers |
|
|
182
|
+
`@agent-inspect/mcp-server` exposes configured local evidence to an MCP client through bounded, read-only tools. It is optional and currently Preview; the core debug/check/evidence loop does not require it.
|
|
208
183
|
|
|
209
|
-
|
|
184
|
+
```bash
|
|
185
|
+
npx agent-inspect mcp configure --client cursor
|
|
186
|
+
```
|
|
210
187
|
|
|
211
|
-
|
|
212
|
-
| ------- | ------- |
|
|
213
|
-
| [`@agent-inspect/redact`](https://www.npmjs.com/package/@agent-inspect/redact) | Deterministic redaction |
|
|
214
|
-
| [`@agent-inspect/guardrails`](https://www.npmjs.com/package/@agent-inspect/guardrails) | Deterministic guardrail rules |
|
|
215
|
-
| [`@agent-inspect/circuit`](https://www.npmjs.com/package/@agent-inspect/circuit) | Loop / retry / timeout analyzers |
|
|
188
|
+
Review the generated dry-run configuration and the [coding-agent loop guide](https://github.com/rajudandigam/agent-inspect/blob/main/docs/CODING-AGENT-LOOP.md) before enabling it.
|
|
216
189
|
|
|
217
|
-
|
|
190
|
+
<details>
|
|
191
|
+
<summary><strong>Package family (18-package fixed release group)</strong></summary>
|
|
218
192
|
|
|
219
|
-
|
|
|
220
|
-
|
|
|
221
|
-
|
|
|
222
|
-
|
|
|
223
|
-
|
|
|
224
|
-
|
|
|
193
|
+
| Group | Packages |
|
|
194
|
+
| --- | --- |
|
|
195
|
+
| Core product | `agent-inspect`, `@agent-inspect/redact` |
|
|
196
|
+
| Framework integrations | `@agent-inspect/ai-sdk`, `@agent-inspect/openai-agents`, `@agent-inspect/langchain` |
|
|
197
|
+
| Testing and evaluation | `@agent-inspect/harness`, `@agent-inspect/eval`, `@agent-inspect/vitest`, `@agent-inspect/jest` |
|
|
198
|
+
| Safety analysis | `@agent-inspect/guardrails`, `@agent-inspect/circuit` |
|
|
199
|
+
| Developer surfaces | `@agent-inspect/viewer`, `@agent-inspect/tui`, `@agent-inspect/mcp`, `@agent-inspect/mcp-server` |
|
|
200
|
+
| Local/team optional surfaces | `@agent-inspect/index-sqlite`, `@agent-inspect/studio` |
|
|
201
|
+
| Extension SDK | `@agent-inspect/adapter-sdk` |
|
|
225
202
|
|
|
226
|
-
|
|
203
|
+
The root package is enough for custom capture, the CLI, checks, and Evidence workflows. Install optional packages only for the integration or surface you use. `agent-inspect-vscode` is currently in the repository and is not presented as a published Marketplace extension.
|
|
227
204
|
|
|
228
|
-
|
|
229
|
-
| ------- | ------- |
|
|
230
|
-
| [`@agent-inspect/index-sqlite`](https://www.npmjs.com/package/@agent-inspect/index-sqlite) | Optional SQLite index (Beta) |
|
|
231
|
-
| [`@agent-inspect/studio`](https://www.npmjs.com/package/@agent-inspect/studio) | Customer-owned Studio (Beta) |
|
|
205
|
+
</details>
|
|
232
206
|
|
|
233
|
-
|
|
207
|
+
## What it is not
|
|
234
208
|
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
209
|
+
- A maintainer-hosted SaaS or production APM replacement
|
|
210
|
+
- Hosted trace retention, a team dashboard service, or a prompt registry
|
|
211
|
+
- An LLM-as-judge or dataset platform by default
|
|
212
|
+
- A replay engine, automatic remediation system, or compliance certification
|
|
238
213
|
|
|
239
|
-
|
|
214
|
+
## Status and documentation
|
|
240
215
|
|
|
241
|
-
|
|
216
|
+
**Current published baseline:** **6.17.2** · persisted schema `1.0` · Node.js `>=20` · MIT.
|
|
242
217
|
|
|
243
|
-
|
|
218
|
+
Legacy v0.1 and v0.2 traces remain readable. Check the npm badge and [changelog](CHANGELOG.md) for the current published version.
|
|
244
219
|
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
| Full index | — | [docs/README.md](https://github.com/rajudandigam/agent-inspect/blob/main/docs/README.md) |
|
|
220
|
+
- [First trace in five minutes](https://github.com/rajudandigam/agent-inspect/blob/main/docs/FIRST-TRACE-IN-5-MINUTES.md)
|
|
221
|
+
- [CLI reference](https://github.com/rajudandigam/agent-inspect/blob/main/docs/CLI.md)
|
|
222
|
+
- [Trace contracts](https://github.com/rajudandigam/agent-inspect/blob/main/docs/TRACE-CONTRACTS.md)
|
|
223
|
+
- [Evidence format](https://github.com/rajudandigam/agent-inspect/blob/main/docs/EVIDENCE-FORMAT.md)
|
|
224
|
+
- [Use cases](https://github.com/rajudandigam/agent-inspect/blob/main/docs/USE-CASES.md)
|
|
225
|
+
- [Demos and screenshots](https://github.com/rajudandigam/agent-inspect/blob/main/docs/SCREENSHOTS.md)
|
|
226
|
+
- [Full documentation index](https://github.com/rajudandigam/agent-inspect/blob/main/docs/README.md)
|
|
253
227
|
|
|
254
228
|
## Contributing
|
|
255
229
|
|
|
256
|
-
[CONTRIBUTING.md](
|
|
257
|
-
|
|
258
|
-
**Redact traces before posting issues or PRs.**
|
|
259
|
-
|
|
260
|
-
```bash
|
|
261
|
-
pnpm add agent-inspect
|
|
262
|
-
npx agent-inspect doctor
|
|
263
|
-
```
|
|
230
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md), [good first issues](GOOD-FIRST-ISSUES.md), and [GitHub Discussions](https://github.com/rajudandigam/agent-inspect/discussions).
|
|
264
231
|
|
|
265
|
-
|
|
232
|
+
**Redact and review traces before posting them in issues or pull requests.**
|
package/docs/CLI.md
CHANGED
|
@@ -322,6 +322,7 @@ Options:
|
|
|
322
322
|
- `trajectory`: completion/structure/relationship focus; excludes share-safety findings
|
|
323
323
|
- `safety`: raw-content / secret / redaction focus
|
|
324
324
|
- `comprehensive`: union of trajectory and safety
|
|
325
|
+
- Presets are a base select set. CLI shorthands on the same invocation (`--fail-on-observation`, `--required-tool`, `--forbidden-tool`, `--allowed-model`, `--max-total-tokens`, `--max-duration-ms`, `--max-step-duration`, `--detect-stalls`) extend that set; they are not dropped because the preset already selected rules. Config `checks.select` is not silently expanded with unrelated configured rules.
|
|
325
326
|
- `--evidence-on <fail|always|never>`: write local Evidence v2 (no upload); omitted = never
|
|
326
327
|
- `--evidence-dir <path>`: Evidence output directory or base path
|
|
327
328
|
- `--evidence-profile <local|share|strict>`: redaction profile for Evidence (default `share`)
|