meerkat 0.6.21

Modular, high-performance agent harness for LLM-powered applications
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
//! SDK tests for structured output extraction.
//!
//! These tests verify the structured output API works correctly from the SDK perspective.

#![allow(clippy::unwrap_used, clippy::expect_used, clippy::panic)]

use std::sync::{
    Arc,
    atomic::{AtomicUsize, Ordering},
};

use async_trait::async_trait;
use futures::stream;
use meerkat::{
    AgentBuilder, AgentFactory, AgentToolDispatcher, LlmDoneOutcome, LlmEvent, LlmRequest,
    OutputSchema, ToolDef, ToolError,
};
use meerkat_client::LlmClient;
use meerkat_core::ToolCallView;
use meerkat_core::ToolDispatchOutcome;
use serde::Deserialize;
use serde_json::{Value, json};
#[path = "support/test_session_store.rs"]
mod test_session_store;
use test_session_store::TestSessionStore;

/// Mock LLM client that returns valid JSON on extraction turn
struct MockLlmClientWithStructuredOutput {
    calls: Arc<AtomicUsize>,
}

#[async_trait]
impl LlmClient for MockLlmClientWithStructuredOutput {
    fn project_replay_messages(
        &self,
        messages: &[meerkat_core::Message],
    ) -> Result<Vec<meerkat_core::Message>, meerkat_client::LlmError> {
        Ok(messages.to_vec())
    }

    fn stream<'a>(
        &'a self,
        _request: &'a LlmRequest,
    ) -> std::pin::Pin<
        Box<dyn futures::Stream<Item = Result<LlmEvent, meerkat_client::LlmError>> + Send + 'a>,
    > {
        let call_index = self.calls.fetch_add(1, Ordering::SeqCst);
        if call_index == 0 {
            // First call - agent work complete
            Box::pin(stream::iter(vec![
                Ok(LlmEvent::TextDelta {
                    delta: "Let me provide the person info.".to_string(),
                    meta: None,
                }),
                Ok(LlmEvent::Done {
                    outcome: LlmDoneOutcome::Success {
                        stop_reason: meerkat::StopReason::EndTurn,
                    },
                }),
            ]))
        } else {
            // Second call - extraction turn with valid JSON
            Box::pin(stream::iter(vec![
                Ok(LlmEvent::TextDelta {
                    delta: r#"{"name": "Alice", "age": 30}"#.to_string(),
                    meta: None,
                }),
                Ok(LlmEvent::Done {
                    outcome: LlmDoneOutcome::Success {
                        stop_reason: meerkat::StopReason::EndTurn,
                    },
                }),
            ]))
        }
    }

    fn provider(&self) -> &'static str {
        "mock"
    }

    async fn health_check(&self) -> Result<(), meerkat_client::LlmError> {
        Ok(())
    }
}

/// Mock LLM client that returns invalid JSON then valid JSON (tests retry)
struct MockLlmClientWithRetry {
    calls: Arc<AtomicUsize>,
}

/// Mock LLM client that returns schema output wrapped in a named envelope.
struct MockLlmClientWithNamedWrapper {
    calls: Arc<AtomicUsize>,
}

#[async_trait]
impl LlmClient for MockLlmClientWithNamedWrapper {
    fn project_replay_messages(
        &self,
        messages: &[meerkat_core::Message],
    ) -> Result<Vec<meerkat_core::Message>, meerkat_client::LlmError> {
        Ok(messages.to_vec())
    }

    fn stream<'a>(
        &'a self,
        _request: &'a LlmRequest,
    ) -> std::pin::Pin<
        Box<dyn futures::Stream<Item = Result<LlmEvent, meerkat_client::LlmError>> + Send + 'a>,
    > {
        let call_index = self.calls.fetch_add(1, Ordering::SeqCst);
        if call_index == 0 {
            Box::pin(stream::iter(vec![
                Ok(LlmEvent::TextDelta {
                    delta: "Working...".to_string(),
                    meta: None,
                }),
                Ok(LlmEvent::Done {
                    outcome: LlmDoneOutcome::Success {
                        stop_reason: meerkat::StopReason::EndTurn,
                    },
                }),
            ]))
        } else {
            Box::pin(stream::iter(vec![
                Ok(LlmEvent::TextDelta {
                    delta: r#"{"advisor":{"name":"Eve","age":34}}"#.to_string(),
                    meta: None,
                }),
                Ok(LlmEvent::Done {
                    outcome: LlmDoneOutcome::Success {
                        stop_reason: meerkat::StopReason::EndTurn,
                    },
                }),
            ]))
        }
    }

    fn provider(&self) -> &'static str {
        "mock"
    }

    async fn health_check(&self) -> Result<(), meerkat_client::LlmError> {
        Ok(())
    }
}

