remem-ai 0.6.14

Local-first coding agent memory for Claude Code and OpenAI Codex
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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
use rmcp::handler::server::wrapper::Parameters;
use rmcp::{tool, tool_router};

use super::super::types::{CurrentStateParams, RawSearchHit, SearchParams, SearchResult};
use super::errors::{self, McpToolError, McpToolResult};
use super::MemoryServer;
use crate::memory::service;

const RAW_PREVIEW_CHARS: usize = 300;

#[tool_router(router = tool_router_search, vis = "pub(super)")]
impl MemoryServer {
    #[tool(
        description = "Resolve the current memory/fact state for a stable state key. Returns explicit current, not_found, ambiguous, or unresolved_conflict status plus compact history and why edges."
    )]
    pub(super) fn current_state(
        &self,
        Parameters(params): Parameters<CurrentStateParams>,
    ) -> McpToolResult<String> {
        const TOOL: &str = "current_state";
        if params.state_key.trim().is_empty() {
            return Err(McpToolError::invalid_request(TOOL, "state_key is required"));
        }
        self.with_conn(TOOL, |conn| {
            let req = service::CurrentStateRequest {
                state_key: params.state_key.clone(),
                project: params.project.clone(),
                owner_scope: params.owner_scope.clone(),
                owner_key: params.owner_key.clone(),
                memory_type: params.r#type.clone(),
                as_of_epoch: params.as_of_epoch,
                include_history: true,
            };
            let result = service::current_state(conn, &req).map_err(|e| {
                crate::log::warn("mcp", &format!("current_state failed: {}", e));
                McpToolError::db_query(TOOL, e)
            })?;
            errors::to_json_pretty(TOOL, &result)
        })
    }

    #[tool(
        description = "Search curated memories by query/project/type. Returns compact results with IDs, source='memory', pagination, and next_step for get_observations(ids, source). Use search_raw for literal chat recall."
    )]
    pub(super) fn search(
        &self,
        Parameters(params): Parameters<SearchParams>,
    ) -> McpToolResult<String> {
        const TOOL: &str = "search";
        let start = std::time::Instant::now();
        let requested_multi_hop = params.multi_hop.unwrap_or(false);
        let requested_explain = params.explain.unwrap_or(false);
        if requested_explain
            && params
                .query
                .as_deref()
                .is_none_or(|query| query.trim().is_empty())
        {
            return Err(McpToolError::invalid_request(
                TOOL,
                "explain requires a non-empty query; set query or explain=false",
            ));
        }
        if requested_multi_hop && requested_explain {
            return Err(McpToolError::invalid_request(
                TOOL,
                "explain is not supported with multi_hop search yet; set multi_hop=false or explain=false",
            ));
        }
        crate::log::info(
            "mcp",
            &format!(
                "search called query={:?} project={:?} type={:?} branch={:?} multi_hop={} limit={} offset={}",
                params.query,
                params.project,
                params.r#type,
                params.branch,
                requested_multi_hop,
                params.limit.unwrap_or(20),
                params.offset.unwrap_or(0),
            ),
        );
        self.with_conn(TOOL, |conn| {
            let req = service::SearchRequest {
                query: params.query.clone(),
                project: params.project.clone(),
                memory_type: params.r#type.clone(),
                limit: params.limit.unwrap_or(20),
                offset: params.offset.unwrap_or(0),
                include_stale: params
                    .include_stale
                    .unwrap_or_else(service::default_include_stale),
                include_suppressed: params
                    .include_suppressed
                    .unwrap_or_else(service::default_include_suppressed),
                branch: params.branch.clone(),
                multi_hop: requested_multi_hop,
                explain: requested_explain,
            };
            let search_set = service::search_memories(conn, &req).map_err(|e| {
                crate::log::warn("mcp", &format!("search failed: {}", e));
                McpToolError::db_query(TOOL, e)
            })?;
            let req_limit = req.limit;
            let req_offset = req.offset;
            let service::SearchResultSet {
                memories,
                multi_hop,
                has_more,
                explain,
                raw_hits,
                raw_error,
            } = search_set;
            let staleness_labels = if requested_explain {
                let now_epoch = chrono::Utc::now().timestamp();
                crate::memory::staleness::memory_staleness_labels_for_memories(
                    conn,
                    &memories,
                    now_epoch,
                )
                .map_err(|error| {
                    crate::log::error(
                        "mcp",
                        &format!("search staleness source-anchor lookup failed: {error}"),
                    );
                    McpToolError::db_query(TOOL, error)
                })?
            } else {
                std::collections::HashMap::new()
            };

            let search_results: Vec<SearchResult> = memories
                .into_iter()
                .map(|memory| {
                    let staleness = requested_explain
                        .then(|| staleness_labels.get(&memory.id).cloned())
                        .flatten();
                    let updated = chrono::DateTime::from_timestamp(memory.updated_at_epoch, 0)
                        .map(|dt| dt.format("%Y-%m-%d %H:%M").to_string())
                        .unwrap_or_default();
                    let temporal_facts = temporal_fact_preview_labels(&memory.text);
                    let preview = memory.text.chars().take(300).collect::<String>();
                    SearchResult {
                        id: memory.id,
                        r#type: memory.memory_type,
                        title: memory.title,
                        topic_key: memory.topic_key,
                        preview: Some(preview),
                        temporal_facts,
                        source: "memory".to_string(),
                        source_type: "memory".to_string(),
                        updated_at: updated,
                        project: memory.project,
                        status: memory.status,
                        staleness,
                    }
                })
                .collect();

            let raw_hits_json: Vec<RawSearchHit> = raw_hits
                .into_iter()
                .map(|msg| RawSearchHit {
                    id: msg.id,
                    source_type: "raw_archive".to_string(),
                    session_id: msg.session_id,
                    project: msg.project,
                    role: msg.role,
                    preview: msg.content.chars().take(RAW_PREVIEW_CHARS).collect(),
                    source: msg.source,
                    branch: msg.branch,
                    created_at: chrono::DateTime::from_timestamp(msg.created_at_epoch, 0)
                        .map(|dt| dt.format("%Y-%m-%d %H:%M").to_string())
                        .unwrap_or_default(),
                })
                .collect();

            let hop_info = if let Some(meta) = &multi_hop {
                format!(
                    " hops={} entities_discovered={}",
                    meta.hops,
                    meta.entities_discovered.len()
                )
            } else {
                String::new()
            };
            crate::log::info(
                "mcp",
                &format!(
                    "search done count={} raw_fallback={} {}ms{}",
                    search_results.len(),
                    raw_hits_json.len(),
                    start.elapsed().as_millis(),
                    hop_info,
                ),
            );

            let result_ids: Vec<i64> = search_results.iter().map(|result| result.id).collect();
            let next_offset = has_more.then_some(req_offset + req_limit);
            let mut response = serde_json::json!({
                "mode": "compact",
                "results": search_results,
                "next_step": {
                    "tool": "get_observations",
                    "source": "memory",
                    "ids": result_ids,
                    "reason": "Pass selected compact result IDs with source='memory' to fetch full details."
                },
                "pagination": {
                    "limit": req_limit,
                    "offset": req_offset,
                    "has_more": has_more,
                    "next_offset": next_offset,
                }
            });
            if req.include_suppressed {
                response["next_step"]["include_suppressed"] = serde_json::json!(true);
            }
            if let Some(meta) = multi_hop {
                response["multi_hop"] = serde_json::json!({
                    "hops": meta.hops,
                    "entities_discovered": meta.entities_discovered,
                });
            }
            if !raw_hits_json.is_empty() {
                response["raw_hits"] =
                    errors::to_json_value(TOOL, &raw_hits_json)?;
                response["raw_hits_note"] = serde_json::Value::String(
                    "raw_hits are source_type='raw_archive' chat rows, not curated memories; use search_raw for literal recall."
                        .to_string(),
                );
            }
            if let Some(error) = raw_error {
                response["raw_hits_error"] = serde_json::Value::String(error);
            }
            if has_more {
                response["has_more"] = serde_json::Value::Bool(true);
                response["next_offset"] = serde_json::Value::from(req_offset + req_limit);
            }
            if let Some(explain) = explain {
                response["explain"] = errors::to_json_value(TOOL, &explain)?;
            }
            errors::to_json_pretty(TOOL, &response)
        })
    }
}

