allow appending content to system prompt

Author: aantn

holmes/core/prompt.py

@@ -7,7 +7,7 @@
 
 def append_file_to_user_prompt(user_prompt: str, file_path: Path) -> str:
     with file_path.open("r") as f:
-        user_prompt += f"\n\n<attached-file path='{file_path.absolute()}>'\n{f.read()}\n</attached-file>"
+        user_prompt += f"\n\n<attached-file path='{file_path.absolute()}'>\n{f.read()}\n</attached-file>"
 
     return user_prompt
 
@@ -31,6 +31,7 @@ def build_initial_ask_messages(
     file_paths: Optional[List[Path]],
     tool_executor: Any,  # ToolExecutor type
     runbooks: Union[RunbookCatalog, Dict, None] = None,
+    system_prompt_additions: Optional[str] = None,
 ) -> List[Dict]:
     """Build the initial messages for the AI call.
 
@@ -40,12 +41,14 @@ def build_initial_ask_messages(
         file_paths: Optional list of files to include
         tool_executor: The tool executor with available toolsets
         runbooks: Optional runbook catalog
+        system_prompt_additions: Optional additional system prompt content
     """
     # Load and render system prompt internally
     system_prompt_template = "builtin://generic_ask.jinja2"
     template_context = {
         "toolsets": tool_executor.toolsets,
         "runbooks": runbooks or {},
+        "system_prompt_additions": system_prompt_additions or "",
     }
     system_prompt_rendered = load_and_render_prompt(
         system_prompt_template, template_context

holmes/interactive.py

@@ -762,6 +762,7 @@ def run_interactive_loop(
     show_tool_output: bool,
     tracer=None,
     runbooks=None,
+    system_prompt_additions: Optional[str] = None,
 ) -> None:
     # Initialize tracer - use DummyTracer if no tracer provided
     if tracer is None:
@@ -960,7 +961,12 @@ def get_bottom_toolbar():
 
             if messages is None:
                 messages = build_initial_ask_messages(
-                    console, user_input, include_files, ai.tool_executor, runbooks
+                    console,
+                    user_input,
+                    include_files,
+                    ai.tool_executor,
+                    runbooks,
+                    system_prompt_additions,
                 )
             else:
                 messages.append({"role": "user", "content": user_input})

holmes/main.py

@@ -210,6 +210,11 @@ def ask(
         "--trace",
         help="Enable tracing to the specified provider (e.g., 'braintrust')",
     ),
+    system_prompt_additions: Optional[str] = typer.Option(
+        None,
+        "--system-prompt-additions",
+        help="Additional content to append to the system prompt",
+    ),
 ):
     """
     Ask any question and answer using available tools
@@ -291,6 +296,7 @@ def ask(
             show_tool_output,
             tracer,
             config.get_runbook_catalog(),
+            system_prompt_additions,
         )
         return
 
@@ -300,6 +306,7 @@ def ask(
         include_file,
         ai.tool_executor,
         config.get_runbook_catalog(),
+        system_prompt_additions,
     )
 
     with tracer.start_trace(

holmes/plugins/prompts/generic_ask.jinja2

@@ -34,3 +34,7 @@ Relevant logs:
 ```
 
 Validation error led to unhandled Java exception causing a crash.
+
+{% if system_prompt_additions %}
+{{ system_prompt_additions }}
+{% endif %}

tests/core/test_prompt.py

@@ -0,0 +1,185 @@
+import pytest
+from unittest.mock import Mock
+from rich.console import Console
+
+from holmes.core.prompt import (
+    build_initial_ask_messages,
+    append_file_to_user_prompt,
+    append_all_files_to_user_prompt,
+)
+
+
+@pytest.fixture
+def console():
+    return Console(force_terminal=False, force_jupyter=False)
+
+
+@pytest.fixture
+def mock_tool_executor():
+    tool_executor = Mock()
+    tool_executor.toolsets = []
+    return tool_executor
+
+
+def test_build_initial_ask_messages_basic(console, mock_tool_executor):
+    """Test basic message building without any optional parameters."""
+    messages = build_initial_ask_messages(
+        console,
+        "Test prompt",
+        None,
+        mock_tool_executor,
+        None,
+        None,
+    )
+
+    assert len(messages) == 2
+    assert messages[0]["role"] == "system"
+    assert messages[1]["role"] == "user"
+    assert messages[1]["content"] == "Test prompt"
+
+
+def test_build_initial_ask_messages_with_system_prompt_additions(
+    console, mock_tool_executor
+):
+    """Test message building with system prompt additions."""
+    system_additions = "Additional system instructions here."
+    messages = build_initial_ask_messages(
+        console,
+        "Test prompt",
+        None,
+        mock_tool_executor,
+        None,
+        system_additions,
+    )
+
+    assert len(messages) == 2
+    assert messages[0]["role"] == "system"
+    # Check for unique word from the system additions
+    assert "Additional" in messages[0]["content"]
+    assert messages[1]["role"] == "user"
+    assert messages[1]["content"] == "Test prompt"
+
+
+def test_build_initial_ask_messages_with_file(console, mock_tool_executor, tmp_path):
+    """Test message building with file attachment."""
+    # Create a temporary file
+    test_file = tmp_path / "test.txt"
+    test_file.write_text("File content here")
+
+    messages = build_initial_ask_messages(
+        console,
+        "Test prompt",
+        [test_file],
+        mock_tool_executor,
+        None,
+        None,
+    )
+
+    assert len(messages) == 2
+    assert messages[0]["role"] == "system"
+    assert messages[1]["role"] == "user"
+    assert "Test prompt" in messages[1]["content"]
+    assert "File content here" in messages[1]["content"]
+    # Check for file attachment markers
+    assert "<attached-file" in messages[1]["content"]
+    assert "test.txt" in messages[1]["content"]
+    assert "</attached-file>" in messages[1]["content"]
+
+
+def test_build_initial_ask_messages_with_runbooks(console, mock_tool_executor):
+    """Test message building with runbooks."""
+    runbooks = {"test_runbook": {"description": "Test runbook"}}
+
+    messages = build_initial_ask_messages(
+        console,
+        "Test prompt",
+        None,
+        mock_tool_executor,
+        runbooks,
+        None,
+    )
+
+    assert len(messages) == 2
+    assert messages[0]["role"] == "system"
+    # The runbook should be passed to the template context
+    assert messages[1]["role"] == "user"
+    assert messages[1]["content"] == "Test prompt"
+
+
+def test_build_initial_ask_messages_all_parameters(
+    console, mock_tool_executor, tmp_path
+):
+    """Test message building with all parameters."""
+    # Create a temporary file
+    test_file = tmp_path / "test.txt"
+    test_file.write_text("File content")
+
+    runbooks = {"test_runbook": {"description": "Test runbook"}}
+    system_additions = "Extra system instructions"
+
+    messages = build_initial_ask_messages(
+        console,
+        "Test prompt",
+        [test_file],
+        mock_tool_executor,
+        runbooks,
+        system_additions,
+    )
+
+    assert len(messages) == 2
+    assert messages[0]["role"] == "system"
+    # Check for unique word from system additions
+    assert "Extra" in messages[0]["content"]
+    assert messages[1]["role"] == "user"
+    assert "Test prompt" in messages[1]["content"]
+    assert "File content" in messages[1]["content"]
+
+
+def test_append_file_to_user_prompt(tmp_path):
+    """Test appending a single file to user prompt."""
+    test_file = tmp_path / "test.txt"
+    test_file.write_text("Test file content")
+
+    prompt = "Original prompt"
+    result = append_file_to_user_prompt(prompt, test_file)
+
+    assert "Original prompt" in result
+    assert "Test file content" in result
+    # Check for file attachment markers
+    assert "<attached-file" in result
+    assert "test.txt" in result
+    assert "</attached-file>" in result
+
+
+def test_append_all_files_to_user_prompt(console, tmp_path):
+    """Test appending multiple files to user prompt."""
+    # Create multiple test files
+    file1 = tmp_path / "file1.txt"
+    file1.write_text("Content 1")
+
+    file2 = tmp_path / "file2.txt"
+    file2.write_text("Content 2")
+
+    prompt = "Original prompt"
+    result = append_all_files_to_user_prompt(console, prompt, [file1, file2])
+
+    assert "Original prompt" in result
+    assert "Content 1" in result
+    assert "Content 2" in result
+    # Check for file attachment markers
+    assert "<attached-file" in result
+    assert "file1.txt" in result
+    assert "file2.txt" in result
+    assert result.count("</attached-file>") == 2
+
+
+def test_append_all_files_to_user_prompt_no_files(console):
+    """Test appending files when no files are provided."""
+    prompt = "Original prompt"
+    result = append_all_files_to_user_prompt(console, prompt, None)
+
+    assert result == "Original prompt"
+
+    # Also test with empty list
+    result = append_all_files_to_user_prompt(console, prompt, [])
+    assert result == "Original prompt"