holographic-memory 0.6.4

Local-first search engine and agent memory: fast approximate nearest-neighbor and BM25 full-text search, encrypted stores, provable deletion, built on vector-symbolic architectures.
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
// Copyright 2024-2026 WritersLogic Contributors
// SPDX-License-Identifier: Apache-2.0
//! The rmcp `ServerHandler`: tools, resources and prompts over an `HmsBackend`.

use std::fmt::Write as _;
use std::sync::Arc;
use std::time::Instant;

use rmcp::model::{
    CallToolRequestParams, CallToolResponse, CallToolResult, ContentBlock, ErrorData,
    GetPromptRequestParams, GetPromptResponse, ListPromptsResult, ListResourceTemplatesResult,
    ListResourcesResult, ListToolsResult, PaginatedRequestParams, ReadResourceRequestParams,
    ReadResourceResponse, ServerCapabilities, ServerConfig,
};
use rmcp::service::RequestContext;
use rmcp::{RoleServer, ServerHandler};
use serde::de::DeserializeOwned;
use serde_json::{json, Map, Value};
use tokio::sync::Semaphore;

use crate::memory::{preview, Fail, Limits, ListReq, SearchReq};
use crate::store::HmsBackend;
use crate::tools::{self, Exposure};

const INSTRUCTIONS: &str = "Persistent memory backed by Holographic Memory, stored on this machine. \
Use `recall` before answering questions that earlier conversations may have settled, and `remember` \
for durable facts, decisions and preferences (one fact or topic per memory). `search` gives explicit \
control over filters and ranking; `list`, `get`, `forget`, `stats` and `export` manage the store.";

const RESOURCE_PAGE: usize = 100;
const MEMORY_URI: &str = "hms://memory/";
const STATS_URI: &str = "hms://stats";

pub struct Inner {
    pub backend: Arc<HmsBackend>,
    pub exposure: Exposure,
    pub limits: Limits,
    pub resources: bool,
    pub prompts: bool,
    pub gate: Semaphore,
}

#[derive(Clone)]
pub struct HmsMcp {
    pub inner: Arc<Inner>,
}

impl HmsMcp {
    pub fn new(
        backend: Arc<HmsBackend>,
        exposure: Exposure,
        limits: Limits,
        resources: bool,
        prompts: bool,
        max_concurrent: usize,
    ) -> Self {
        Self {
            inner: Arc::new(Inner {
                backend,
                exposure,
                limits,
                resources,
                prompts,
                gate: Semaphore::new(max_concurrent),
            }),
        }
    }

    /// Run blocking store work on a worker thread, at most `max_concurrent` at a time.
    async fn run<T: Send + 'static>(
        &self,
        work: impl FnOnce(&Inner) -> T + Send + 'static,
    ) -> Result<T, ErrorData> {
        let permit = self
            .inner
            .gate
            .acquire()
            .await
            .map_err(|_| ErrorData::internal_error("server is shutting down", None))?;
        let inner = Arc::clone(&self.inner);
        let out = tokio::task::spawn_blocking(move || work(&inner)).await;
        drop(permit);
        out.map_err(|e| {
            crate::log::error(&format!("worker failed: {e}"));
            ErrorData::internal_error("internal error; see the server log", None)
        })
    }
}

fn from_json<T: DeserializeOwned>(value: Value) -> Result<T, ErrorData> {
    serde_json::from_value(value).map_err(|e| {
        crate::log::error(&format!("protocol type mismatch: {e}"));
        ErrorData::internal_error("internal error; see the server log", None)
    })
}

fn fail_result(fail: &Fail) -> Result<CallToolResponse, ErrorData> {
    let structured = json!({"error": fail});
    let text = serde_json::to_string(&structured).unwrap_or_default();
    let mut result = CallToolResult::success(vec![ContentBlock::text(text)]);
    result.is_error = Some(true);
    result.structured_content = Some(structured);
    Ok(result.into())
}

fn percent_encode(id: &str) -> String {
    let mut out = String::with_capacity(id.len());
    for b in id.bytes() {
        if b.is_ascii_alphanumeric() || matches!(b, b'-' | b'.' | b'_' | b'~') {
            out.push(char::from(b));
        } else {
            let _ = write!(out, "%{b:02X}");
        }
    }
    out
}

fn percent_decode(text: &str) -> Option<String> {
    let bytes = text.as_bytes();
    let mut out = Vec::with_capacity(bytes.len());
    let mut i = 0;
    while i < bytes.len() {
        if bytes[i] == b'%' {
            let hex = text.get(i + 1..i + 3)?;
            out.push(u8::from_str_radix(hex, 16).ok()?);
            i += 3;
        } else {
            out.push(bytes[i]);
            i += 1;
        }
    }
    String::from_utf8(out).ok()
}

