* feat: add inbound attachment support to WASM channel system Add attachment record to WIT interface and implement inbound media parsing across all four channel implementations (Telegram, Slack, WhatsApp, Discord). Attachments flow from WASM channels through EmittedMessage to IncomingMessage with validation (size limits, MIME allowlist, count caps) at the host boundary. - Add `attachment` record to `emitted-message` in wit/channel.wit - Add `IncomingAttachment` struct to channel.rs and re-export - Add host-side validation (20MB total, 10 max, MIME allowlist) - Telegram: parse photo, document, audio, video, voice, sticker - Slack: parse file attachments with url_private - WhatsApp: parse image, audio, video, document with captions - Discord: backward-compatible empty attachments - Update FEATURE_PARITY.md section 7 - Add fixture-based tests per channel and host integration tests [skip-regression-check] Co-Authored-By: Claude Opus 4.6 <[email protected]> * feat: integrate outbound attachment support and reconcile WIT types (#409) Reconcile PR #409's outbound attachment work with our inbound attachment support into a unified design: WIT type split: - `inbound-attachment` in channel-host: metadata-only (id, mime_type, filename, size_bytes, source_url, storage_key, extracted_text) - `attachment` in channel: raw bytes (filename, mime_type, data) on agent-response for outbound sending Outbound features (from PR #409): - `on-broadcast` WIT export for proactive messages without prior inbound - Telegram: multipart sendPhoto/sendDocument with auto photo→document fallback for files >10MB - wrapper.rs: `call_on_broadcast`, `read_attachments` from disk, attachment params threaded through `call_on_respond` - HTTP tool: `save_to` param for binary downloads to /tmp/ (50MB limit, path traversal protection, SSRF-safe redirect following) - Message tool: allow /tmp/ paths for attachments alongside base_dir - Credential env var fallback in inject_channel_credentials Channel updates: - All 4 channels implement on_broadcast (Telegram full, others stub) - Telegram: polling_enabled config, adjusted poll timeout - Inbound attachment types renamed to InboundAttachment in all channels Tests: 1965 passing (9 new), 0 clippy warnings [skip-regression-check] Co-Authored-By: Claude Opus 4.6 <[email protected]> * feat: add audio transcription pipeline and extensible WIT attachment design Add host-side transcription middleware (OpenAI Whisper) that detects audio attachments with inline data on incoming messages and transcribes them automatically. Refactor WIT inbound-attachment to use extras-json and a store-attachment-data host function instead of typed fields, so future attachment properties (dimensions, codec, etc.) don't require WIT changes that invalidate all channel plugins. - Add src/transcription/ module: TranscriptionProvider trait, TranscriptionMiddleware, AudioFormat enum, OpenAI Whisper provider - Add src/config/transcription.rs: TRANSCRIPTION_ENABLED/MODEL/BASE_URL - Wire middleware into agent message loop via AgentDeps - WIT: replace data + duration-secs with extras-json + store-attachment-data - Host: parse extras-json for well-known keys, merge stored binary data - Telegram: download voice files via store-attachment-data, add duration to extras-json, add /file/bot to HTTP allowlist, voice-only placeholder - Add reqwest multipart feature for Whisper API uploads - 5 regression tests for transcription middleware Co-Authored-By: Claude Opus 4.6 <[email protected]> * feat: wire attachment processing into LLM pipeline with multimodal image support Attachments on incoming messages are now augmented into user text via XML tags before entering the turn system, and images with data are passed as multimodal content parts (base64 data URIs) to LLM providers. This enables audio transcripts, document text, and image content to reach the LLM without changes to ChatMessage serialization or provider interfaces. - Add src/agent/attachments.rs with augment_with_attachments() and 9 unit tests - Add ContentPart/ImageUrl types to llm::provider with OpenAI-compatible serde - Carry image_content_parts transiently on Turn (skipped in serialization) - Update nearai_chat and rig_adapter to serialize multimodal content - Add 3 e2e tests verifying attachments flow through the full agent loop Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: CI failures — formatting, version bumps, and Telegram voice test - Fix cargo fmt formatting in attachments.rs, nearai_chat.rs, rig_adapter.rs, e2e_attachments.rs - Bump channel registry versions 0.1.0 → 0.2.0 (discord, slack, telegram, whatsapp) to satisfy version-bump CI check - Fix Telegram test_extract_attachments_voice: add missing required `duration` field to voice fixture JSON Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: bump WIT channel version to 0.3.0, fix Telegram voice test, add pre-commit hook - Bump wit/channel.wit package version 0.2.0 → 0.3.0 (interface changed with store-attachment-data) - Update WIT_CHANNEL_VERSION constant and registry wit_version fields to match - Fix Telegram test_extract_attachments_voice: gate voice download behind #[cfg(target_arch = "wasm32")] so host functions aren't called in native tests, update assertions for generated filename and extras_json duration - Add @0.3.0 linker stubs in wit_compat.rs - Add .githooks/pre-commit hook that runs scripts/check-version-bumps.sh when WIT or extension sources are staged - Symlink commit-msg regression hook into .githooks/ [skip-regression-check] Co-Authored-By: Claude Opus 4.6 <[email protected]> * refactor: extract voice download from extract_attachments into handle_message Move download_voice_file + store_attachment_data calls out of extract_attachments into a separate download_and_store_voice function called from handle_message. This keeps extract_attachments as a pure data-mapping function with no host calls, making it fully testable in native unit tests without #[cfg(target_arch)] gates. [skip-regression-check] Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: address PR review comments — security, correctness, and code quality Security fixes: - Add path validation to read_attachments (restrict to /tmp/) preventing arbitrary file reads from compromised tools - Escape XML special characters in attachment filenames, MIME types, and extracted text to prevent prompt injection via tag spoofing - Percent-encode file_id in Telegram getFile URL to prevent query injection - Clone SecretString directly instead of expose_secret().to_string() Correctness fixes: - Fix store_attachment_data overwrite accounting: subtract old entry size before adding new to prevent inflated totals and false rejections - Use max(reported, stored_size) for attachment size accounting to prevent WASM channels from under-reporting size_bytes to bypass limits - Add application/octet-stream to MIME allowlist (channels default unknown types to this) Code quality: - Extract send_response helper in Telegram, deduplicating on_respond and on_broadcast - Rename misleading Discord test to test_parse_slash_command_interaction - Fix .githooks/commit-msg to use relative symlink (portable across machines) [skip-regression-check] Co-Authored-By: Claude Opus 4.6 <[email protected]> * feat: add tool_upgrade command + fix TOCTOU in save_to path validation Add `tool_upgrade` — a new extension management tool that automatically detects and reinstalls WASM extensions with outdated WIT versions. Preserves authentication secrets during upgrade. Supports upgrading a single extension by name or all installed WASM tools/channels at once. Fix TOCTOU in `validate_save_to_path`: validate the path *before* creating parent directories, so traversal paths like `/tmp/../../etc/` cannot cause filesystem mutations outside /tmp before being rejected. [skip-regression-check] Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: unify WIT package version to 0.3.0 across tool.wit and all capabilities tool.wit and channel.wit share the `near:agent` package namespace, so they must declare the same version. Bumps tool.wit from 0.2.0 to 0.3.0 and updates all capabilities files and registry entries to match. Fixes `cargo component build` failure: "package identifier near:[email protected] does not match previous package name of near:[email protected]" [skip-regression-check] Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: move WIT file comments after package declaration WIT treats `//` comments before `package` as doc comments. When both tool.wit and channel.wit had header comments, the parser rejected them as "doc comments on multiple 'package' items". Move comments after the package declaration in both files. Also bumps tool registry versions to 0.2.0 to match the WIT 0.3.0 bump. [skip-regression-check] Co-Authored-By: Claude Opus 4.6 <[email protected]> * feat: display extension versions in gateway Extensions tab Add version field to InstalledExtension and RegistryEntry types, pipe through the web API (ExtensionInfo, RegistryEntryInfo), and render as a badge in the gateway UI for both installed and available extensions. For installed WASM extensions, version is read from the capabilities file with a fallback to the registry entry when the local file has no version (old installations). Bump all extension Cargo.toml and registry JSON versions from 0.1.0 to 0.2.0 to keep them in sync. [skip-regression-check] Co-Authored-By: Claude Opus 4.6 <[email protected]> * feat: add document text extraction middleware for PDF, Office, and text files Extract text from document attachments (PDF, DOCX, PPTX, XLSX, RTF, plain text, code files) so the LLM can reason about uploaded documents. Uses pdf-extract for PDFs, zip+XML parsing for Office XML formats, and UTF-8 decode for text files. Wired into the agent loop after transcription middleware. Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: download document files in Telegram channel for text extraction The DocumentExtractionMiddleware needs file bytes in the attachment `data` field, but only voice files were being downloaded. Document attachments (PDFs, DOCX, etc.) had empty `data` and a source_url with a credential placeholder that only works inside the WASM host's http_request. Add `download_and_store_documents()` that downloads non-voice, non-image, non-audio attachments via the existing two-step getFile→download flow and stores bytes via `store_attachment_data` for host-side extraction. Also rename `download_voice_file` → `download_telegram_file` since it's generic for any file_id. Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: allow Office MIME types and increase file download limit for Telegram Two issues preventing document extraction from Telegram: 1. PPTX/DOCX/XLSX MIME types (application/vnd.*) were dropped by the WASM host attachment allowlist — add application/vnd., application/msword, and application/rtf prefixes. 2. Telegram file downloads over 10 MB failed with "Response body too large" — set max_response_bytes to 20 MB in Telegram capabilities. [skip-regression-check] Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: report document extraction errors back to user instead of silently skipping - Bump max_response_bytes to 50 MB for Telegram file downloads - When document extraction fails (too large, download error, parse error), set extracted_text to a user-friendly error message instead of leaving it None. This ensures the LLM tells the user what went wrong. - On Telegram download failure, set extracted_text with the error so the user sees feedback even when the file never reaches the extraction middleware. Co-Authored-By: Claude Opus 4.6 <[email protected]> * feat: store extracted document text in workspace memory for search/recall After document extraction succeeds, write the extracted text to workspace memory at `documents/{date}/{filename}`. This enables: - Full-text and semantic search over past uploaded documents - Cross-conversation recall ("what did that PDF say?") - Automatic chunking and embedding via the workspace pipeline Documents are stored with metadata header (uploader, channel, date, MIME type). Error messages (extraction failures) are not stored — only successful extractions. Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: CI failures — formatting, unused assignment warning - Run cargo fmt on document_extraction and agent_loop modules - Suppress unused_assignments warning on trace_llm_ref (used only behind #[cfg(feature = "libsql")]) [skip-regression-check] Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: address PR review comments — security, correctness, and code quality Security fixes: - Remove SSRF-prone download() from DocumentExtractionMiddleware (#13) - Sanitize filenames in workspace path to prevent directory traversal (#11) - Pre-check file size before reading in WASM wrapper to prevent OOM (#2) - Percent-encode file_id in Telegram source URLs (#7) Correctness fixes: - Clear image_content_parts on turn end to prevent memory leak (#1) - Find first *successful* transcription instead of first overall (#3) - Enforce data.len() size limit in document extraction (#10) - Use UTF-8 safe truncation with char_indices() (#12) Robustness & code quality: - Add 120s timeout to OpenAI Whisper HTTP client (#5) - Trim trailing slash from Whisper base_url (#6) - Allow ~/.ironclaw/ paths in WASM wrapper (#8) - Return error from on_broadcast in Slack/Discord/WhatsApp (#9) - Fix doc comment in HTTP tool (#4) Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: formatting — cargo fmt Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: address latest PR review — doc comments, error messages, version bumps - Fix DocumentExtractionMiddleware doc comment (no longer downloads from source_url) - Fix error message: "no inline data" instead of "no download URL" - Log error + fallback instead of silent unwrap_or_default on Whisper HTTP client - Bump all capabilities.json versions from 0.1.0 to 0.2.0 to match Cargo.toml Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: remove unsupported profile: minimal from CI workflows [skip-regression-check] dtolnay/rust-toolchain@stable does not accept the 'profile' input (it was a parameter for the deprecated actions-rs/toolchain action). Co-Authored-By: Claude Opus 4.6 <[email protected]> * fix: merge with latest main — resolve compilation errors and PR review nits - Add version: None to RegistryEntry/InstalledExtension test constructors - Fix MessageContent type mismatches in nearai_chat tests (String → MessageContent::Text) - Fix .contains() calls on MessageContent — use .as_text().unwrap() - Remove redundant trace_llm_ref = None assignment in test_rig - Check data size before clone in document extraction to avoid unnecessary allocation [skip-regression-check] Co-Authored-By: Claude Opus 4.6 <[email protected]> --------- Co-authored-by: Claude Opus 4.6 <[email protected]>
LLM Trace Fixtures
Trace fixtures are JSON files that script LLM behavior for deterministic E2E testing. The TraceLlm provider (tests/support/trace_llm.rs) replays these canned responses in order, allowing tests to exercise the full agent loop -- tool dispatch, safety layer, context accumulation -- without calling a real LLM.
Traces can be hand-written or recorded from a live session using the RecordingLlm wrapper (src/llm/recording.rs). Recorded traces include additional fields (memory snapshots, HTTP exchanges, expected tool results) that enable fully deterministic replay.
Trace Format
A trace is a model name and a list of turns. Each turn pairs a user message with the LLM response steps that follow it.
{
"model_name": "descriptive-name",
"turns": [
{
"user_input": "Write hello to /tmp/test.txt",
"steps": [
{
"response": {
"type": "tool_calls",
"tool_calls": [{ "id": "c1", "name": "write_file", "arguments": {"path": "/tmp/test.txt", "content": "hello"} }],
"input_tokens": 60, "output_tokens": 20
}
},
{
"response": {
"type": "text",
"content": "Done, wrote hello to the file.",
"input_tokens": 80, "output_tokens": 15
}
}
]
},
{
"user_input": "Actually, change it to goodbye instead",
"steps": [
{
"response": {
"type": "tool_calls",
"tool_calls": [{ "id": "c2", "name": "write_file", "arguments": {"path": "/tmp/test.txt", "content": "goodbye"} }],
"input_tokens": 100, "output_tokens": 20
}
},
{
"response": {
"type": "text",
"content": "Updated the file to say goodbye.",
"input_tokens": 120, "output_tokens": 15
}
}
]
}
]
}
TestRig::run_trace() drives the entire conversation automatically -- no test code needed to send user messages.
Legacy flat format
For backward compatibility, traces with a top-level "steps" array (no "turns") are accepted. They are deserialized as a single turn with a placeholder user message. Existing fixtures work unchanged; test code provides the user message via rig.send_message().
{
"model_name": "descriptive-name",
"memory_snapshot": [
{ "path": "context/vision.md", "content": "..." }
],
"http_exchanges": [
{
"request": { "method": "GET", "url": "https://api.example.com/data", "headers": [], "body": null },
"response": { "status": 200, "headers": [], "body": "{\"result\": 42}" }
}
],
"steps": [
{ "response": { "type": "text", "content": "Hello", "input_tokens": 10, "output_tokens": 5 } },
{
"response": { "type": "user_input", "content": "What time is it?" }
},
{
"request_hint": {
"last_user_message_contains": "optional substring",
"min_message_count": 1
},
"expected_tool_results": [
{ "tool_call_id": "call_time_1", "name": "time", "content": "14:30:00" }
],
"response": { "..." }
}
]
}
Top-level fields
| Field | Type | Required | Description |
|---|---|---|---|
model_name |
string | yes | Identifier returned by LlmProvider::model_name(). Convention: {category}-{scenario} (e.g. spot-smoke-greeting, advanced-tool-error-recovery). |
turns |
array | yes* | List of turns. Each turn has user_input (string) and steps (array of response steps). |
memory_snapshot |
array | no | Workspace memory documents captured before the recording session. Replay should restore these before running the trace. Each entry has path (string) and content (string). |
http_exchanges |
array | no | HTTP request/response pairs recorded during the session, in order. During replay, the ReplayingHttpInterceptor returns these instead of making real HTTP requests. |
expects |
object | no | Declarative expectations verified after replay. See Expects fields. |
*Or steps for the legacy flat format (deserialized as a single turn with a placeholder user message). Legacy steps are ordered: each complete() or complete_with_tools() call consumes the next text/tool_calls step. user_input steps are metadata markers and must be skipped during replay. If LLM calls exceed the number of playable steps, TraceLlm returns an error.
Turn fields
| Field | Type | Required | Description |
|---|---|---|---|
user_input |
string | yes | The user message that starts this turn. |
steps |
array | yes | Ordered list of LLM response steps for this turn. |
expects |
object | no | Per-turn expectations. Same schema as top-level expects. |
Step fields
| Field | Type | Required | Description |
|---|---|---|---|
request_hint |
object | no | Soft validation against the incoming request. Mismatches log a warning but do not fail the call. |
response |
object | yes | The canned response for this step. |
expected_tool_results |
array | no | Tool results that appeared in the message context since the previous step. During replay, the test harness can compare actual Role::Tool messages against these to verify tool output hasn't changed (regression detection). Each entry has tool_call_id, name, and content. |
Request hints
| Field | Type | Description |
|---|---|---|
last_user_message_contains |
string | Asserts the last Role::User message contains this substring. |
min_message_count |
integer | Asserts the message list has at least this many entries. |
Hints are intentionally soft -- they help catch wiring mistakes during test development without making traces brittle.
Determinism requirement
Trace fixtures must produce deterministic results across runs. Do not use tools whose output varies by time or environment state. Specifically:
Avoid:
time-- output changes every runlist_diron directories not created by the trace itselfshellwith commands that depend on system state (e.g.date,ps,ls /var)http-- external endpoints may change or be unavailablememory_searchunless the trace writes the memory entry first
Prefer:
echo-- always returns its inputjson-- deterministic parsing/formattingwrite_file+read_file-- self-contained if the trace writes firstmemory_write+memory_read-- deterministic if the trace writes firstshellwith deterministic commands (e.g.echo "hello",printf)
When a trace needs to exercise a stateful tool (like list_dir), have an earlier step create the expected state (e.g. write_file to create the directory contents first).
Response types
Responses are tagged via the type field.
text -- plain text completion
{
"type": "text",
"content": "The capital of France is Paris.",
"input_tokens": 40,
"output_tokens": 10
}
Returns a CompletionResponse / ToolCompletionResponse with no tool calls and FinishReason::Stop. If complete() is called (not complete_with_tools()), this is the only valid response type.
tool_calls -- one or more tool invocations
{
"type": "tool_calls",
"tool_calls": [
{
"id": "call_write_1",
"name": "write_file",
"arguments": { "path": "/tmp/test.txt", "content": "hello" }
}
],
"input_tokens": 80,
"output_tokens": 25
}
Returns a ToolCompletionResponse with FinishReason::ToolUse. The agent loop executes the tool calls against real tool implementations, feeds the results back as tool-result messages, then calls the LLM again (consuming the next step).
Important: tool_calls steps cause real tool execution. The tools run against the actual tool registry, so side effects (file writes, memory operations) happen for real. This is what makes these E2E tests -- the only mock is the LLM itself.
| Field | Type | Description |
|---|---|---|
id |
string | Unique call ID. Convention: call_{tool}_{n}. |
name |
string | Must match a registered tool name (e.g. echo, write_file, read_file, memory_write, shell). |
arguments |
object | Tool parameters as JSON. Must conform to the tool's parameters_schema(). |
user_input -- user message marker (recording only)
{
"type": "user_input",
"content": "What time is it?"
}
A metadata marker recording what the user said. This does not correspond to an LLM call. During replay, TraceLlm must skip user_input steps and only consume text/tool_calls steps. These steps are emitted by RecordingLlm when it detects new Role::User messages between LLM calls.
Token counts
Every text and tool_calls response includes input_tokens and output_tokens. These are synthetic values for cost tracking -- set them to reasonable estimates for your scenario. user_input steps do not have token counts.
Expected tool results
When present on a step, expected_tool_results lists the tool output that appeared in the message context before this LLM call. Each entry has:
| Field | Type | Description |
|---|---|---|
tool_call_id |
string | The id of the tool call that produced this result. |
name |
string | The tool name. |
content |
string | The full tool result content as it appeared in the message context. |
During replay, after tools execute and before returning the canned LLM response, the test harness should compare actual tool results against these entries. A content mismatch indicates a tool behavior change (regression).
Expects fields
The expects object can appear at the top level (whole trace) or per-turn. All fields are optional; traces without expects work unchanged.
| Field | Type | Description |
|---|---|---|
response_contains |
string[] |
Each must appear in response (case-insensitive). |
response_not_contains |
string[] |
None may appear in response. |
response_matches |
string |
Regex that must match response. |
tools_used |
string[] |
Each tool name must appear in started calls. |
tools_not_used |
string[] |
None of these may appear. |
all_tools_succeeded |
bool |
If true, all tools must succeed. |
max_tool_calls |
usize |
Upper bound on tool call count. |
min_responses |
usize |
Minimum response count. |
tool_results_contain |
map<string,string> |
Tool result preview must contain substring. |
Example (top-level):
{
"model_name": "recorded-telegram-check",
"expects": {
"response_contains": ["Telegram", "connected"],
"tools_used": ["echo"],
"all_tools_succeeded": true,
"tool_results_contain": { "echo": "Checking telegram" },
"min_responses": 1
},
"steps": [ ... ]
}
Example (per-turn):
{
"model_name": "multi-turn-example",
"turns": [
{
"user_input": "say hello",
"expects": { "response_contains": ["hello"], "tools_not_used": ["shell"] },
"steps": [ ... ]
}
]
}
run_recorded_trace("filename.json") in test code loads the fixture, builds a rig, replays, verifies all expects, and shuts down -- turning recorded trace tests into one-liners.
What gets mocked vs. what runs for real
| Component | Mocked? | Notes |
|---|---|---|
| LLM responses | Yes | TraceLlm replays canned responses from the trace |
| Tool execution | No | Real tools run: file I/O, memory ops, shell commands all execute |
| Outgoing HTTP (from tools) | Depends | Mocked when http_exchanges present and ReplayingHttpInterceptor is wired; real otherwise |
| Memory/workspace | Depends | Pre-seeded from memory_snapshot if present; real workspace operations otherwise |
| Safety layer | No | Sanitizer, validator, policy, leak detector all run |
| Context/message accumulation | No | Messages accumulate naturally across turns |
| Token counting | Partial | Uses synthetic counts from the trace |
Directory structure
llm_traces/
simple_text.json # Minimal single-turn text response
file_write_read.json # Write then read a file
memory_write_read.json # Memory write then text confirmation
error_path.json # Tool call with missing params, then recovery
spot/ # Quick smoke tests (1-3 steps each)
smoke_greeting.json # Simple greeting, no tools
smoke_math.json # Math question, no tools
robust_no_tool.json # Factual question, no tools
tool_echo.json # Single echo tool call + confirmation
tool_json.json # JSON parse tool call + confirmation
chain_write_read.json # Write file -> read file -> confirm
memory_save_recall.json # Memory write -> memory search -> confirm
robust_correct_tool.json
coverage/ # Broader tool and feature coverage
shell_echo.json # Shell command execution
list_dir.json # Directory listing
apply_patch_chain.json # File patching workflow
json_operations.json # JSON tool usage
injection_in_echo.json # Prompt injection in tool output
memory_full_cycle.json # Full memory write/search/read cycle
status_events_tool_chain.json
advanced/ # Multi-step and edge-case scenarios
long_tool_chain.json # Many sequential tool calls
tool_error_recovery.json # Failed tool call -> retry with valid path
multi_turn_memory.json # Memory across multiple turns
steering.json # User steering: correct agent mid-conversation
workspace_search.json # Workspace search workflows
prompt_injection_resilience.json
iteration_limit.json # Tests agent loop iteration bounds
Writing a new trace
-
Pick a category:
spot/for quick smoke tests,coverage/for tool/feature coverage,advanced/for complex multi-step scenarios. -
Name the model: Use
{category}-{scenario}(e.g.spot-tool-echo,coverage-shell-echo). -
Script the conversation: Think through the turn sequence. Each LLM call is one step. After a
tool_callsstep, the agent executes the tools and calls the LLM again with the results -- that's the next step. -
Add request hints on the first step of each turn (at minimum) to catch wiring issues. Later steps often omit hints since the message content depends on tool output.
-
End each turn with a
textstep so the agent has a final response to return.
Example -- single-turn trace:
{
"model_name": "spot-tool-echo",
"turns": [
{
"user_input": "Please echo hello for me",
"steps": [
{
"request_hint": { "last_user_message_contains": "echo" },
"response": {
"type": "tool_calls",
"tool_calls": [{ "id": "call_echo_1", "name": "echo", "arguments": { "message": "hello" } }],
"input_tokens": 60, "output_tokens": 20
}
},
{
"response": {
"type": "text",
"content": "The echo tool returned: hello",
"input_tokens": 80, "output_tokens": 15
}
}
]
}
]
}
Example -- multi-turn steering:
{
"model_name": "advanced-steering",
"turns": [
{
"user_input": "Write hello to /tmp/test.txt",
"steps": [
{
"response": {
"type": "tool_calls",
"tool_calls": [{ "id": "c1", "name": "write_file", "arguments": {"path": "/tmp/test.txt", "content": "hello"} }],
"input_tokens": 60, "output_tokens": 20
}
},
{ "response": { "type": "text", "content": "Done.", "input_tokens": 80, "output_tokens": 5 } }
]
},
{
"user_input": "Actually, change it to goodbye",
"steps": [
{
"response": {
"type": "tool_calls",
"tool_calls": [{ "id": "c2", "name": "write_file", "arguments": {"path": "/tmp/test.txt", "content": "goodbye"} }],
"input_tokens": 100, "output_tokens": 20
}
},
{ "response": { "type": "text", "content": "Updated.", "input_tokens": 120, "output_tokens": 5 } }
]
}
]
}
TraceLlm API
The provider exposes inspection methods for test assertions:
let llm = TraceLlm::from_file("tests/fixtures/llm_traces/spot/tool_echo.json")?;
// ... run agent loop ...
assert_eq!(llm.calls(), 2); // Total LLM calls made
assert_eq!(llm.hint_mismatches(), 0); // Request hint failures
let reqs = llm.captured_requests(); // Vec<Vec<ChatMessage>> of all requests
TestRig::run_trace()
For traces with multiple turns, run_trace() drives the entire conversation automatically:
let trace = LlmTrace::from_file("tests/fixtures/llm_traces/advanced/steering.json")?;
let rig = TestRigBuilder::new()
.with_trace(trace.clone())
.with_tools(tools_with_file_support())
.build()
.await;
// Sends each turn's user_input, waits for response, accumulates results.
let all_responses = rig.run_trace(&trace, Duration::from_secs(15)).await;
assert!(!all_responses[0].is_empty(), "Turn 1: no response");
assert!(!all_responses[1].is_empty(), "Turn 2: no response");
For legacy flat traces or when you need fine-grained control, use send_message() + wait_for_responses() directly.
Recording traces from live sessions
Instead of hand-writing traces, you can record them from a real LLM session using the RecordingLlm wrapper (src/llm/recording.rs). This captures everything needed for deterministic replay: user inputs, LLM responses, memory state, HTTP exchanges, and tool results.
Environment variables
| Variable | Required | Default | Description |
|---|---|---|---|
IRONCLAW_RECORD_TRACE |
yes | — | Set to any non-empty value to enable recording. |
IRONCLAW_TRACE_OUTPUT |
no | ./trace_{timestamp}.json |
Output file path for the recorded trace. |
IRONCLAW_TRACE_MODEL_NAME |
no | recorded-{model} |
The model_name field in the trace JSON. |
Usage
# Record a trace (writes to ./trace_20260304T120000.json)
IRONCLAW_RECORD_TRACE=1 cargo run
# Custom output path
IRONCLAW_RECORD_TRACE=1 IRONCLAW_TRACE_OUTPUT=my_trace.json cargo run
# Custom model name
IRONCLAW_RECORD_TRACE=1 IRONCLAW_TRACE_MODEL_NAME=regression-auth-flow cargo run
Run the agent normally, interact with it, then quit. The trace file is written on shutdown.
What gets recorded
- Memory snapshot -- all workspace documents are captured before the agent starts, saved in
memory_snapshot. - User inputs -- new
Role::Usermessages detected between LLM calls are emitted asuser_inputsteps. - LLM responses -- every
complete()/complete_with_tools()response is saved as atextortool_callsstep withrequest_hint. - Tool results -- new
Role::Toolmessages between LLM calls are captured inexpected_tool_resultson the next step. - HTTP exchanges -- all outgoing HTTP requests from tools are recorded via the
HttpInterceptorand saved inhttp_exchanges.
Using a recorded trace for replay
A recorded trace is a superset of the hand-written format. To use it:
- The replay provider (
TraceLlm) must skipuser_inputsteps -- they are metadata markers, not LLM responses. - If
memory_snapshotis present, restore workspace documents before running the trace. - If
http_exchangesis present, wire aReplayingHttpInterceptorintoJobContext.http_interceptorso tools get pre-recorded HTTP responses instead of making real requests. - If
expected_tool_resultsis present on a step, compare actual tool output against recorded values before returning the canned LLM response.
Example recorded trace
{
"model_name": "recorded-claude-3-5-sonnet",
"memory_snapshot": [
{ "path": "context/vision.md", "content": "# Vision\nBuild a secure AI assistant." }
],
"http_exchanges": [
{
"request": { "method": "GET", "url": "https://api.example.com/time" },
"response": { "status": 200, "body": "{\"time\": \"14:30\"}" }
}
],
"steps": [
{
"response": { "type": "user_input", "content": "What time is it?" }
},
{
"request_hint": { "last_user_message_contains": "What time is it?", "min_message_count": 2 },
"response": {
"type": "tool_calls",
"tool_calls": [
{ "id": "call_http_1", "name": "http", "arguments": { "url": "https://api.example.com/time" } }
],
"input_tokens": 60,
"output_tokens": 20
}
},
{
"request_hint": { "min_message_count": 4 },
"expected_tool_results": [
{ "tool_call_id": "call_http_1", "name": "http", "content": "{\"status\":200,\"body\":{\"time\":\"14:30\"}}" }
],
"response": {
"type": "text",
"content": "The current time is 2:30 PM.",
"input_tokens": 80,
"output_tokens": 15
}
}
]
}
Backward compatibility
Recorded traces are backward-compatible with hand-written traces. All new fields (memory_snapshot, http_exchanges, expected_tool_results, user_input steps) are optional and default to empty. Existing hand-written traces work unchanged.