feat: support api_key fallback to EXA_API_KEY env-var (crewAIInc#341)

lucasgomide · web-flow · commit 17730332abe7 · 2025-06-24T14:47:39.000-04:00
diff --git a/crewai_tools/tools/exa_tools/exa_search_tool.py b/crewai_tools/tools/exa_tools/exa_search_tool.py
@@ -1,6 +1,7 @@
 from typing import Any, Optional, Type, List
 from pydantic import BaseModel, Field
-from crewai.tools import BaseTool
+from crewai.tools import BaseTool, EnvVar
+import os
 
 try:
     from exa_py import Exa
@@ -36,10 +37,15 @@ class EXASearchTool(BaseTool):
     summary: Optional[bool] = False
     type: Optional[str] = "auto"
     package_dependencies: List[str] = ["exa_py"]
+    api_key: Optional[str] = Field(
+        default_factory=lambda: os.getenv("EXA_API_KEY"), description="API key for Exa services", required=False
+    )
+    env_vars: List[EnvVar] = [
+        EnvVar(name="EXA_API_KEY", description="API key for Exa services", required=False),
+    ]
 
     def __init__(
         self,
-        api_key: str,
         content: Optional[bool] = False,
         summary: Optional[bool] = False,
         type: Optional[str] = "auto",
@@ -62,7 +68,7 @@ def __init__(
                 raise ImportError(
                     "You are missing the 'exa_py' package. Would you like to install it?"
                 )
-        self.client = Exa(api_key=api_key)
+        self.client = Exa(api_key=self.api_key)
         self.content = content
         self.summary = summary
         self.type = type
diff --git a/tests/tools/exa_search_tool_test.py b/tests/tools/exa_search_tool_test.py
@@ -0,0 +1,32 @@
+import os
+from unittest.mock import patch
+from crewai_tools import EXASearchTool
+
+import pytest
+
+@pytest.fixture
+def exa_search_tool():
+    return EXASearchTool(api_key="test_api_key")
+
+
+@pytest.fixture(autouse=True)
+def mock_exa_api_key():
+    with patch.dict(os.environ, {"EXA_API_KEY": "test_key_from_env"}):
+        yield
+
+def test_exa_search_tool_initialization():
+    with patch("crewai_tools.tools.exa_tools.exa_search_tool.Exa") as mock_exa_class:
+        api_key = "test_api_key"
+        tool = EXASearchTool(api_key=api_key)
+
+        assert tool.api_key == api_key
+        assert tool.content is False
+        assert tool.summary is False
+        assert tool.type == "auto"
+        mock_exa_class.assert_called_once_with(api_key=api_key)
+
+
+def test_exa_search_tool_initialization_with_env(mock_exa_api_key):
+    with patch("crewai_tools.tools.exa_tools.exa_search_tool.Exa") as mock_exa_class:
+        EXASearchTool()
+        mock_exa_class.assert_called_once_with(api_key="test_key_from_env")