#[async_trait]
impl LlmClient for MockLlmClientWithRetry {
    fn project_replay_messages(
        &self,
        messages: &[meerkat_core::Message],
    ) -> Result<Vec<meerkat_core::Message>, meerkat_client::LlmError> {
        Ok(messages.to_vec())
    }

    fn stream<'a>(
        &'a self,
        _request: &'a LlmRequest,
    ) -> std::pin::Pin<
        Box<dyn futures::Stream<Item = Result<LlmEvent, meerkat_client::LlmError>> + Send + 'a>,
    > {
        let call_index = self.calls.fetch_add(1, Ordering::SeqCst);
        match call_index {
            0 => {
                // First call - agent work complete
                Box::pin(stream::iter(vec![
                    Ok(LlmEvent::TextDelta {
                        delta: "Processing...".to_string(),
                        meta: None,
                    }),
                    Ok(LlmEvent::Done {
                        outcome: LlmDoneOutcome::Success {
                            stop_reason: meerkat::StopReason::EndTurn,
                        },
                    }),
                ]))
            }
            1 => {
                // Second call - extraction with invalid JSON (missing required field)
                Box::pin(stream::iter(vec![
                    Ok(LlmEvent::TextDelta {
                        delta: r#"{"name": "Bob"}"#.to_string(), // missing 'age'
                        meta: None,
                    }),
                    Ok(LlmEvent::Done {
                        outcome: LlmDoneOutcome::Success {
                            stop_reason: meerkat::StopReason::EndTurn,
                        },
                    }),
                ]))
            }
            _ => {
                // Third call - extraction with valid JSON
                Box::pin(stream::iter(vec![
                    Ok(LlmEvent::TextDelta {
                        delta: r#"{"name": "Bob", "age": 25}"#.to_string(),
                        meta: None,
                    }),
                    Ok(LlmEvent::Done {
                        outcome: LlmDoneOutcome::Success {
                            stop_reason: meerkat::StopReason::EndTurn,
                        },
                    }),
                ]))
            }
        }
    }

    fn provider(&self) -> &'static str {
        "mock"
    }

    async fn health_check(&self) -> Result<(), meerkat_client::LlmError> {
        Ok(())
    }
}

struct EmptyDispatcher;

#[async_trait]
impl AgentToolDispatcher for EmptyDispatcher {
    fn tools(&self) -> Arc<[Arc<ToolDef>]> {
        Arc::new([])
    }

    async fn dispatch(&self, call: ToolCallView<'_>) -> Result<ToolDispatchOutcome, ToolError> {
        Err(ToolError::NotFound {
            name: call.name.to_string(),
        })
    }
}

fn person_schema() -> Value {
    json!({
        "type": "object",
        "properties": {
            "name": {"type": "string"},
            "age": {"type": "integer"}
        },
        "required": ["name", "age"]
    })
}

#[derive(Debug, Deserialize, PartialEq)]
struct Person {
    name: String,
    age: u32,
}

#[tokio::test]
async fn sdk_structured_output_extraction_succeeds() -> Result<(), Box<dyn std::error::Error>> {
    let calls = Arc::new(AtomicUsize::new(0));

    let factory = AgentFactory::new(".rkat/sessions");
    let llm_client = Arc::new(MockLlmClientWithStructuredOutput {
        calls: calls.clone(),
    });
    let llm_adapter = Arc::new(
        factory
            .build_llm_adapter(llm_client, "claude-sonnet-4-6")
            .await,
    );

    let store = Arc::new(TestSessionStore::new());
    let store_adapter = Arc::new(factory.build_store_adapter(store).await);

    let tools: Arc<dyn AgentToolDispatcher> = Arc::new(EmptyDispatcher);

    let mut agent = AgentBuilder::new()
        .model("claude-sonnet-4-6")
        .max_tokens_per_turn(64)
        .output_schema(OutputSchema::new(person_schema())?)
        .build(llm_adapter, tools, store_adapter)
        .await?;

    let result = agent
        .run("Tell me about a person.".to_string().into())
        .await
        .expect("agent run should succeed");

    // Verify structured output is present
    assert!(
        result.structured_output.is_some(),
        "structured_output should be present"
    );

    // Verify it can be deserialized to the expected type
    let person: Person =
        serde_json::from_value(result.structured_output.unwrap()).expect("deserialize Person");

    assert_eq!(person.name, "Alice");
    assert_eq!(person.age, 30);

    // Verify extraction turn was called (2 calls total: agentic + extraction)
    assert_eq!(calls.load(Ordering::SeqCst), 2);
    Ok(())
}

