From ed6d6575d7c9d359bbf84a702f8f90fb466207bb Mon Sep 17 00:00:00 2001
From: Denis Shulyaka <Shulyaka@gmail.com>
Date: Fri, 2 Aug 2024 09:05:06 +0300
Subject: [PATCH] Add aliases to script llm tool description (#122380)

* Add aliases to script llm tool description

* Also add name
---
 homeassistant/helpers/llm.py | 13 +++++++++++++
 tests/helpers/test_llm.py    | 36 +++++++++++++++++++++++++++++-------
 2 files changed, 42 insertions(+), 7 deletions(-)

diff --git a/homeassistant/helpers/llm.py b/homeassistant/helpers/llm.py
index 4ddb00166b6..e37aa0c532d 100644
--- a/homeassistant/helpers/llm.py
+++ b/homeassistant/helpers/llm.py
@@ -677,6 +677,19 @@ class ScriptTool(Tool):
 
                 self.parameters = vol.Schema(schema)
 
+                aliases: list[str] = []
+                if entity_entry.name:
+                    aliases.append(entity_entry.name)
+                if entity_entry.aliases:
+                    aliases.extend(entity_entry.aliases)
+                if aliases:
+                    if self.description:
+                        self.description = (
+                            self.description + ". Aliases: " + str(list(aliases))
+                        )
+                    else:
+                        self.description = "Aliases: " + str(list(aliases))
+
                 parameters_cache[entity_entry.unique_id] = (
                     self.description,
                     self.parameters,
diff --git a/tests/helpers/test_llm.py b/tests/helpers/test_llm.py
index ea6e628d1d4..4d14abb9819 100644
--- a/tests/helpers/test_llm.py
+++ b/tests/helpers/test_llm.py
@@ -411,7 +411,9 @@ async def test_assist_api_prompt(
     )
     hass.states.async_set(entry2.entity_id, "on", {"friendly_name": "Living Room"})
 
-    def create_entity(device: dr.DeviceEntry, write_state=True) -> None:
+    def create_entity(
+        device: dr.DeviceEntry, write_state=True, aliases: set[str] | None = None
+    ) -> None:
         """Create an entity for a device and track entity_id."""
         entity = entity_registry.async_get_or_create(
             "light",
@@ -421,6 +423,8 @@ async def test_assist_api_prompt(
             original_name=str(device.name or "Unnamed Device"),
             suggested_object_id=str(device.name or "unnamed_device"),
         )
+        if aliases:
+            entity_registry.async_update_entity(entity.entity_id, aliases=aliases)
         if write_state:
             entity.write_unavailable_state(hass)
 
@@ -432,7 +436,8 @@ async def test_assist_api_prompt(
             manufacturer="Test Manufacturer",
             model="Test Model",
             suggested_area="Test Area",
-        )
+        ),
+        aliases={"my test light"},
     )
     for i in range(3):
         create_entity(
@@ -516,7 +521,7 @@ async def test_assist_api_prompt(
   domain: light
   state: 'on'
   areas: Test Area, Alternative name
-- names: Test Device
+- names: Test Device, my test light
   domain: light
   state: unavailable
   areas: Test Area, Alternative name
@@ -616,6 +621,7 @@ async def test_assist_api_prompt(
 
 async def test_script_tool(
     hass: HomeAssistant,
+    entity_registry: er.EntityRegistry,
     area_registry: ar.AreaRegistry,
     floor_registry: fr.FloorRegistry,
 ) -> None:
@@ -659,6 +665,10 @@ async def test_script_tool(
     )
     async_expose_entity(hass, "conversation", "script.test_script", True)
 
+    entity_registry.async_update_entity(
+        "script.test_script", name="script name", aliases={"script alias"}
+    )
+
     area = area_registry.async_create("Living room")
     floor = floor_registry.async_create("2")
 
@@ -671,7 +681,10 @@ async def test_script_tool(
 
     tool = tools[0]
     assert tool.name == "test_script"
-    assert tool.description == "This is a test script"
+    assert (
+        tool.description
+        == "This is a test script. Aliases: ['script name', 'script alias']"
+    )
     schema = {
         vol.Required("beer", description="Number of beers"): cv.string,
         vol.Optional("wine"): selector.NumberSelector({"min": 0, "max": 3}),
@@ -684,7 +697,10 @@ async def test_script_tool(
     assert tool.parameters.schema == schema
 
     assert hass.data[llm.SCRIPT_PARAMETERS_CACHE] == {
-        "test_script": ("This is a test script", vol.Schema(schema))
+        "test_script": (
+            "This is a test script. Aliases: ['script name', 'script alias']",
+            vol.Schema(schema),
+        )
     }
 
     tool_input = llm.ToolInput(
@@ -754,12 +770,18 @@ async def test_script_tool(
 
     tool = tools[0]
     assert tool.name == "test_script"
-    assert tool.description == "This is a new test script"
+    assert (
+        tool.description
+        == "This is a new test script. Aliases: ['script name', 'script alias']"
+    )
     schema = {vol.Required("beer", description="Number of beers"): cv.string}
     assert tool.parameters.schema == schema
 
     assert hass.data[llm.SCRIPT_PARAMETERS_CACHE] == {
-        "test_script": ("This is a new test script", vol.Schema(schema))
+        "test_script": (
+            "This is a new test script. Aliases: ['script name', 'script alias']",
+            vol.Schema(schema),
+        )
     }