fn memory_uri(namespace: &str, default_namespace: &str, id: &str) -> String {
    if namespace == default_namespace {
        format!("{MEMORY_URI}{}", percent_encode(id))
    } else {
        format!("hms://namespace/{namespace}/memory/{}", percent_encode(id))
    }
}

/// Splits a memory URI into (namespace, id).
fn parse_memory_uri(uri: &str, exposure: &Exposure) -> Option<(String, String)> {
    if let Some(rest) = uri.strip_prefix(MEMORY_URI) {
        return Some((exposure.default_namespace.clone(), percent_decode(rest)?));
    }
    let rest = uri.strip_prefix("hms://namespace/")?;
    let (ns, id) = rest.split_once("/memory/")?;
    Some((ns.to_string(), percent_decode(id)?))
}

fn recall_text(hits: &[crate::memory::Hit]) -> String {
    if hits.is_empty() {
        return "(no matching memories)".into();
    }
    hits.iter()
        .enumerate()
        .map(|(i, h)| {
            let label = h.memory.title.as_deref().unwrap_or(&h.memory.id);
            format!(
                "[{}] {} (id {})\n{}",
                i + 1,
                label,
                h.memory.id,
                h.memory.text
            )
        })
        .collect::<Vec<_>>()
        .join("\n\n")
}

impl ServerHandler for HmsMcp {
    fn get_info(&self) -> ServerConfig {
        let mut caps = serde_json::Map::new();
        caps.insert("tools".into(), json!({}));
        if self.inner.resources {
            caps.insert("resources".into(), json!({}));
        }
        if self.inner.prompts {
            caps.insert("prompts".into(), json!({}));
        }
        let caps: ServerCapabilities =
            serde_json::from_value(Value::Object(caps)).unwrap_or_default();
        let mut info = ServerConfig::new(caps).with_instructions(INSTRUCTIONS);
        info.server_info =
            rmcp::model::Implementation::new("holographic-memory", env!("CARGO_PKG_VERSION"))
                .with_title("Holographic Memory");
        info
    }

    async fn list_tools(
        &self,
        _request: Option<PaginatedRequestParams>,
        _context: RequestContext<RoleServer>,
    ) -> Result<ListToolsResult, ErrorData> {
        let definitions = tools::definitions(&self.inner.exposure, &self.inner.limits);
        let list: Vec<rmcp::model::Tool> = from_json(Value::Array(definitions))?;
        Ok(ListToolsResult::with_all_items(list))
    }

    fn get_tool(&self, name: &str) -> Option<rmcp::model::Tool> {
        tools::definitions(&self.inner.exposure, &self.inner.limits)
            .into_iter()
            .find(|t| t["name"] == name)
            .and_then(|t| serde_json::from_value(t).ok())
    }

    async fn call_tool(
        &self,
        request: CallToolRequestParams,
        _context: RequestContext<RoleServer>,
    ) -> Result<CallToolResponse, ErrorData> {
        let name = request.name.to_string();
        if !self.inner.exposure.enabled.contains(name.as_str()) {
            return Err(ErrorData::invalid_params(
                format!("unknown tool {name:?}"),
                None,
            ));
        }
        crate::log::debug(&format!("tool {name} called"));
        let arguments = request.arguments;
        let started = Instant::now();
        let tool = name.clone();
        let outcome = self
            .run(move |inner| {
                tools::call(
                    &inner.backend,
                    &inner.exposure,
                    &inner.limits,
                    &tool,
                    arguments,
                )
            })
            .await?;
        let elapsed = started.elapsed().as_millis();
        match outcome {
            Ok(out) => {
                crate::log::info(&format!("tool {name} ok in {elapsed} ms"));
                let text = out
                    .text
                    .unwrap_or_else(|| serde_json::to_string(&out.structured).unwrap_or_default());
                let mut result = CallToolResult::success(vec![ContentBlock::text(text)]);
                result.structured_content = Some(out.structured);
                Ok(result.into())
            }
            Err(fail) => {
                crate::log::info(&format!("tool {name} {} in {elapsed} ms", fail.code));
                fail_result(&fail)
            }
        }
    }

