""" Tool search: large tool schemas are left out of the provider `tools` array and listed by name in an `` system prompt block. `search_tools` returns the full definitions of matching tools, which the model invokes through `call_tool`. Discovery does not change the provider `tools` array. """ import fnmatch import re import unicodedata import regex from open_webui.models.config import Config from open_webui.utils.json_codec import JSONCodec from open_webui.utils.misc import add_or_update_system_message SEARCH_TOOL_NAME = 'search_tools' CALL_TOOL_NAME = 'call_tool' MANIFEST_DESCRIPTION_MAX_CHARS = 100 MAX_SEARCH_COUNT = 20 DEFAULT_SEARCH_COUNT = 5 _MANIFEST_RE = re.compile(r'\n?\n.*?', re.DOTALL) async def get_tool_search_config() -> dict | None: """Tool search settings, or None when the feature is off.""" if not await Config.get('chat.tool_search.enable'): return None values = await Config.get_many( 'chat.tool_search.defer_threshold', 'chat.tool_search.always_loaded', 'chat.tool_search.defer_builtin_tools', ) return { 'defer_threshold': values['chat.tool_search.defer_threshold'], 'always_loaded': values['chat.tool_search.always_loaded'], 'defer_builtin_tools': values['chat.tool_search.defer_builtin_tools'], } def select_deferred_tools(tools_dict: dict[str, dict], config: dict) -> list[str]: """Sorted names of tools whose schema exceeds the threshold and that are not always loaded.""" patterns = config['always_loaded'] return sorted( name for name, tool in tools_dict.items() if (config['defer_builtin_tools'] or tool.get('type') != 'builtin') and not any(fnmatch.fnmatchcase(name, pattern) for pattern in patterns) and len(JSONCodec.dumps(tool.get('spec') or {})) > config['defer_threshold'] ) def _truncate_description(description: str | None) -> str: text = ' '.join(str(description or '').split()) if len(text) > MANIFEST_DESCRIPTION_MAX_CHARS: text = text[: MANIFEST_DESCRIPTION_MAX_CHARS - 1].rstrip() + '…' return text def build_deferred_tools_manifest(tools_dict: dict[str, dict], deferred: list[str]) -> str: entries = '' for name in deferred: description = _truncate_description(tools_dict[name].get('spec', {}).get('description')) entries += f'\n{name}\n{description}\n\n' return ( '\n' 'The following tools are available but their definitions are not loaded. ' f'To use one, call `{SEARCH_TOOL_NAME}` with a short keyword query or the exact tool name to get its ' f'definition, then use `{CALL_TOOL_NAME}` with `tool_name` set to its exact name and `params` set ' 'to a JSON-encoded object containing its arguments. Do not call deferred tools directly. ' 'For example: call_tool(tool_name="get_weather", params=\'{"city":"Dubai"}\'). ' 'Never tell the user a capability is unavailable without searching first.\n' f'{entries}' ) async def apply_tool_search( form_data: dict, metadata: dict, tools_dict: dict[str, dict], extra_tools: list[dict] | None = None ) -> set[str]: """Add discovery and dispatch when tools can be deferred; return names to omit from provider tools.""" names = set(tools_dict) | {(tool.get('function') or tool).get('name') for tool in extra_tools or []} config = not names.intersection({SEARCH_TOOL_NAME, CALL_TOOL_NAME}) and await get_tool_search_config() deferred = select_deferred_tools(tools_dict, config) if config else [] if not deferred: return set() from open_webui.tools.builtin import search_tools from open_webui.utils.tools import ( get_async_tool_function_and_apply_extra_params, get_builtin_function_introspection, get_builtin_tool_spec, ) metadata['deferred_tools'] = deferred form_data['messages'] = add_or_update_system_message( build_deferred_tools_manifest(tools_dict, deferred), form_data['messages'], append=True, ) tools_dict[SEARCH_TOOL_NAME] = { 'tool_id': f'builtin:{SEARCH_TOOL_NAME}', 'callable': await get_async_tool_function_and_apply_extra_params( search_tools, {'__metadata__': metadata}, get_builtin_function_introspection(search_tools) ), 'spec': get_builtin_tool_spec(search_tools), 'type': 'builtin', } # Middleware resolves this before approvals and execution, preserving the target tool's behavior. tools_dict[CALL_TOOL_NAME] = { 'tool_id': f'builtin:{CALL_TOOL_NAME}', 'type': 'builtin', 'spec': { 'name': CALL_TOOL_NAME, 'description': ( 'Invoke a tool found by search_tools. Use its exact name and encode its arguments as a JSON ' 'object string matching the returned definition. Use "{}" for a tool without arguments.' ), 'strict': True, 'parameters': { 'type': 'object', 'properties': { 'tool_name': {'type': 'string', 'description': 'Exact tool name returned by search_tools.'}, 'params': {'type': 'string', 'description': 'JSON-encoded object of arguments for the tool.'}, }, 'required': ['tool_name', 'params'], 'additionalProperties': False, }, }, } return set(deferred) def resolve_tool_call(tool_call: dict, tools: dict[str, dict]) -> str | None: """Unwrap our dispatcher in place, retaining the provider call for history replay. Never execute here.""" function = tool_call.get('function', {}) if ( function.get('name') != CALL_TOOL_NAME or tools.get(CALL_TOOL_NAME, {}).get('tool_id') != f'builtin:{CALL_TOOL_NAME}' ): return None try: arguments = JSONCodec.loads(function.get('arguments', '')) if not isinstance(arguments, dict) or set(arguments) != {'tool_name', 'params'}: raise ValueError('call_tool requires tool_name and params.') name = arguments['tool_name'] if not isinstance(name, str) or not name.strip(): raise ValueError('tool_name must be a non-empty string.') if name in {SEARCH_TOOL_NAME, CALL_TOOL_NAME}: raise ValueError('call_tool cannot invoke search_tools or itself.') if name not in tools: raise ValueError(f'Tool "{name}" is not available. Search for an available tool.') if not isinstance(arguments['params'], str): raise ValueError('params must be a JSON-encoded object string.') params = JSONCodec.loads(arguments['params']) if not isinstance(params, dict): raise ValueError('params must decode to a JSON object.') except (TypeError, ValueError) as error: return f'Error: {error}' tool_call['provider_function'] = dict(function) tool_call['function'] = {'name': name, 'arguments': JSONCodec.dumps(params)} return None def strip_deferred_tools_manifest(system_prompt: str | None) -> str | None: """Remove the manifest from a system prompt that is reused by a request which builds its own.""" return _MANIFEST_RE.sub('', system_prompt) if system_prompt else system_prompt # Letters, digits and combining marks, so vowel signs in scripts like Devanagari stay attached to their word. _WORD_RE = regex.compile(r'[\p{L}\p{N}\p{M}]+') _CAMEL_RE = re.compile(r'(?<=[a-z0-9])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])') # Scripts written without spaces between words: Han, Hiragana, Katakana and Hangul. _CJK_RE = re.compile(r'([\u3040-\u30ff\u3400-\u4dbf\u4e00-\u9fff\uf900-\ufaff\uac00-\ud7af]+)') def tokenize(text: str | None) -> list[str]: """Lowercase word tokens split on camelCase boundaries, with CJK runs split into character bigrams.""" tokens = [] for word in _WORD_RE.findall(unicodedata.normalize('NFKC', text or '')): for part in _CAMEL_RE.split(word): for chunk in _CJK_RE.split(part.casefold()): if _CJK_RE.fullmatch(chunk): tokens.extend([chunk[i : i + 2] for i in range(len(chunk) - 1)] or [chunk]) elif chunk: tokens.append(chunk) return tokens def _document_text(name: str, spec: dict) -> str: properties = (spec.get('parameters') or {}).get('properties') or {} return ' '.join([name, str(spec.get('description') or ''), *properties.keys()]) def search_deferred_tools(query: str, candidates: dict[str, dict], count: int = DEFAULT_SEARCH_COUNT) -> list[str]: """Rank candidate tools (name -> spec) against the query; an exact tool name wins outright.""" from rank_bm25 import BM25Okapi query = (query or '').strip() if query in candidates: return [query] query_tokens = tokenize(query) if not candidates or not query_tokens: return [] names = list(candidates) documents = [tokenize(_document_text(name, candidates[name])) or ['_'] for name in names] # BM25 IDF is zero for a term found in half the corpus, common with small tool sets, # so raw token overlap keeps every matching term rankable. bm25 = BM25Okapi(documents).get_scores(query_tokens) scores = { name: max(0.0, float(bm25[index])) + len(set(query_tokens) & set(documents[index])) for index, name in enumerate(names) } ranked = sorted((name for name in names if scores[name] > 0), key=lambda name: (-scores[name], name)) return ranked[: max(1, min(count, MAX_SEARCH_COUNT))]