Building AI agents, atomically
feat: enhance BaseSystemPromptGenerator
Psharp725d1eb5f433458
diff --git a/atomic-agents/atomic_agents/agents/atomic_agent.py b/atomic-agents/atomic_agents/agents/atomic_agent.pyindex be5866b..8f5566c 100644--- a/atomic-agents/atomic_agents/agents/atomic_agent.py+++ b/atomic-agents/atomic_agents/agents/atomic_agent.py@@ -68,7 +68,10 @@ class AgentConfig(BaseModel):model: str = Field(default="gpt-5-mini", description="The model to use for generating responses.")history: Optional[ChatHistory] = Field(default=None, description="History component for storing chat history.")system_prompt_generator: Optional[BaseSystemPromptGenerator] = Field(- default=None, description="Component for generating system prompts."+ default=None, description=(+ "Component for generating system prompts. "+ "Defaults to SystemPromptGenerator if no subclass of BaseSystemPromptGenerator is passed."+ ))system_role: Optional[str] = Field(default="system", description="The role of the system in the conversation. None means no system prompt."@@ -114,7 +117,7 @@ class AtomicAgent[InputSchema: BaseIOSchema, OutputSchema: BaseIOSchema]:client: Client for interacting with the language model.model (str): The model to use for generating responses.history (ChatHistory): History component for storing chat history.- system_prompt_generator (SystemPromptGenerator): Component for generating system prompts.+ system_prompt_generator (BaseSystemPromptGenerator): Component for generating system prompts.system_role (Optional[str]): The role of the system in the conversation. None means no system prompt.assistant_role (str): The role of the assistant in the conversation. Use 'model' for Gemini, 'assistant' for OpenAI/Anthropic.initial_history (ChatHistory): Initial state of the history.diff --git a/atomic-agents/atomic_agents/context/system_prompt_generator.py b/atomic-agents/atomic_agents/context/system_prompt_generator.pyindex f1471db..571a657 100644--- a/atomic-agents/atomic_agents/context/system_prompt_generator.py+++ b/atomic-agents/atomic_agents/context/system_prompt_generator.py@@ -23,7 +23,9 @@ class BaseSystemPromptGenerator(ABC):passdef __repr__(self) -> str:- return self.generate_prompt()+ return (+ f"{self.__class__.__name__} (providers={list(self.context_providers)})"+ )class SystemPromptGenerator(BaseSystemPromptGenerator):diff --git a/atomic-agents/tests/agents/test_atomic_agent.py b/atomic-agents/tests/agents/test_atomic_agent.pyindex 45881c4..57ddd30 100644--- a/atomic-agents/tests/agents/test_atomic_agent.py+++ b/atomic-agents/tests/agents/test_atomic_agent.py@@ -11,7 +11,12 @@ from atomic_agents import (BasicChatInputSchema,BasicChatOutputSchema,)-from atomic_agents.context import ChatHistory, SystemPromptGenerator, BaseDynamicContextProvider+from atomic_agents.context import (+ ChatHistory,+ SystemPromptGenerator,+ BaseDynamicContextProvider,+ BaseSystemPromptGenerator,+)from atomic_agents.utils.token_counter import TokenCountResultfrom instructor.dsl.partial import PartialBase@@ -105,6 +110,32 @@ def agent_async(agent_config_async):return AtomicAgent[BasicChatInputSchema, BasicChatOutputSchema](agent_config_async)+def mock_custom_system_prompt_generator():+ class MockSystemPromptGenerator(BaseSystemPromptGenerator):+ def __init__(self, context_providers=None, system_prompt=""):+ super().__init__(context_providers=context_providers)+ self.system_prompt = system_prompt++ def generate_prompt(self) -> str:+ return self.system_prompt++ return MockSystemPromptGenerator(system_prompt="Custom Prompt")+++def mock_context_provider():+ class MockContextProvider(BaseDynamicContextProvider):+ def __init__(self, title: str, info: str):+ super().__init__(title)+ self._info = info++ def get_info(self) -> str:+ return self._info++ return MockContextProvider(title="Mock Provider", info="Test")++def test_initialization(agent, mock_instructor, mock_history, mock_system_prompt_generator):assert agent.client == mock_instructorassert agent.model == "gpt-5-mini"@@ -1360,3 +1391,22 @@ def test_trim_context_called_before_user_message_in_run(mock_get_token_counter,# Old turn was trimmed BEFORE new message was addedassert history.get_message_count() == 2 # assistant response + new user messageassert history.history[0].content.chat_message == "New message" # new message is first+++# --- Test BaseSystemPromptGenerator integration ---+++def test_custom_system_prompt_generator_reaches_agent(mock_instructor, mock_custom_system_prompt_generator, mock_context_provider):++ agent = AtomicAgent[BasicChatInputSchema, BasicChatOutputSchema](+ AgentConfig(+ client=mock_instructor,+ model="gpt-5-mini",+ system_prompt_generator=mock_custom_system_prompt_generator,+ ))++ agent.register_context_provider("test_provider", mock_context_provider)++ assert agent.system_prompt_generator == mock_custom_system_prompt_generator+ assert agent._build_system_messages() == [{'content': "Custom Prompt", 'role': 'system'}]+ assert agent.system_prompt_generator.context_providers == {'test_provider': mock_context_provider}diff --git a/atomic-agents/tests/context/test_system_prompt_generator.py b/atomic-agents/tests/context/test_system_prompt_generator.pyindex e2ed31c..bf8b140 100644--- a/atomic-agents/tests/context/test_system_prompt_generator.py+++ b/atomic-agents/tests/context/test_system_prompt_generator.py@@ -1,3 +1,7 @@+from typing import Dict, Optional++import pytest+from atomic_agents.context import (SystemPromptGenerator,BaseDynamicContextProvider,@@ -12,6 +16,19 @@ class MockContextProvider(BaseDynamicContextProvider):def get_info(self) -> str:return self._info+++class MockSystemPromptGenerator(BaseSystemPromptGenerator):+ def __init__(+ self,+ system_prompt: str,+ context_providers: Optional[Dict[str, BaseDynamicContextProvider]]=None+ ):+ super().__init__(context_providers)+ self.system_prompt = system_prompt++ def generate_prompt(self):+ return self.system_promptdef test_system_prompt_generator_default_initialization():@@ -135,9 +152,32 @@ def test_generate_prompt_with_empty_context_provider():def test_base_system_prompt_generator_repr():- class Impl(BaseSystemPromptGenerator):- def generate_prompt(self) -> str:- return "X"+ mock_context_provider = MockContextProvider("Mock Provider", "Test")+ mock_generator = MockSystemPromptGenerator(+ context_providers={'mock_provider': mock_context_provider},+ system_prompt='Test prompt'+ )++ assert repr(mock_generator) == "MockSystemPromptGenerator (providers=['mock_provider'])"+- impl = Impl()- assert repr(impl) == "X"+def test_custom_system_prompt_generator():+ mock_context_provider = MockContextProvider("Mock Provider", "Test")+ mock_generator = MockSystemPromptGenerator(+ context_providers={'mock_provider': mock_context_provider},+ system_prompt='Test prompt'+ )++ assert mock_generator.context_providers == {'mock_provider': mock_context_provider}+ assert mock_generator.system_prompt == 'Test prompt'+++def test_system_prompt_generator_with_no_generate_prompt():+ with pytest.raises(TypeError):+ BaseSystemPromptGenerator()+++def test_base_system_prompt_generator_with_no_context_providers():+ generator = MockSystemPromptGenerator(system_prompt="Test prompt")+ assert generator.context_providers == {}+ assert repr(generator) == "MockSystemPromptGenerator (providers=[])"diff --git a/docs/api/context.md b/docs/api/context.mdindex f635fcb..fa32400 100644--- a/docs/api/context.md+++ b/docs/api/context.md@@ -106,18 +106,19 @@ prompt = generator.generate_prompt()### Custom System Prompt Generator-If you prefer to have more control over the system prompt generator you can create a custom system prompt generator by inheriting from `BaseSystemPromptGenerator`:+If you require finer control over system prompt construction, subclass `BaseSystemPromptGenerator` and implement `generate_prompt()`. This approach is useful when prompt content should be maintained in a human-readable format (e.g., Markdown or text file) to allow review or editing by non-developers.```pythonfrom pathlib import Pathfrom typing import Dict, Optional, Union-from atomic_agents.context import BaseDynamicContextProvider, BaseSystemPromptGenerator+from atomic_agents.context import (+ BaseDynamicContextProvider,+ BaseSystemPromptGenerator+)-# Define custom generator classclass MarkdownFileSystemPromptGenerator(BaseSystemPromptGenerator):-def __init__(self,md_file: Union[Path, str],@@ -132,23 +133,22 @@ class MarkdownFileSystemPromptGenerator(BaseSystemPromptGenerator):self.system_prompt = path.read_text(encoding="utf-8")def generate_prompt(self) -> str:- prompt_parts = [self.system_prompt]+ return f"{self.system_prompt}\n\n{self._build_context_string()}"- if self.context_providers:- prompt_parts.append("# EXTRA INFORMATION AND CONTEXT")- for provider in self.context_providers.values():- info = provider.get_info()- if info:- prompt_parts.append(f"## {provider.title}")- prompt_parts.append(info)- prompt_parts.append("")+ def _build_context_string(self) -> str:+ if not self.context_providers:+ return ""- return "\n".join(prompt_parts).strip()+ context_sections = ["# Additional Context"]+ for provider in self.context_providers.values():+ info = provider.get_info()+ if info:+ context_sections.append(f"## {provider.title}")+ context_sections.append(info)+ context_sections.append("")+ return "\n".join(context_sections).strip()-# Create generatorgenerator = MarkdownFileSystemPromptGenerator("path/to/system_prompt.md")--# Generate promptprompt = generator.generate_prompt()```