    async fn list_resources(
        &self,
        request: Option<PaginatedRequestParams>,
        _context: RequestContext<RoleServer>,
    ) -> Result<ListResourcesResult, ErrorData> {
        if !self.inner.resources {
            return Ok(ListResourcesResult::default());
        }
        let cursor = request.and_then(|r| r.cursor);
        let first_page = cursor.is_none();
        let page = self
            .run(move |inner| {
                let ns = inner.exposure.default_namespace.clone();
                inner.backend.list(
                    &ns,
                    ListReq {
                        cursor: cursor.clone(),
                        limit: RESOURCE_PAGE.min(inner.limits.max_page),
                        ..ListReq::default()
                    },
                )
            })
            .await?
            .map_err(|f| ErrorData::internal_error(f.message, None))?;
        let ns = self.inner.exposure.default_namespace.clone();
        let mut items: Vec<Value> = Vec::with_capacity(page.memories.len() + 1);
        if first_page {
            items.push(json!({
                "uri": STATS_URI, "name": "stats", "title": "Memory store statistics",
                "description": "Counts, recall mode, encryption status and limits.",
                "mimeType": "application/json"
            }));
        }
        for m in &page.memories {
            let (snippet, _) = preview(&m.text, 160);
            items.push(json!({
                "uri": memory_uri(&ns, &ns, &m.id),
                "name": m.id,
                "title": m.title.clone().unwrap_or_else(|| m.id.clone()),
                "description": snippet,
                "mimeType": "text/plain",
                "size": m.text.len(),
            }));
        }
        let mut result = ListResourcesResult::with_all_items(from_json(Value::Array(items))?);
        result.next_cursor = page.next_cursor;
        Ok(result)
    }

    async fn list_resource_templates(
        &self,
        _request: Option<PaginatedRequestParams>,
        _context: RequestContext<RoleServer>,
    ) -> Result<ListResourceTemplatesResult, ErrorData> {
        if !self.inner.resources {
            return Ok(ListResourceTemplatesResult::default());
        }
        let mut templates = vec![json!({
            "uriTemplate": "hms://memory/{id}", "name": "memory", "title": "Memory by id",
            "description": "One memory's text; the id is percent-encoded.", "mimeType": "text/plain"
        })];
        if self.inner.exposure.namespace_arg {
            templates.push(json!({
                "uriTemplate": "hms://namespace/{namespace}/memory/{id}", "name": "namespaced-memory",
                "title": "Memory by namespace and id", "mimeType": "text/plain"
            }));
        }
        Ok(ListResourceTemplatesResult::with_all_items(from_json(
            Value::Array(templates),
        )?))
    }

    async fn read_resource(
        &self,
        request: ReadResourceRequestParams,
        _context: RequestContext<RoleServer>,
    ) -> Result<ReadResourceResponse, ErrorData> {
        if !self.inner.resources {
            return Err(ErrorData::resource_not_found(
                "resources are disabled",
                None,
            ));
        }
        let uri = request.uri;
        let not_found = |uri: &str| {
            ErrorData::resource_not_found(
                format!("no such resource {uri}"),
                Some(json!({"uri": uri})),
            )
        };
        if uri == STATS_URI {
            let stats = self
                .run(|inner| inner.backend.stats(&inner.exposure.default_namespace))
                .await?
                .map_err(|f| ErrorData::internal_error(f.message, None))?;
            return Ok(from_json::<rmcp::model::ReadResourceResult>(json!({
                "contents": [{"uri": uri, "mimeType": "application/json", "text": stats.to_string()}]
            }))?
            .into());
        }
        let Some((ns, id)) = parse_memory_uri(&uri, &self.inner.exposure) else {
            return Err(not_found(&uri));
        };
        let exposure = self.inner.exposure.clone();
        let lookup = {
            let (ns, id) = (ns.clone(), id.clone());
            self.run(move |inner| {
                let ns = exposure.resolve_namespace(
                    Some(&ns)
                        .filter(|n| **n != exposure.default_namespace)
                        .map(String::as_str),
                )?;
                crate::memory::validate_id(&id)?;
                inner.backend.get(&ns, &id)
            })
            .await?
        };
        match lookup {
            Ok(Some(memory)) => Ok(from_json::<rmcp::model::ReadResourceResult>(json!({
                "contents": [{
                    "uri": uri, "mimeType": "text/plain", "text": memory.text,
                    "_meta": {"id": memory.id, "title": memory.title, "tags": memory.tags,
                              "metadata": memory.metadata, "version": memory.version,
                              "createdAt": memory.created_at, "updatedAt": memory.updated_at}
                }]
            }))?
            .into()),
            Ok(None) => Err(not_found(&uri)),
            Err(f) if f.code == "invalid_argument" || f.code == "forbidden" => {
                Err(ErrorData::invalid_params(f.message, None))
            }
            Err(f) => Err(ErrorData::internal_error(f.message, None)),
        }
    }

