glaip-sdk 0.6.19__py3-none-any.whl → 0.7.27__py3-none-any.whl

glaip_sdk/utils/bundler.py

@@ -14,6 +14,7 @@ import inspect
 from pathlib import Path
 
 from glaip_sdk.utils.import_resolver import ImportResolver
+from glaip_sdk.utils.tool_detection import is_tool_plugin_decorator
 
 
 class ToolBundler:
@@ -50,9 +51,14 @@ class ToolBundler:
         self.tool_dir = self.tool_file.parent
         self._import_resolver = ImportResolver(self.tool_dir)
 
-    def bundle(self) -> str:
+    def bundle(self, add_tool_plugin_decorator: bool = True) -> str:
         """Bundle tool source code with inlined local imports.
 
+        Args:
+            add_tool_plugin_decorator: If True, add @tool_plugin decorator to BaseTool classes.
+                Set to False for newer servers (0.1.85+) where decorator is optional.
+                Defaults to True for backward compatibility with older servers.
+
         Returns:
             Bundled source code with all local dependencies inlined.
         """
@@ -62,6 +68,16 @@ class ToolBundler:
         tree = ast.parse(full_source)
         local_imports, external_imports = self._import_resolver.categorize_imports(tree)
 
+        # NOTE: The @tool_plugin decorator is REQUIRED by older servers (< 0.1.85) for remote execution.
+        # Newer servers (0.1.85+) make the decorator optional.
+        # The server validates uploaded tool code and will reject tools without the decorator
+        # with error: "No classes found with @tool_plugin decorator".
+        # See: docs/resources/reference/schemas/tools.md - "Plugin Requirements"
+        # TESTED: Commenting out this decorator addition causes HTTP 400 ValidationError from older servers.
+        # We try without decorator first (for new servers), then retry with decorator if validation fails.
+        if add_tool_plugin_decorator:
+            self._add_tool_plugin_decorator(tree)
+
         # Extract main code nodes (excluding imports, docstrings, glaip_sdk.Tool subclasses)
         main_code_nodes = self._extract_main_code_nodes(tree)
 
@@ -71,6 +87,13 @@ class ToolBundler:
         # Merge all external imports
         all_external_imports = external_imports + inlined_external_imports
 
+        # NOTE: The gllm_plugin.tools import is REQUIRED when decorator is added.
+        # Without this import, the decorator will cause a NameError when the server executes the code.
+        # TESTED: Commenting out this import causes NameError when server tries to use the decorator.
+        # This import is added automatically during bundling so source files can remain clean.
+        if add_tool_plugin_decorator:
+            self._ensure_tool_plugin_import(all_external_imports)
+
         # Build bundled code
         bundled_code = ["# Bundled tool with inlined local imports\n"]
         bundled_code.extend(self._import_resolver.format_external_imports(all_external_imports))
@@ -109,6 +132,103 @@ class ToolBundler:
             main_code_nodes.append(ast.unparse(node))
         return main_code_nodes
 
