Files
tkmind_go/crates/goose/src/agents/prompt_manager.rs
T

258 lines
8.7 KiB
Rust

use chrono::Utc;
use serde_json::Value;
use std::collections::HashMap;
use crate::agents::extension::ExtensionInfo;
use crate::agents::recipe_tools::dynamic_task_tools::should_enabled_subagents;
use crate::agents::router_tools::llm_search_tool_prompt;
use crate::{config::Config, prompt_template, utils::sanitize_unicode_tags};
pub struct PromptManager {
system_prompt_override: Option<String>,
system_prompt_extras: Vec<String>,
current_date_timestamp: String,
}
impl Default for PromptManager {
fn default() -> Self {
PromptManager::new()
}
}
impl PromptManager {
pub fn new() -> Self {
PromptManager {
system_prompt_override: None,
system_prompt_extras: Vec::new(),
// Use the fixed current date time so that prompt cache can be used.
// Filtering to an hour to balance user time accuracy and multi session prompt cache hits.
current_date_timestamp: Utc::now().format("%Y-%m-%d %H:00").to_string(),
}
}
/// Add an additional instruction to the system prompt
pub fn add_system_prompt_extra(&mut self, instruction: String) {
self.system_prompt_extras.push(instruction);
}
/// Override the system prompt with custom text
pub fn set_system_prompt_override(&mut self, template: String) {
self.system_prompt_override = Some(template);
}
pub fn build_system_prompt(
&self,
extensions_info: Vec<ExtensionInfo>,
frontend_instructions: Option<String>,
suggest_disable_extensions_prompt: Value,
model_name: &str,
router_enabled: bool,
) -> String {
let mut context: HashMap<&str, Value> = HashMap::new();
let mut extensions_info = extensions_info.clone();
// Add frontend instructions to extensions_info to simplify json rendering
if let Some(frontend_instructions) = frontend_instructions {
extensions_info.push(ExtensionInfo::new(
"frontend",
&frontend_instructions,
false,
));
}
// Stable tool ordering is important for multi session prompt caching.
extensions_info.sort_by(|a, b| a.name.cmp(&b.name));
let sanitized_extensions_info: Vec<ExtensionInfo> = extensions_info
.into_iter()
.map(|mut ext_info| {
ext_info.instructions = sanitize_unicode_tags(&ext_info.instructions);
ext_info
})
.collect();
context.insert(
"extensions",
serde_json::to_value(sanitized_extensions_info).unwrap(),
);
if router_enabled {
context.insert(
"tool_selection_strategy",
Value::String(llm_search_tool_prompt()),
);
}
context.insert(
"current_date_time",
Value::String(self.current_date_timestamp.clone()),
);
// Add the suggestion about disabling extensions if flag is true
context.insert(
"suggest_disable",
Value::String(suggest_disable_extensions_prompt.to_string()),
);
let config = Config::global();
let goose_mode = config.get_param("GOOSE_MODE").unwrap_or("auto".to_string());
context.insert("goose_mode", Value::String(goose_mode.clone()));
context.insert(
"enable_subagents",
Value::Bool(should_enabled_subagents(model_name)),
);
let base_prompt = if let Some(override_prompt) = &self.system_prompt_override {
let sanitized_override_prompt = sanitize_unicode_tags(override_prompt);
prompt_template::render_inline_once(&sanitized_override_prompt, &context)
} else {
prompt_template::render_global_file("system.md", &context)
}
.unwrap_or_else(|_| {
"You are a general-purpose AI agent called goose, created by Block".to_string()
});
let mut system_prompt_extras = self.system_prompt_extras.clone();
if goose_mode == "chat" {
system_prompt_extras.push(
"Right now you are in the chat only mode, no access to any tool use and system."
.to_string(),
);
}
let sanitized_system_prompt_extras: Vec<String> = system_prompt_extras
.into_iter()
.map(|extra| sanitize_unicode_tags(&extra))
.collect();
if sanitized_system_prompt_extras.is_empty() {
base_prompt
} else {
format!(
"{}\n\n# Additional Instructions:\n\n{}",
base_prompt,
sanitized_system_prompt_extras.join("\n\n")
)
}
}
pub async fn get_recipe_prompt(&self) -> String {
let context: HashMap<&str, Value> = HashMap::new();
prompt_template::render_global_file("recipe.md", &context)
.unwrap_or_else(|_| "The recipe prompt is busted. Tell the user.".to_string())
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_build_system_prompt_sanitizes_override() {
let mut manager = PromptManager::new();
let malicious_override = "System prompt\u{E0041}\u{E0042}\u{E0043}with hidden text";
manager.set_system_prompt_override(malicious_override.to_string());
let result = manager.build_system_prompt(
vec![],
None,
Value::String("".to_string()),
"gpt-4o",
false,
);
assert!(!result.contains('\u{E0041}'));
assert!(!result.contains('\u{E0042}'));
assert!(!result.contains('\u{E0043}'));
assert!(result.contains("System prompt"));
assert!(result.contains("with hidden text"));
}
#[test]
fn test_build_system_prompt_sanitizes_extras() {
let mut manager = PromptManager::new();
let malicious_extra = "Extra instruction\u{E0041}\u{E0042}\u{E0043}hidden";
manager.add_system_prompt_extra(malicious_extra.to_string());
let result = manager.build_system_prompt(
vec![],
None,
Value::String("".to_string()),
"gpt-4o",
false,
);
assert!(!result.contains('\u{E0041}'));
assert!(!result.contains('\u{E0042}'));
assert!(!result.contains('\u{E0043}'));
assert!(result.contains("Extra instruction"));
assert!(result.contains("hidden"));
}
#[test]
fn test_build_system_prompt_sanitizes_multiple_extras() {
let mut manager = PromptManager::new();
manager.add_system_prompt_extra("First\u{E0041}instruction".to_string());
manager.add_system_prompt_extra("Second\u{E0042}instruction".to_string());
manager.add_system_prompt_extra("Third\u{E0043}instruction".to_string());
let result = manager.build_system_prompt(
vec![],
None,
Value::String("".to_string()),
"gpt-4o",
false,
);
assert!(!result.contains('\u{E0041}'));
assert!(!result.contains('\u{E0042}'));
assert!(!result.contains('\u{E0043}'));
assert!(result.contains("Firstinstruction"));
assert!(result.contains("Secondinstruction"));
assert!(result.contains("Thirdinstruction"));
}
#[test]
fn test_build_system_prompt_preserves_legitimate_unicode_in_extras() {
let mut manager = PromptManager::new();
let legitimate_unicode = "Instruction with 世界 and 🌍 emojis";
manager.add_system_prompt_extra(legitimate_unicode.to_string());
let result = manager.build_system_prompt(
vec![],
None,
Value::String("".to_string()),
"gpt-4o",
false,
);
assert!(result.contains("世界"));
assert!(result.contains("🌍"));
assert!(result.contains("Instruction with"));
assert!(result.contains("emojis"));
}
#[test]
fn test_build_system_prompt_sanitizes_extension_instructions() {
let manager = PromptManager::new();
let malicious_extension_info = ExtensionInfo::new(
"test_extension",
"Extension help\u{E0041}\u{E0042}\u{E0043}hidden instructions",
false,
);
let result = manager.build_system_prompt(
vec![malicious_extension_info],
None,
Value::String("".to_string()),
"gpt-4o",
false,
);
assert!(!result.contains('\u{E0041}'));
assert!(!result.contains('\u{E0042}'));
assert!(!result.contains('\u{E0043}'));
assert!(result.contains("Extension help"));
assert!(result.contains("hidden instructions"));
}
}