refactor: rename to customParameters matching API/dashboard naming

Co-Authored-By: traci@launchdarkly.com <traci@launchdarkly.com>

Author: devin-ai-integration[bot]

packages/sdk/server-ai/src/ldai/client.py

@@ -841,7 +841,7 @@ def __evaluate(
             tools = [
                 ToolDefinition(
                     name=t.get('name', ''),
-                    parameters=t.get('parameters', None)
+                    custom_parameters=t.get('customParameters', None)
                 )
                 for t in tool_defs_raw
                 if isinstance(t, dict) and t.get('name')

packages/sdk/server-ai/src/ldai/models.py

@@ -81,18 +81,23 @@ class ToolDefinition:
     """
     Definition of a tool available to an AI configuration.
 
-    Each tool has a name used to match against the tool registry, and
-    optional custom parameters that can be configured via the LaunchDarkly
-    dashboard.
+    Each tool has a name used to match against the tool registry,
+    and optional custom parameters that can be configured via the
+    LaunchDarkly dashboard.
     """
 
-    def __init__(self, name: str, parameters: Optional[Dict[str, Any]] = None):
+    def __init__(
+        self,
+        name: str,
+        custom_parameters: Optional[Dict[str, Any]] = None,
+    ):
         """
         :param name: The name of the tool.
-        :param parameters: Optional custom parameters for the tool.
+        :param custom_parameters: Optional custom parameters for
+            the tool, configured via the LaunchDarkly dashboard.
         """
         self._name = name
-        self._parameters = parameters
+        self._custom_parameters = custom_parameters
 
     @property
     def name(self) -> str:
@@ -101,25 +106,25 @@ def name(self) -> str:
         """
         return self._name
 
-    def get_parameter(self, key: str) -> Any:
+    def get_custom_parameter(self, key: str) -> Any:
         """
         Retrieve a custom parameter by key.
 
-        :param key: The parameter key to look up.
+        :param key: The custom parameter key to look up.
         :return: The parameter value, or None if not found.
         """
-        if self._parameters is None:
+        if self._custom_parameters is None:
             return None
 
-        return self._parameters.get(key)
+        return self._custom_parameters.get(key)
 
     def to_dict(self) -> dict:
         """
         Render the tool definition as a dictionary object.
         """
         result: Dict[str, Any] = {'name': self._name}
-        if self._parameters is not None:
-            result['parameters'] = self._parameters
+        if self._custom_parameters is not None:
+            result['customParameters'] = self._custom_parameters
         return result
 
 

packages/sdk/server-ai/tests/test_agents.py

@@ -113,8 +113,8 @@ def td() -> TestData:
                     'parameters': {
                         'temperature': 0.3,
                         'tools': [
-                            {'name': 'get-order', 'parameters': {'includeHistory': True, 'maxItems': 5}},
-                            {'name': 'search-products', 'parameters': {'category': 'electronics'}},
+                            {'name': 'get-order', 'customParameters': {'includeHistory': True, 'maxItems': 5}},
+                            {'name': 'search-products', 'customParameters': {'category': 'electronics'}},
                             {'name': 'send-email'},
                         ],
                     },
@@ -401,22 +401,22 @@ def test_agent_config_has_tools(ldai_client: LDAIClient):
 
     get_order = agent.tools[0]
     assert get_order.name == 'get-order'
-    assert get_order.get_parameter('includeHistory') is True
-    assert get_order.get_parameter('maxItems') == 5
+    assert get_order.get_custom_parameter('includeHistory') is True
+    assert get_order.get_custom_parameter('maxItems') == 5
 
     search = agent.tools[1]
     assert search.name == 'search-products'
-    assert search.get_parameter('category') == 'electronics'
+    assert search.get_custom_parameter('category') == 'electronics'
 
     send_email = agent.tools[2]
     assert send_email.name == 'send-email'
-    assert send_email.get_parameter('anything') is None
+    assert send_email.get_custom_parameter('anything') is None
 
 
 def test_agent_config_tools_fallback_to_default(ldai_client: LDAIClient):
     """Test that agent config falls back to default tools when flag has no tools."""
     context = Context.create('user-key')
-    default_tools = [ToolDefinition('default-tool', parameters={'timeout': 30})]
+    default_tools = [ToolDefinition('default-tool', custom_parameters={'timeout': 30})]
     default = LDAIAgentDefaults(
         enabled=False,
         model=ModelConfig('fallback-model'),
@@ -431,7 +431,7 @@ def test_agent_config_tools_fallback_to_default(ldai_client: LDAIClient):
     assert agent.tools is not None
     assert len(agent.tools) == 1
     assert agent.tools[0].name == 'default-tool'
-    assert agent.tools[0].get_parameter('timeout') == 30
+    assert agent.tools[0].get_custom_parameter('timeout') == 30
 
 
 def test_agent_config_no_tools(ldai_client: LDAIClient):

packages/sdk/server-ai/tests/test_model_config.py

@@ -111,8 +111,8 @@ def td() -> TestData:
                     'parameters': {
                         'temperature': 0.7,
                         'tools': [
-                            {'name': 'web_search', 'parameters': {'maxResults': 10, 'region': 'us'}},
-                            {'name': 'get_weather', 'parameters': {'units': 'celsius'}},
+                            {'name': 'web_search', 'customParameters': {'maxResults': 10, 'region': 'us'}},
+                            {'name': 'get_weather', 'customParameters': {'units': 'celsius'}},
                             {'name': 'calculator'},
                         ],
                     },
@@ -449,24 +449,24 @@ def test_completion_config_without_default_uses_disabled(ldai_client: LDAIClient
 def test_tool_definition_basic():
     tool = ToolDefinition('web_search')
     assert tool.name == 'web_search'
-    assert tool.get_parameter('anything') is None
+    assert tool.get_custom_parameter('anything') is None
 
 
-def test_tool_definition_with_parameters():
-    tool = ToolDefinition('web_search', parameters={'maxResults': 10, 'region': 'us'})
+def test_tool_definition_with_custom_parameters():
+    tool = ToolDefinition('web_search', custom_parameters={'maxResults': 10, 'region': 'us'})
     assert tool.name == 'web_search'
-    assert tool.get_parameter('maxResults') == 10
-    assert tool.get_parameter('region') == 'us'
-    assert tool.get_parameter('nonexistent') is None
+    assert tool.get_custom_parameter('maxResults') == 10
+    assert tool.get_custom_parameter('region') == 'us'
+    assert tool.get_custom_parameter('nonexistent') is None
 
 
 def test_tool_definition_to_dict():
-    tool = ToolDefinition('web_search', parameters={'maxResults': 10})
+    tool = ToolDefinition('web_search', custom_parameters={'maxResults': 10})
     d = tool.to_dict()
-    assert d == {'name': 'web_search', 'parameters': {'maxResults': 10}}
+    assert d == {'name': 'web_search', 'customParameters': {'maxResults': 10}}
 
 
-def test_tool_definition_to_dict_no_parameters():
+def test_tool_definition_to_dict_no_custom_parameters():
     tool = ToolDefinition('calculator')
     d = tool.to_dict()
     assert d == {'name': 'calculator'}
@@ -484,16 +484,16 @@ def test_completion_config_has_tools(ldai_client: LDAIClient):
 
     web_search = config.tools[0]
     assert web_search.name == 'web_search'
-    assert web_search.get_parameter('maxResults') == 10
-    assert web_search.get_parameter('region') == 'us'
+    assert web_search.get_custom_parameter('maxResults') == 10
+    assert web_search.get_custom_parameter('region') == 'us'
 
     get_weather = config.tools[1]
     assert get_weather.name == 'get_weather'
-    assert get_weather.get_parameter('units') == 'celsius'
+    assert get_weather.get_custom_parameter('units') == 'celsius'
 
     calculator = config.tools[2]
     assert calculator.name == 'calculator'
-    assert calculator.get_parameter('anything') is None
+    assert calculator.get_custom_parameter('anything') is None
 
 
 def test_completion_config_no_tools(ldai_client: LDAIClient):
@@ -513,7 +513,7 @@ def test_completion_config_tools_missing_flag(ldai_client: LDAIClient):
         enabled=True,
         model=ModelConfig('fallback'),
         messages=[],
-        tools=[ToolDefinition('default_tool', parameters={'key': 'value'})],
+        tools=[ToolDefinition('default_tool', custom_parameters={'key': 'value'})],
     )
 
     config = ldai_client.completion_config('missing-flag', context, default)
@@ -524,4 +524,4 @@ def test_completion_config_tools_missing_flag(ldai_client: LDAIClient):
     assert config.tools is not None
     assert len(config.tools) == 1
     assert config.tools[0].name == 'default_tool'
-    assert config.tools[0].get_parameter('key') == 'value'
+    assert config.tools[0].get_custom_parameter('key') == 'value'