+    @staticmethod
+    def _add_tool_plugin_decorator(tree: ast.AST) -> None:
+        """Add @tool_plugin decorator to BaseTool classes that don't have it.
+
+        This allows tools to be clean (without decorator) for local use,
+        while the decorator is automatically added during bundling for remote execution.
+
+        Args:
+            tree: AST tree to modify in-place.
+        """
+        for node in ast.walk(tree):
+            if not isinstance(node, ast.ClassDef):
+                continue
+
+            if not ToolBundler._inherits_from_base_tool(node):
+                continue
+
+            if ToolBundler._has_tool_plugin_decorator(node):
+                continue
+
+            decorator_call = ToolBundler._create_tool_plugin_decorator()
+            node.decorator_list.insert(0, decorator_call)
+
+    @staticmethod
+    def _inherits_from_base_tool(class_node: ast.ClassDef) -> bool:
+        """Check if a class inherits from BaseTool.
+
+        Args:
+            class_node: AST ClassDef node to check.
+
+        Returns:
+            True if class inherits from BaseTool.
+        """
+        for base in class_node.bases:
+            if isinstance(base, ast.Name) and base.id == "BaseTool":
+                return True
+            if isinstance(base, ast.Attribute) and base.attr == "BaseTool":
+                # Handle nested attributes like langchain_core.tools.BaseTool
+                # Check if the value chain leads to langchain_core
+                value = base.value
+                while isinstance(value, ast.Attribute):
+                    value = value.value
+                if isinstance(value, ast.Name) and value.id == "langchain_core":
+                    return True
+        return False
+
+    @staticmethod
+    def _has_tool_plugin_decorator(class_node: ast.ClassDef) -> bool:
+        """Check if a class already has the @tool_plugin decorator.
+
+        Args:
+            class_node: AST ClassDef node to check.
+
+        Returns:
+            True if decorator already exists.
+        """
+        for decorator in class_node.decorator_list:
+            if is_tool_plugin_decorator(decorator):
+                return True
+        return False
+
+    @staticmethod
+    def _create_tool_plugin_decorator() -> ast.Call:
+        """Create a @tool_plugin decorator AST node.
+
+        Returns:
+            AST Call node representing @tool_plugin(version="1.0.0").
+        """
+        return ast.Call(
+            func=ast.Name(id="tool_plugin", ctx=ast.Load()),
+            args=[],
+            keywords=[ast.keyword(arg="version", value=ast.Constant(value="1.0.0"))],
+        )
+
+    @staticmethod
+    def _ensure_tool_plugin_import(external_imports: list) -> None:
+        """Ensure gllm_plugin.tools import is present in external imports.
+
+        Args:
+            external_imports: List of external import nodes (modified in-place).
+        """
+        # Check if import already exists
+        for import_node in external_imports:
+            if isinstance(import_node, ast.ImportFrom) and import_node.module == "gllm_plugin.tools":
+                # Check if tool_plugin is in the names
+                for alias in import_node.names:
+                    if alias.name == "tool_plugin":
+                        return  # Import already present
+
+        # Add the import
+        import_node = ast.ImportFrom(
+            module="gllm_plugin.tools",
+            names=[ast.alias(name="tool_plugin")],
+            level=0,
+        )
+        external_imports.append(import_node)
+
     @staticmethod
     def _is_sdk_tool_subclass(node: ast.ClassDef) -> bool:
         """Check if AST class definition inherits from Tool.
@@ -135,7 +255,7 @@ class ToolBundler:
         return False
 
     @classmethod
-    def bundle_from_source(cls, file_path: Path) -> tuple[str, str, str]:
+    def bundle_from_source(cls, file_path: Path, add_tool_plugin_decorator: bool = True) -> tuple[str, str, str]:
         """Extract tool info directly from source file without importing.
 
         This is used as a fallback when the tool class cannot be imported
@@ -143,6 +263,9 @@ class ToolBundler:
 
         Args:
             file_path: Path to the tool source file.
+            add_tool_plugin_decorator: If True, add @tool_plugin decorator to BaseTool classes.
+                Set to False for newer servers (0.1.85+) where decorator is optional.
+                Defaults to True for backward compatibility with older servers.
 
         Returns:
             Tuple of (name, description, bundled_source_code).
@@ -160,6 +283,12 @@ class ToolBundler:
         tool_dir = file_path.parent
         import_resolver = ImportResolver(tool_dir)
 
+        # NOTE: The @tool_plugin decorator is REQUIRED by older servers (< 0.1.85) for remote execution.
+        # Newer servers (0.1.85+) make the decorator optional.
+        # See bundle() method for detailed explanation.
+        if add_tool_plugin_decorator:
+            cls._add_tool_plugin_decorator(tree)
+
         # Find tool name and description from class definitions
         tool_name, tool_description = cls._extract_tool_metadata(tree, file_path.stem)
 
@@ -180,6 +309,13 @@ class ToolBundler:
 
         # Build bundled code
         all_external_imports = external_imports + inlined_external_imports
+
+        # NOTE: The gllm_plugin.tools import is REQUIRED when decorator is added.
+        # See bundle() method for detailed explanation.
+        # TESTED: Commenting out this import causes NameError when server tries to use the decorator.
+        if add_tool_plugin_decorator:
+            cls._ensure_tool_plugin_import(all_external_imports)
+
         bundled_code = ["# Bundled tool with inlined local imports\n"]
         bundled_code.extend(import_resolver.format_external_imports(all_external_imports))