Merge pull request #138 from nextcloud/feat/find-userid

Add find user tool

Author: marcelklehr

ex_app/lib/agent.py

@@ -133,6 +133,8 @@ async def call_model(
 			system_prompt_text += "Use the list_calendars tool to check which calendars exist.\nIf an item should be added to a list, check list_calendars for a fitting calendar and add the item as a task there.\n"
 		if tool_enabled("find_person_in_contacts"):
 			system_prompt_text += "Use the find_person_in_contacts tool to find a person's email address and location.\n"
+		if tool_enabled("find_person_in_users"):
+			system_prompt_text += "Use the find_person_in_users tool to find a person's userId and user details.\n"
 		if tool_enabled("find_details_of_current_user"):
 			system_prompt_text += "Use the find_details_of_current_user tool to find the current user's location.\n"
 

ex_app/lib/all_tools/contacts.py

@@ -1,5 +1,6 @@
 # SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
 # SPDX-License-Identifier: AGPL-3.0-or-later
+import json
 import typing
 
 from langchain_core.tools import tool
@@ -11,6 +12,24 @@
 
 
 async def get_tools(nc: AsyncNextcloudApp):
+	@tool
+	@safe_tool
+	async def find_person_in_users(search_term: str):
+		"""
+		Search for users
+		:param search_term: The search term to find the user by. Use this to find a user's ID
+		Returns:
+		"""
+		users = await nc.ocs('GET', '/ocs/v2.php/apps/files_sharing/api/v1/sharees', params={
+			'search': search_term,
+			'shareType': 0,
+			'itemType': 'user',
+		})
+		dict = {}
+		for user in users.get('exact', {}).get('users', []) + users.get('users', []):
+			dict[user.get('label')] = user.get('value', {}).get('shareWith')
+		return json.dumps(dict)
+
 	@tool
 	@safe_tool
 	async def find_person_in_contacts(name: str) -> list[dict[str, typing.Any]]:
@@ -19,11 +38,10 @@ async def find_person_in_contacts(name: str) -> list[dict[str, typing.Any]]:
 		:param name: the name to search for
 		:return: a dictionary with the person's email, phone and address
 		"""
-		username = nc._session.user
+		username = await nc._session.user
 		response = await nc._session._create_adapter(True).request('PROPFIND', f"{nc.app_cfg.endpoint}/remote.php/dav/addressbooks/users/{username}/", headers={
 			"Content-Type": "application/xml; charset=utf-8",
 		})
-		print(response.text)
 		namespace = {"DAV": "DAV:"}  # Define the namespace
 		root = ET.fromstring(response.text)
 		hrefs = root.findall(".//DAV:href", namespace)
@@ -53,7 +71,7 @@ async def find_person_in_contacts(name: str) -> list[dict[str, typing.Any]]:
 				"Content-Type": "application/xml; charset=utf-8",
 				"Depth": "1",
 			}, content=xml_body)
-			print(response.text)
+
 			if response.status_code != 207:  # Multi-Status
 				raise Exception(f"Error: {response.status_code} - {response.reason_phrase}")
 
@@ -88,7 +106,9 @@ async def find_details_of_current_user() -> dict[str, typing.Any]:
 
 
 	return [
-		find_person_in_contacts, find_details_of_current_user
+		find_person_in_users,
+		find_person_in_contacts,
+		find_details_of_current_user
 	]
 
 def get_category_name():

ex_app/lib/all_tools/search.py

@@ -24,7 +24,7 @@ async def tool(search_query: dict[str, str]):
         tool_func.__doc__ = (
             f"Searches {provider['name']} in Nextcloud.\n"
             f":param search_query: A mapping of filter names to filter values to use for the search. "
-            f"Choose filters from {json.dumps(provider['filters'])}. "
+            f"Choose filters from {json.dumps(provider['filters'])}. (The 'person' filter, if available, takes a userID. Use find_person_in_users to obtain it.)"
             'For example: {"term": "hans", ...}\n'
         )
         tools.append(tool(safe_tool(tool_func)))