Files
g3/crates/g3-core/src/tools/memory.rs
Dhanji R. Prasanna e731bc8217 Make remember tool instructions more imperative in system prompts
- Change 'call remember' to 'you MUST call remember' in native prompt
- Change 'IF you discovered' to 'ALWAYS...when you discovered'
- Add explicit list of trigger tools (code_search, rg, grep, find, read_file)
- Add reminder to Response Guidelines section
- Add remember tool and Project Memory section to non-native prompt
- Remove redundant console output from remember tool
- Fix test compilation errors (missing summary parameter, temporary borrow)
2026-01-11 06:49:45 +08:00

176 lines
5.5 KiB
Rust

//! Project memory tool: remember.
//!
//! These tools provide a persistent "working memory" for the project,
//! storing feature locations, patterns, and entry points discovered
//! during g3 sessions.
use anyhow::Result;
use chrono::Utc;
use std::path::PathBuf;
use crate::ui_writer::UiWriter;
use crate::ToolCall;
use super::executor::ToolContext;
/// Get the path to the memory file.
/// Memory is stored at `.g3/memory.md` in the working directory.
fn get_memory_path(working_dir: Option<&str>) -> PathBuf {
let base = working_dir
.map(PathBuf::from)
.unwrap_or_else(|| std::env::current_dir().unwrap_or_else(|_| PathBuf::from(".")));
base.join(".g3").join("memory.md")
}
/// Format the file size in a human-readable way.
fn format_size(chars: usize) -> String {
if chars < 1000 {
format!("{} chars", chars)
} else {
format!("{:.1}k chars", chars as f64 / 1000.0)
}
}
/// Execute the remember tool.
/// Merges new notes with existing memory and saves to file.
pub async fn execute_remember<W: UiWriter>(
tool_call: &ToolCall,
ctx: &mut ToolContext<'_, W>,
) -> Result<String> {
let notes = tool_call
.args
.get("notes")
.and_then(|v| v.as_str())
.ok_or_else(|| anyhow::anyhow!("Missing required 'notes' parameter"))?;
let memory_path = get_memory_path(ctx.working_dir);
// Ensure .g3 directory exists
if let Some(parent) = memory_path.parent() {
std::fs::create_dir_all(parent)?;
}
// Read existing memory or create new
let existing = if memory_path.exists() {
std::fs::read_to_string(&memory_path)?
} else {
String::new()
};
// Merge notes with existing memory
let updated = merge_memory(&existing, notes);
// Add/update header with timestamp and size
let timestamp = Utc::now().format("%Y-%m-%dT%H:%M:%SZ").to_string();
let size = format_size(updated.len());
let final_content = update_header(&updated, &timestamp, &size);
// Write back
std::fs::write(&memory_path, &final_content)?;
Ok(format!("Memory updated. Size: {}", format_size(final_content.len())))
}
/// Merge new notes into existing memory.
/// Appends new notes to the appropriate sections or creates new sections.
fn merge_memory(existing: &str, new_notes: &str) -> String {
if existing.is_empty() {
// Start fresh with just the notes
return new_notes.trim().to_string();
}
// Simple merge strategy: append new notes to the end
// The LLM is responsible for providing well-formatted notes
// and avoiding duplicates (as instructed in the prompt)
let existing_trimmed = existing.trim();
let new_trimmed = new_notes.trim();
// Remove the header line if present (we'll re-add it)
let existing_body = remove_header(existing_trimmed);
format!("{}\n\n{}", existing_body.trim(), new_trimmed)
}
/// Remove the header line (# Project Memory and > Updated: ...) from content.
fn remove_header(content: &str) -> String {
let mut lines: Vec<&str> = content.lines().collect();
// Remove "# Project Memory" if first line
if !lines.is_empty() && lines[0].starts_with("# Project Memory") {
lines.remove(0);
}
// Remove "> Updated: ..." line if present at start
if !lines.is_empty() && lines[0].starts_with("> Updated:") {
lines.remove(0);
}
// Remove leading empty lines
while !lines.is_empty() && lines[0].trim().is_empty() {
lines.remove(0);
}
lines.join("\n")
}
/// Update or add the header with timestamp and size.
fn update_header(content: &str, timestamp: &str, size: &str) -> String {
let body = remove_header(content);
format!(
"# Project Memory\n> Updated: {} | Size: {}\n\n{}",
timestamp,
size,
body.trim()
)
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_format_size() {
assert_eq!(format_size(500), "500 chars");
assert_eq!(format_size(999), "999 chars");
assert_eq!(format_size(1000), "1.0k chars");
assert_eq!(format_size(2500), "2.5k chars");
assert_eq!(format_size(10000), "10.0k chars");
}
#[test]
fn test_merge_memory_empty() {
let result = merge_memory("", "### New Feature\n- `file.rs` [0..100] - `func()`");
assert_eq!(result, "### New Feature\n- `file.rs` [0..100] - `func()`");
}
#[test]
fn test_merge_memory_append() {
let existing = "# Project Memory\n> Updated: 2025-01-10 | Size: 1k\n\n### Feature A\n- `a.rs` [0..50]";
let new_notes = "### Feature B\n- `b.rs` [0..100]";
let result = merge_memory(existing, new_notes);
assert!(result.contains("### Feature A"));
assert!(result.contains("### Feature B"));
assert!(!result.contains("# Project Memory")); // Header removed for re-adding
}
#[test]
fn test_remove_header() {
let content = "# Project Memory\n> Updated: 2025-01-10 | Size: 1k\n\n### Feature\n- details";
let result = remove_header(content);
assert!(!result.contains("# Project Memory"));
assert!(!result.contains("> Updated:"));
assert!(result.contains("### Feature"));
}
#[test]
fn test_update_header() {
let content = "### Feature\n- details";
let result = update_header(content, "2025-01-10T12:00:00Z", "500 chars");
assert!(result.starts_with("# Project Memory"));
assert!(result.contains("> Updated: 2025-01-10T12:00:00Z | Size: 500 chars"));
assert!(result.contains("### Feature"));
}
}