fn temporal_fact_preview_labels(text: &str) -> Vec<String> {
    text.lines()
        .next()
        .and_then(|line| line.strip_prefix("Temporal facts: "))
        .map(|line| {
            line.split("; ")
                .map(str::trim)
                .filter(|label| !label.is_empty())
                .map(str::to_string)
                .collect()
        })
        .unwrap_or_default()
}

#[cfg(test)]
mod tests {
    use anyhow::Result;
    use rmcp::handler::server::wrapper::Parameters;
    use serde_json::Value;

    use super::*;
    use crate::db::test_support::ScopedTestDataDir;
    use crate::mcp::types::SearchParams;
    use crate::memory;

    fn base_search_params(explain: Option<bool>) -> SearchParams {
        SearchParams {
            query: Some("aurora".to_string()),
            limit: Some(5),
            project: Some("/repo".to_string()),
            r#type: None,
            offset: Some(0),
            include_stale: Some(true),
            include_suppressed: None,
            branch: None,
            multi_hop: Some(false),
            explain,
        }
    }

    fn default_visibility_search_params() -> SearchParams {
        SearchParams {
            include_stale: None,
            ..base_search_params(None)
        }
    }

    fn multi_hop_explain_params() -> SearchParams {
        SearchParams {
            multi_hop: Some(true),
            explain: Some(true),
            ..base_search_params(None)
        }
    }