    async fn list_prompts(
        &self,
        _request: Option<PaginatedRequestParams>,
        _context: RequestContext<RoleServer>,
    ) -> Result<ListPromptsResult, ErrorData> {
        let enabled = &self.inner.exposure.enabled;
        let mut prompts = Vec::new();
        if self.inner.prompts && enabled.contains("recall") {
            prompts.push(json!({
                "name": "recall-context", "title": "Recall context",
                "description": "Retrieve the memories relevant to a topic and ask the model to use them.",
                "arguments": [
                    {"name": "topic", "description": "What to recall.", "required": true},
                    {"name": "k", "description": "How many memories (default 5).", "required": false}
                ]
            }));
        }
        if self.inner.prompts && enabled.contains("remember") {
            prompts.push(json!({
                "name": "save-memory", "title": "Save a memory",
                "description": "Ask the model to store a fact or decision with the remember tool.",
                "arguments": [
                    {"name": "content", "description": "What to remember.", "required": true},
                    {"name": "tags", "description": "Comma-separated tags.", "required": false}
                ]
            }));
        }
        if self.inner.prompts && enabled.contains("list") {
            prompts.push(json!({
                "name": "review-memories", "title": "Review memories",
                "description": "Show stored memories and ask the model to propose consolidation.",
                "arguments": [{"name": "tag", "description": "Only memories with this tag.", "required": false}]
            }));
        }
        Ok(ListPromptsResult::with_all_items(from_json(Value::Array(
            prompts,
        ))?))
    }

    async fn get_prompt(
        &self,
        request: GetPromptRequestParams,
        _context: RequestContext<RoleServer>,
    ) -> Result<GetPromptResponse, ErrorData> {
        let args: Map<String, Value> = request.arguments.unwrap_or_default();
        let arg = |name: &str| args.get(name).and_then(Value::as_str).map(str::to_string);
        let enabled = &self.inner.exposure.enabled;
        let wrong = |what: &str| ErrorData::invalid_params(what.to_string(), None);
        let text = match request.name.as_str() {
            "recall-context" if self.inner.prompts && enabled.contains("recall") => {
                let topic = arg("topic").ok_or_else(|| wrong("argument `topic` is required"))?;
                let k = match arg("k") {
                    None => 5,
                    Some(k) => k
                        .parse::<usize>()
                        .map_err(|_| wrong("`k` must be an integer"))?,
                };
                let req = SearchReq {
                    query: topic.clone(),
                    k,
                    tags: vec![],
                    filter: Map::new(),
                    min_score: None,
                    lexical_weight: None,
                    semantic_weight: None,
                    fusion: None,
                };
                req.validate(&self.inner.limits)
                    .map_err(|f| wrong(&f.message))?;
                let hits = self
                    .run(move |inner| inner.backend.search(&inner.exposure.default_namespace, req))
                    .await?
                    .map_err(|f| ErrorData::internal_error(f.message, None))?;
                format!(
                    "Relevant memories for \"{topic}\":\n\n{}\n\nUse them where they apply; say so when a memory looks out of date.",
                    recall_text(&hits)
                )
            }
            "save-memory" if self.inner.prompts && enabled.contains("remember") => {
                let content =
                    arg("content").ok_or_else(|| wrong("argument `content` is required"))?;
                let tags = arg("tags")
                    .map(|t| format!(" with tags [{t}]"))
                    .unwrap_or_default();
                format!("Store this durable fact with the `remember` tool{tags}, as one memory:\n\n{content}")
            }
            "review-memories" if self.inner.prompts && enabled.contains("list") => {
                let tag = arg("tag");
                let limit = self.inner.limits.max_page.min(100);
                let tag_for_list = tag.clone();
                let page = self
                    .run(move |inner| {
                        inner.backend.list(
                            &inner.exposure.default_namespace,
                            ListReq {
                                tag: tag_for_list,
                                limit,
                                ..ListReq::default()
                            },
                        )
                    })
                    .await?
                    .map_err(|f| wrong(&f.message))?;
                let body = page
                    .memories
                    .iter()
                    .map(|m| format!("- {} ({}): {}", m.id, m.version, preview(&m.text, 200).0))
                    .collect::<Vec<_>>()
                    .join("\n");
                format!(
                    "These memories are stored{}:\n\n{}\n\nPropose duplicates to merge, outdated entries to delete and gaps to fill. Make no changes until I agree.",
                    tag.map(|t| format!(" under tag \"{t}\"")).unwrap_or_default(),
                    if body.is_empty() { "(none)".into() } else { body }
                )
            }
            other => return Err(wrong(&format!("unknown prompt {other:?}"))),
        };
        Ok(from_json::<rmcp::model::GetPromptResult>(json!({
            "messages": [{"role": "user", "content": {"type": "text", "text": text}}]
        }))?
        .into())
    }
}