optimizely-opal.opal-tools-sdk 0.1.41.dev0__tar.gz → 0.1.42.dev0__tar.gz

{optimizely_opal_opal_tools_sdk-0.1.41.dev0 → optimizely_opal_opal_tools_sdk-0.1.42.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: optimizely-opal.opal-tools-sdk
-Version: 0.1.41.dev0
+Version: 0.1.42.dev0
 Summary: SDK for creating Opal-compatible tools services
 Home-page: https://github.com/optimizely/opal-tools-sdk
 Author: Optimizely

{optimizely_opal_opal_tools_sdk-0.1.41.dev0 → optimizely_opal_opal_tools_sdk-0.1.42.dev0}/opal_tools_sdk/decorators.py

@@ -99,6 +99,7 @@ def tool(
     timeout: int | None = None,
     sensitive: str | bool | None = None,
     wait: bool = False,
+    skippable_interaction: bool = False,
 ):
     """Decorator to register a function as an Opal tool.
 
@@ -114,6 +115,8 @@ def tool(
             Example: "ui://my-app/create-form"
         wait: When True, invoking this tool pauses the agent execution until the caller
             signals completion.
+        skippable_interaction: When True, the tool's confirmation interaction (card) can be
+            skipped; a user who opts out has the tool run headless instead.
 
     Returns:
         Decorator function
@@ -309,6 +312,7 @@ def tool(
                 timeout=timeout,
                 sensitive=sensitive,
                 wait=wait,
+                skippable_interaction=skippable_interaction,
             )
 
         return func

{optimizely_opal_opal_tools_sdk-0.1.41.dev0 → optimizely_opal_opal_tools_sdk-0.1.42.dev0}/opal_tools_sdk/models.py

@@ -3,7 +3,7 @@ from enum import Enum
 from typing import Any, Literal
 
 from pydantic import BaseModel, Field
-from typing_extensions import TypedDict  # pydantic requires this on Python < 3.12
+from typing_extensions import NotRequired, TypedDict  # pydantic requires this on Python < 3.12
 
 
 class ParameterType(str, Enum):
@@ -83,14 +83,17 @@ class InteractionContext:
     auth_data: AuthData | None = None
 
 
-class Environment(TypedDict, total=False):
+class Environment(TypedDict):
     """Execution environment for an Opal tool.
 
     Interactive mode provides interaction islands, while headless does not.
+    `execution_mode` is always sent by TMS — required. `is_proteus_enabled`
+    was added later, so older TMS versions may omit it; mark it `NotRequired`
+    for cross-version forward compatibility.
     """
 
     execution_mode: Literal["headless", "interactive"]
-    is_proteus_enabled: bool
+    is_proteus_enabled: NotRequired[bool]
 
 
 @dataclass
@@ -110,6 +113,7 @@ class Function:
     # to a non-empty advisory string when sensitive, else None.
     sensitive: str | bool | None = None
     wait: bool = False  # When True, pauses the agent until the caller signals completion
+    skippable_interaction: bool = False  # When True, the tool's confirmation card can be skipped
 
     def __post_init__(self) -> None:
         # Normalize `sensitive` to the wire shape: a single nullable advisory
@@ -144,6 +148,8 @@ class Function:
             result["sensitive"] = self.sensitive
         if self.wait:
             result["wait"] = self.wait
+        if self.skippable_interaction:
+            result["skippable_interaction"] = self.skippable_interaction
 
         return result
 

{optimizely_opal_opal_tools_sdk-0.1.41.dev0 → optimizely_opal_opal_tools_sdk-0.1.42.dev0}/opal_tools_sdk/service.py

@@ -314,6 +314,7 @@ class ToolsService:
         timeout: int | None = None,
         sensitive: str | bool | None = None,
         wait: bool = False,
+        skippable_interaction: bool = False,
     ) -> None:
         """Register a tool function.
 
@@ -329,6 +330,8 @@ class ToolsService:
             timeout: Timeout in seconds for async mode
             sensitive: Sensitive data field declaration
             wait: When True, invoking this tool pauses the agent until the caller signals completion
+            skippable_interaction: When True, the tool's confirmation interaction (card) can be
+                skipped; a user who opts out has the tool run headless instead
         """
         logger.info(f"Registering tool: {name} with endpoint: {endpoint}")
 
@@ -359,6 +362,7 @@ class ToolsService:
             timeout=timeout,
             sensitive=sensitive,
             wait=wait,
+            skippable_interaction=skippable_interaction,
         )
 
         self.functions.append(function)

{optimizely_opal_opal_tools_sdk-0.1.41.dev0 → optimizely_opal_opal_tools_sdk-0.1.42.dev0}/optimizely_opal.opal_tools_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: optimizely-opal.opal-tools-sdk
-Version: 0.1.41.dev0
+Version: 0.1.42.dev0
 Summary: SDK for creating Opal-compatible tools services
 Home-page: https://github.com/optimizely/opal-tools-sdk
 Author: Optimizely

{optimizely_opal_opal_tools_sdk-0.1.41.dev0 → optimizely_opal_opal_tools_sdk-0.1.42.dev0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "optimizely-opal.opal-tools-sdk"
-version = "0.1.41-dev"
+version = "0.1.42-dev"
 description = "SDK for creating Opal-compatible tools services"
 authors = [{ name = "Optimizely", email = "opal-team@optimizely.com" }]
 readme = "README.md"

{optimizely_opal_opal_tools_sdk-0.1.41.dev0 → optimizely_opal_opal_tools_sdk-0.1.42.dev0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="optimizely-opal.opal-tools-sdk",
-    version="0.1.41-dev",
+    version="0.1.42-dev",
     packages=find_packages(),
     install_requires=[
         "fastapi>=0.100.0",

{optimizely_opal_opal_tools_sdk-0.1.41.dev0 → optimizely_opal_opal_tools_sdk-0.1.42.dev0}/tests/test_integration.py

@@ -860,3 +860,22 @@ def test_v1_tool_bare_dict_unchanged():
     assert "application/json" in resp.headers["content-type"]
     # Should NOT be wrapped in envelope
     assert resp.json() == {"v1": True, "name": "Dave"}
+
+
+def test_tool_with_skippable_interaction_flag():
+    """A tool marked skippable_interaction advertises it in discovery; others omit the key."""
+    app = FastAPI()
+    _ = ToolsService(app)
+
+    @tool(name="skip_me", description="skippable tool", skippable_interaction=True)
+    async def skip_me(params: SimpleParams) -> dict:
+        return {"ok": True}
+
+    @tool(name="plain", description="plain tool")
+    async def plain(params: SimpleParams) -> dict:
+        return {"ok": True}
+
+    discovery = TestClient(app).get("/discovery").json()
+    by_name = {f["name"]: f for f in discovery["functions"]}
+    assert by_name["skip_me"]["skippable_interaction"] is True
+    assert "skippable_interaction" not in by_name["plain"]