fix: cannot have keywords {'description'}. #3001 (#3041)

Co-authored-by: Wendong-Fan <133094783+Wendong-Fan@users.noreply.github.com>

Author: Saedbhati

camel/toolkits/function_tool.py

@@ -156,7 +156,12 @@ def _create_mol(name, field):
         if (name := param.arg_name) in parameters_dict["properties"] and (
             description := param.description
         ):
-            parameters_dict["properties"][name]["description"] = description
+            # OpenAI does not allow descriptions on properties that use $ref.
+            # To avoid schema errors, we only add the description if "$ref" is
+            # not present.
+            prop = parameters_dict["properties"][name]
+            if "$ref" not in prop:
+                prop["description"] = description
 
     short_description = docstring.short_description or ""
     long_description = docstring.long_description or ""

test/toolkits/test_openai_function.py

@@ -160,10 +160,7 @@ def test_all_parameters(
                         'type': 'string',
                         'description': 'datatime_para desc',
                     },
-                    'default_enum_para': {
-                        '$ref': '#/$defs/RoleType',
-                        'description': 'default_enum_para desc',
-                    },
+                    'default_enum_para': {'$ref': '#/$defs/RoleType'},
                 },
                 'required': [
                     'any_para',