    #[test]
    fn search_emits_explain_only_when_requested() -> Result<()> {
        let _dir = ScopedTestDataDir::new("mcp-search-explain");
        let conn = crate::db::open_db()?;
        let memory_id = memory::insert_memory(
            &conn,
            Some("session-1"),
            "/repo",
            Some("aurora-contract"),
            "Aurora contract decision",
            "The aurora recall contract keeps search compact before expansion.",
            "decision",
            None,
        )?;
        drop(conn);

        let server = MemoryServer::new()?;
        let default_response = server
            .search(Parameters(base_search_params(None)))
            .map_err(anyhow::Error::msg)?;
        let default_json: Value = serde_json::from_str(&default_response)?;
        assert!(default_json.get("explain").is_none());
        assert!(default_json["results"][0].get("staleness").is_none());

        let explain_response = server
            .search(Parameters(base_search_params(Some(true))))
            .map_err(anyhow::Error::msg)?;
        let explain_json: Value = serde_json::from_str(&explain_response)?;

        assert_eq!(explain_json["results"][0]["id"], memory_id);
        assert_eq!(explain_json["results"][0]["staleness"]["status"], "active");
        assert_eq!(
            explain_json["results"][0]["staleness"]["source_anchor"],
            "untracked"
        );
        assert_eq!(explain_json["explain"]["query"], "aurora");
        assert_eq!(
            explain_json["explain"]["results"][0]["memory_id"],
            memory_id
        );
        assert_eq!(
            explain_json["explain"]["results"][0]["staleness"]["status"],
            "active"
        );
        Ok(())
    }

    #[test]
    fn search_explain_fails_when_source_anchor_label_fails() -> Result<()> {
        let _dir = ScopedTestDataDir::new("mcp-search-staleness-source-error");
        let conn = crate::db::open_db()?;
        let memory_id = memory::insert_memory(
            &conn,
            Some("session-bad-staleness"),
            "/repo",
            None,
            "Aurora bad staleness",
            "The aurora bad source-anchor fixture should fail explain.",
            "decision",
            None,
        )?;
        conn.execute(
            "UPDATE memories SET files = '[not-json' WHERE id = ?1",
            [memory_id],
        )?;
        drop(conn);

        let server = MemoryServer::new()?;
        let error = server
            .search(Parameters(base_search_params(Some(true))))
            .expect_err("source-anchor failure should reject explain search");

        assert!(
            format!("{error:?}").contains("source-anchor staleness"),
            "{error:?}"
        );
        Ok(())
    }