#[tokio::test]
async fn sdk_structured_output_retry_on_invalid_json() -> Result<(), Box<dyn std::error::Error>> {
    let calls = Arc::new(AtomicUsize::new(0));

    let factory = AgentFactory::new(".rkat/sessions");
    let llm_client = Arc::new(MockLlmClientWithRetry {
        calls: calls.clone(),
    });
    let llm_adapter = Arc::new(
        factory
            .build_llm_adapter(llm_client, "claude-sonnet-4-6")
            .await,
    );

    let store = Arc::new(TestSessionStore::new());
    let store_adapter = Arc::new(factory.build_store_adapter(store).await);

    let tools: Arc<dyn AgentToolDispatcher> = Arc::new(EmptyDispatcher);

    let mut agent = AgentBuilder::new()
        .model("claude-sonnet-4-6")
        .max_tokens_per_turn(64)
        .output_schema(OutputSchema::new(person_schema())?)
        .structured_output_retries(2) // Allow retries
        .build(llm_adapter, tools, store_adapter)
        .await?;

    let result = agent
        .run("Tell me about a person.".to_string().into())
        .await
        .expect("agent run should succeed after retry");

    // Verify structured output is present
    let person: Person =
        serde_json::from_value(result.structured_output.unwrap()).expect("deserialize Person");

    assert_eq!(person.name, "Bob");
    assert_eq!(person.age, 25);

    // Verify retry occurred (3 calls: agentic + invalid extraction + valid extraction)
    assert_eq!(calls.load(Ordering::SeqCst), 3);
    Ok(())
}

#[tokio::test]
async fn sdk_no_structured_output_without_schema() {
    let calls = Arc::new(AtomicUsize::new(0));

    let factory = AgentFactory::new(".rkat/sessions");
    let llm_client = Arc::new(MockLlmClientWithStructuredOutput { calls });
    let llm_adapter = Arc::new(
        factory
            .build_llm_adapter(llm_client, "claude-sonnet-4-6")
            .await,
    );

    let store = Arc::new(TestSessionStore::new());
    let store_adapter = Arc::new(factory.build_store_adapter(store).await);

    let tools: Arc<dyn AgentToolDispatcher> = Arc::new(EmptyDispatcher);

    // NO output_schema configured
    let mut agent = AgentBuilder::new()
        .model("claude-sonnet-4-6")
        .max_tokens_per_turn(64)
        .build(llm_adapter, tools, store_adapter)
        .await
        .expect("public builder build");

    let result = agent
        .run("Hello".to_string().into())
        .await
        .expect("agent run should succeed");

    // Verify structured_output is NOT present (no extraction turn)
    assert!(
        result.structured_output.is_none(),
        "structured_output should be None without output_schema"
    );
}

#[tokio::test]
async fn sdk_output_schema_builder_pattern() -> Result<(), Box<dyn std::error::Error>> {
    // Test the OutputSchema builder API
    let schema = person_schema();

    let output_schema = OutputSchema::new(schema.clone())?
        .with_name("person")
        .strict();

    assert!(output_schema.strict);
    assert_eq!(output_schema.name, Some("person".to_string()));
    assert_eq!(output_schema.schema.as_value(), &schema);
    Ok(())
}

#[tokio::test]
async fn sdk_structured_output_unwraps_named_envelope() -> Result<(), Box<dyn std::error::Error>> {
    let calls = Arc::new(AtomicUsize::new(0));

    let factory = AgentFactory::new(".rkat/sessions");
    let llm_client = Arc::new(MockLlmClientWithNamedWrapper {
        calls: calls.clone(),
    });
    let llm_adapter = Arc::new(
        factory
            .build_llm_adapter(llm_client, "claude-sonnet-4-6")
            .await,
    );

    let store = Arc::new(TestSessionStore::new());
    let store_adapter = Arc::new(factory.build_store_adapter(store).await);

    let tools: Arc<dyn AgentToolDispatcher> = Arc::new(EmptyDispatcher);

    let mut agent = AgentBuilder::new()
        .model("claude-sonnet-4-6")
        .max_tokens_per_turn(64)
        .output_schema(OutputSchema::new(person_schema())?.with_name("advisor"))
        .build(llm_adapter, tools, store_adapter)
        .await?;

    let result = agent
        .run("Tell me about a person.".to_string().into())
        .await
        .expect("agent run should succeed");

    let person: Person =
        serde_json::from_value(result.structured_output.expect("structured output present"))
            .expect("deserialize Person");

    assert_eq!(
        person,
        Person {
            name: "Eve".to_string(),
            age: 34
        }
    );
    assert_eq!(calls.load(Ordering::SeqCst), 2);
    Ok(())
}