{"record":{"id":"8cd1651f3c9165f5","repo":"microsoft/autogen","slug":"invalid-description-retval-for-parameter-k-sh","errorCode":null,"errorMessage":"Invalid description {retval} for parameter {k}, should be a string.","messagePattern":"Invalid description (.+?) for parameter (.+?), should be a string\\.","errorType":"exception","errorClass":"ValueError","httpStatus":null,"severity":"error","filePath":"python/packages/autogen-core/src/autogen_core/_function_utils.py","lineNumber":127,"sourceCode":"    name: Annotated[str, Field(description=\"Name of the function\")]\n    parameters: Annotated[Parameters, Field(description=\"Parameters of the function\")]\n\n\nclass ToolFunction(BaseModel):\n    \"\"\"A function under tool as defined by the OpenAI API.\"\"\"\n\n    type: Literal[\"function\"] = \"function\"\n    function: Annotated[Function, Field(description=\"Function under tool\")]\n\n\ndef type2description(k: str, v: Union[Annotated[Type[Any], str], Type[Any]]) -> str:\n    # handles Annotated\n    if hasattr(v, \"__metadata__\"):\n        retval = v.__metadata__[0]\n        if isinstance(retval, str):\n            return retval\n        else:\n            raise ValueError(f\"Invalid description {retval} for parameter {k}, should be a string.\")\n    else:\n        return k\n\n\ndef get_parameter_json_schema(k: str, v: Any, default_values: Dict[str, Any]) -> Dict[str, Any]:\n    \"\"\"Get a JSON schema for a parameter as defined by the OpenAI API\n\n    Args:\n        k: The name of the parameter\n        v: The type of the parameter\n        default_values: The default values of the parameters of the function\n\n    Returns:\n        A Pydanitc model for the parameter\n    \"\"\"\n\n    schema = TypeAdapter(v).json_schema()\n    if k in default_values:","sourceCodeStart":109,"sourceCodeEnd":145,"githubUrl":"https://github.com/microsoft/autogen/blob/027ecf0a379bcc1d09956d46d12d44a3ad9cee14/python/packages/autogen-core/src/autogen_core/_function_utils.py#L109-L145","documentation":"Error \"Invalid description {retval} for parameter {k}, should be a string.\" thrown in microsoft/autogen.","triggerScenarios":"Thrown at python/packages/autogen-core/src/autogen_core/_function_utils.py:127 when the library encounters an invalid state.","commonSituations":"See trigger scenarios.","solutions":["Provide string descriptions for all tool parameters"],"exampleFix":"Set description='...' strings in the function docstring/annotations","handlingStrategy":null,"validationCode":null,"typeGuard":null,"tryCatchPattern":null,"preventionTips":[],"tags":[],"backgroundTag":null,"analyzedSha":"027ecf0a379bcc1d09956d46d12d44a3ad9cee14","analyzedAt":"2026-08-15T03:38:00.719Z","schemaVersion":2},"datasetVersion":"2026-08-15T17:31:12.345Z"}