    #[test]
    fn search_exposes_raw_fallback_failure() -> Result<()> {
        let _dir = ScopedTestDataDir::new("mcp-search-raw-fallback-error");
        let conn = crate::db::open_db()?;
        conn.execute("DROP TABLE raw_messages_fts", [])?;
        drop(conn);

        let server = MemoryServer::new()?;
        let response = server
            .search(Parameters(base_search_params(None)))
            .map_err(anyhow::Error::msg)?;
        let json: Value = serde_json::from_str(&response)?;

        assert_eq!(json["results"].as_array().map(Vec::len), Some(0));
        assert!(json.get("raw_hits").is_none());
        assert!(json["raw_hits_error"]
            .as_str()
            .is_some_and(|error| error.contains("raw archive fallback failed")));
        Ok(())
    }

    #[test]
    fn search_hides_inactive_memories_by_default() -> Result<()> {
        let _dir = ScopedTestDataDir::new("mcp-search-default-active");
        let conn = crate::db::open_db()?;
        let active_id = memory::insert_memory(
            &conn,
            Some("session-active"),
            "/repo",
            Some("aurora-active"),
            "Aurora active memory",
            "The aurora active decision remains visible.",
            "decision",
            None,
        )?;
        let stale_id = memory::insert_memory(
            &conn,
            Some("session-stale"),
            "/repo",
            Some("aurora-stale"),
            "Aurora stale memory",
            "The aurora stale decision is hidden by default.",
            "decision",
            None,
        )?;
        let archived_id = memory::insert_memory(
            &conn,
            Some("session-archived"),
            "/repo",
            Some("aurora-archived"),
            "Aurora archived memory",
            "The aurora archived decision is hidden by default.",
            "decision",
            None,
        )?;
        conn.execute(
            "UPDATE memories SET status = 'stale' WHERE id = ?1",
            rusqlite::params![stale_id],
        )?;
        conn.execute(
            "UPDATE memories SET status = 'archived' WHERE id = ?1",
            rusqlite::params![archived_id],
        )?;
        drop(conn);

        let server = MemoryServer::new()?;
        let response = server
            .search(Parameters(default_visibility_search_params()))
            .map_err(anyhow::Error::msg)?;
        let json: Value = serde_json::from_str(&response)?;

        assert_eq!(json["results"].as_array().map(Vec::len), Some(1));
        assert_eq!(json["results"][0]["id"], active_id);
        Ok(())
    }

    #[test]
    fn search_rejects_multi_hop_explain() -> Result<()> {
        let _dir = ScopedTestDataDir::new("mcp-search-explain-multi-hop");
        let server = MemoryServer::new()?;

        let err = server
            .search(Parameters(multi_hop_explain_params()))
            .expect_err("multi-hop explain should be rejected");
        let json: Value = serde_json::from_str(&err.to_string())?;

        assert_eq!(json["error"]["code"], "invalid_request");
        assert!(
            json["error"]["message"]
                .as_str()
                .unwrap_or_default()
                .contains("multi_hop"),
            "{}",
            json
        );
        Ok(())
    }

    #[test]
    fn search_rejects_explain_without_query() -> Result<()> {
        let _dir = ScopedTestDataDir::new("mcp-search-explain-missing-query");
        let server = MemoryServer::new()?;

        for query in [None, Some("")] {
            let mut params = base_search_params(Some(true));
            params.query = query.map(str::to_string);

            let err = server
                .search(Parameters(params))
                .expect_err("queryless explain should be rejected");
            let json: Value = serde_json::from_str(&err.to_string())?;

            assert_eq!(json["error"]["code"], "invalid_request");
            assert!(
                json["error"]["message"]
                    .as_str()
                    .unwrap_or_default()
                    .contains("non-empty query"),
                "{}",
                json
            );
        }
        Ok(())
    }

    #[test]
    fn temporal_fact_preview_labels_extracts_compact_labels() {
        let labels = temporal_fact_preview_labels(
            "Temporal facts: HarborMint verified_by Toma Reed; HarborMint blocked_by North\nBody",
        );

        assert_eq!(
            labels,
            vec![
                "HarborMint verified_by Toma Reed".to_string(),
                "HarborMint blocked_by North".to_string()
            ]
        );
    }
}