Skip to content

SWE-agent takes a GitHub issue and tries to automatically fix it, using your LM of choice. It can also be employed for offensive cybersecurity or competitive coding challenges. [NeurIPS 2024]

feat: add User-Agent header for LLM API calls (#1346)

Mike Lamberted7dd55cbcbf
diff --git a/sweagent/agent/models.py b/sweagent/agent/models.py
index 8b2fd183..496b2265 100644
--- a/sweagent/agent/models.py
+++ b/sweagent/agent/models.py
@@ -25,7 +25,7 @@ from tenacity import (
wait_random_exponential,
)
-from sweagent import REPO_ROOT
+from sweagent import REPO_ROOT, __version__
from sweagent.exceptions import (
ContentPolicyViolationError,
ContextWindowExceededError,
@@ -708,9 +708,16 @@ class LiteLLMModel(AbstractModel):
if self.tools.use_function_calling:
extra_args["tools"] = self.tools.tools
# We need to always set max_tokens for anthropic models
- completion_kwargs = self.config.completion_kwargs
+ completion_kwargs = copy.deepcopy(self.config.completion_kwargs)
if self.lm_provider == "anthropic":
completion_kwargs["max_tokens"] = self.model_max_output_tokens
+
+ # Add User-Agent header (don't override user-provided headers)
+ if "extra_headers" not in completion_kwargs:
+ completion_kwargs["extra_headers"] = {}
+ if "User-Agent" not in completion_kwargs["extra_headers"]:
+ completion_kwargs["extra_headers"]["User-Agent"] = f"swe-agent/{__version__}"
+
try:
response: litellm.types.utils.ModelResponse = litellm.completion( # type: ignore
model=self.config.name,
diff --git a/tests/test_models.py b/tests/test_models.py
index 084be9f2..0753f9e4 100644
--- a/tests/test_models.py
+++ b/tests/test_models.py
@@ -1,7 +1,10 @@
from __future__ import annotations
+from unittest.mock import MagicMock, patch
+
from pydantic import SecretStr
+from sweagent import __version__
from sweagent.agent.models import GenericAPIModelConfig, get_model
from sweagent.tools.parsing import Identity
from sweagent.tools.tools import ToolConfig
@@ -21,3 +24,83 @@ def test_litellm_mock():
),
)
assert model.query(History([{"role": "user", "content": "Hello, world!"}])) == {"message": "Hello, world!"} # type: ignore
+
+
+def _make_mock_response(content: str = "mock") -> MagicMock:
+ """Create a minimal mock response matching litellm's ModelResponse shape."""
+ choice = MagicMock()
+ choice.message.content = content
+ choice.message.tool_calls = None
+ response = MagicMock()
+ response.choices = [choice]
+ response.usage.prompt_tokens = 10
+ response.usage.completion_tokens = 5
+ return response
+
+
+def test_user_agent_header_default():
+ """User-Agent header is added automatically when no extra_headers are set."""
+ model = get_model(
+ GenericAPIModelConfig(
+ name="gpt-4o",
+ api_key=SecretStr("dummy_key"),
+ top_p=None,
+ per_instance_cost_limit=0,
+ total_cost_limit=0,
+ ),
+ ToolConfig(parse_function=Identity()),
+ )
+ mock_response = _make_mock_response()
+ with patch("litellm.completion", return_value=mock_response) as mock_completion:
+ model.query(History([{"role": "user", "content": "test"}]))
+ mock_completion.assert_called_once()
+ call_kwargs = mock_completion.call_args
+ extra_headers = call_kwargs.kwargs.get("extra_headers", {})
+ assert "User-Agent" in extra_headers
+ assert extra_headers["User-Agent"] == f"swe-agent/{__version__}"
+
+
+def test_user_agent_header_preserves_existing():
+ """User-Agent header is not overridden when already provided by the user."""
+ custom_ua = "my-custom-agent/1.0"
+ model = get_model(
+ GenericAPIModelConfig(
+ name="gpt-4o",
+ completion_kwargs={"extra_headers": {"User-Agent": custom_ua}},
+ api_key=SecretStr("dummy_key"),
+ top_p=None,
+ per_instance_cost_limit=0,
+ total_cost_limit=0,
+ ),
+ ToolConfig(parse_function=Identity()),
+ )
+ mock_response = _make_mock_response()
+ with patch("litellm.completion", return_value=mock_response) as mock_completion:
+ model.query(History([{"role": "user", "content": "test"}]))
+ mock_completion.assert_called_once()
+ call_kwargs = mock_completion.call_args
+ extra_headers = call_kwargs.kwargs.get("extra_headers", {})
+ assert extra_headers["User-Agent"] == custom_ua
+
+
+def test_user_agent_header_with_other_extra_headers():
+ """User-Agent header is added alongside other existing extra_headers."""
+ model = get_model(
+ GenericAPIModelConfig(
+ name="gpt-4o",
+ completion_kwargs={"extra_headers": {"X-Custom": "value"}},
+ api_key=SecretStr("dummy_key"),
+ top_p=None,
+ per_instance_cost_limit=0,
+ total_cost_limit=0,
+ ),
+ ToolConfig(parse_function=Identity()),
+ )
+ mock_response = _make_mock_response()
+ with patch("litellm.completion", return_value=mock_response) as mock_completion:
+ model.query(History([{"role": "user", "content": "test"}]))
+ mock_completion.assert_called_once()
+ call_kwargs = mock_completion.call_args
+ extra_headers = call_kwargs.kwargs.get("extra_headers", {})
+ assert extra_headers["User-Agent"] == f"swe-agent/{__version__}"
+ assert extra_headers["X-Custom"] == "value"