vipune 0.4.0

A minimal memory layer for AI agents
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

//! Parameter structs for MCP tools.

use rmcp::schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// Parameters for the store_memory tool.
#[derive(Debug, Deserialize, Serialize, JsonSchema)]
pub struct StoreMemoryParams {
    /// The information to remember. Write as a clear, self-contained fact.
    #[schemars(
        description = "The information to remember. Write as a clear, self-contained fact."
    )]
    pub text: String,

    /// Optional structured labels like {"topic": "auth", "type": "decision"}.
    #[schemars(
        description = "Optional structured labels like {\"topic\": \"auth\", \"type\": \"decision\"}."
    )]
    pub metadata: Option<serde_json::Value>,

    /// Memory type: fact, preference, procedure, guard, observation (default: fact).
    #[serde(default)]
    #[schemars(
        description = "Memory type: fact, preference, procedure, guard, observation (default: fact)."
    )]
    pub memory_type: Option<String>,

    /// Memory status: active, candidate (default: active).
    #[serde(default)]
    #[schemars(description = "Memory status: active, candidate (default: active).")]
    pub status: Option<String>,

    /// ID of memory to supersede (creates new memory, marks old as superseded).
    #[serde(default)]
    #[schemars(
        description = "ID of memory to supersede (creates new memory, marks old as superseded)."
    )]
    pub supersedes: Option<String>,
}

/// Parameters for the supersede_memory tool.
#[derive(Debug, Deserialize, Serialize, JsonSchema)]
pub struct SupersedeMemoryParams {
    /// The new text content that replaces the old memory.
    #[schemars(description = "The new text content that replaces the old memory.")]
    pub new_text: String,

    /// ID of the memory to supersede.
    #[schemars(description = "ID of the memory to supersede.")]
    pub old_memory_id: String,

    /// Memory type for the new memory (default: same as old, or fact).
    #[serde(default)]
    #[schemars(description = "Memory type for the new memory (default: same as old, or fact).")]
    pub memory_type: Option<String>,

    /// Optional metadata for the new memory.
    #[serde(default)]
    #[schemars(description = "Optional metadata for the new memory.")]
    pub metadata: Option<serde_json::Value>,
}

/// Parameters for the search_memories tool.
#[derive(Debug, Deserialize, Serialize, JsonSchema)]
pub struct SearchMemoriesParams {
    /// What to look for in natural language.
    #[schemars(description = "What to look for in natural language.")]
    pub query: String,

    /// Maximum number of results to return.
    #[schemars(description = "Maximum number of results to return (default: 5).")]
    pub limit: Option<usize>,

    /// Filter by memory types.
    #[schemars(description = "Filter by memory types (e.g., fact, preference, procedure).")]
    pub memory_types: Option<Vec<String>>,

    /// Filter by statuses.
    #[schemars(description = "Filter by statuses (e.g., active, candidate).")]
    pub statuses: Option<Vec<String>>,

    /// Recency weight for search results (0.0 = pure semantic, 1.0 = pure recency).
    /// Defaults to config value (typically 0.3).
    #[serde(default)]
    #[schemars(description = "Recency weight (0.0-1.0). Default: config value (0.3).")]
    pub recency_weight: Option<f64>,

    /// Whether to use hybrid search (semantic + BM25). Default: config value.
    #[serde(default)]
    #[schemars(description = "Use hybrid search (semantic + BM25). Default: config value.")]
    pub hybrid: Option<bool>,
}

/// Parameters for the list_memories tool.
#[derive(Debug, Deserialize, Serialize, JsonSchema)]
pub struct ListMemoriesParams {
    /// Maximum number of memories to list.
    #[schemars(description = "Maximum number of memories to list (default: 10).")]
    pub limit: Option<usize>,

    /// Filter by memory types.
    #[schemars(description = "Filter by memory types (e.g., fact, preference, procedure).")]
    pub memory_types: Option<Vec<String>>,

    /// Filter by statuses.
    #[schemars(description = "Filter by statuses (e.g., active, candidate).")]
    pub statuses: Option<Vec<String>>,
}

/// Response when a memory is successfully added.
#[derive(Debug, Serialize)]
pub struct SuccessResponse {
    /// Memory ID
    pub id: String,
    /// Status
    pub status: String,
}

/// A conflicting memory.
#[derive(Debug, Serialize)]
pub struct ConflictMemory {
    /// Memory ID
    pub id: String,
    /// Memory content
    pub content: String,
    /// Similarity score
    pub similarity: f64,
}