stackone-ai 2.9.0__tar.gz → 2.10.0__tar.gz

stackone_ai-2.10.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "2.10.0"
+}

{stackone_ai-2.9.0 → stackone_ai-2.10.0}/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [2.10.0](https://github.com/StackOneHQ/stackone-ai-python/compare/stackone-ai-v2.9.1...stackone-ai-v2.10.0) (2026-07-27)
+
+
+### Features
+
+* **ENG-733:** support flat_prefixed MCP param style ([#192](https://github.com/StackOneHQ/stackone-ai-python/issues/192)) ([ff8fb9a](https://github.com/StackOneHQ/stackone-ai-python/commit/ff8fb9a41add55e9c31bd84e04447bb3685ab024))
+
+## [2.9.1](https://github.com/StackOneHQ/stackone-ai-python/compare/stackone-ai-v2.9.0...stackone-ai-v2.9.1) (2026-06-03)
+
+
+### Bug Fixes
+
+* **models:** handle binary file downloads in tool execution ([#190](https://github.com/StackOneHQ/stackone-ai-python/issues/190)) ([8983c68](https://github.com/StackOneHQ/stackone-ai-python/commit/8983c68dd2fdbdbdd52af531a9a9f1de6d72e1b8))
+* **search:** make ToolsetConfigError actionable and fix misleading docs ([#188](https://github.com/StackOneHQ/stackone-ai-python/issues/188)) ([d332c27](https://github.com/StackOneHQ/stackone-ai-python/commit/d332c27d2f7b827e7ca043f60c37cb0831a92361))
+
 ## [2.9.0](https://github.com/StackOneHQ/stackone-ai-python/compare/stackone-ai-v2.8.0...stackone-ai-v2.9.0) (2026-04-30)
 
 

{stackone_ai-2.9.0 → stackone_ai-2.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stackone-ai
-Version: 2.9.0
+Version: 2.10.0
 Summary: agents performing actions on your SaaS
 Author-email: StackOne <support@stackone.com>
 License-File: LICENSE
@@ -149,6 +149,35 @@ tools = toolset.fetch_tools(providers=["hibob"])
   - Glob pattern: `["*_list_employees"]` matches all tools ending with `_list_employees`
   - Provider prefix: `["workday_*"]` matches all Workday tools
 
+## File Downloads
+
+Actions that return a file — e.g. `googledrive_unified_download_file`, `documents_download_file`, any `*_unified_download_file` — resolve to **raw bytes plus metadata**, not parsed JSON. The SDK decides this from the response `Content-Type`: a JSON content type is parsed as before; anything else is treated as a file download. This applies to both `tool.execute()` and `tool.call()`.
+
+```python
+tools = toolset.fetch_tools(actions=["googledrive_*"], account_ids=[account_id])
+download = tools.get_tool("googledrive_unified_download_file")
+
+result = download.execute({"id": "file-id"})
+
+# `result` is a dict describing the file — write the bytes straight to disk:
+with open(result["file_name"] or "download.bin", "wb") as f:
+    f.write(result["content"])
+```
+
+The returned dict:
+
+| Key            | Type          | Description                                                                                  |
+| -------------- | ------------- | -------------------------------------------------------------------------------------------- |
+| `content`      | `bytes`       | Raw file bytes. **Not JSON-serializable** — see the caveat below.                            |
+| `content_type` | `str`         | The file's MIME type (e.g. `application/pdf`), or `application/octet-stream` if unspecified. |
+| `status_code`  | `int`         | HTTP status of the download response.                                                        |
+| `headers`      | `dict`        | Response headers.                                                                            |
+| `file_name`    | `str \| None` | Filename from the `Content-Disposition` header (handles RFC 5987 `filename*`), else `None`.  |
+
+> **Caveat:** `content` holds raw bytes, which are not JSON-serializable. If you forward tool results to an LLM — or anywhere that re-serializes them to JSON — handle or strip the `content` key (for example, base64-encode it on the LLM-facing path).
+
+JSON responses are unchanged: any action returning `application/json` (or a `…+json` type) is parsed and returned as a dict exactly as before.
+
 ## Implicit Feedback (Beta)
 
 The Python SDK can emit implicit behavioral feedback to LangSmith so you can triage low-quality tool results without manually tagging runs.
@@ -263,7 +292,10 @@ For the full catalog (or the meta search/execute tools), use the `.pydantic_ai()
 ```python
 toolset = StackOneToolSet()
 tools = toolset.pydantic_ai(account_ids=[os.environ["STACKONE_ACCOUNT_ID"]])
-# or pydantic_ai(mode="search_and_execute") for agent-driven discovery
+
+# For agent-driven discovery, enable search on the constructor:
+# toolset = StackOneToolSet(search={"method": "auto"})
+# tools = toolset.pydantic_ai(mode="search_and_execute")
 ```
 
 </details>
@@ -394,15 +426,15 @@ Search for tools using natural language queries. Works with both semantic (cloud
 
 ```python
 import os
+from stackone_ai import StackOneToolSet
 
-# Get a callable search tool
-toolset = StackOneToolSet()
+# Get a callable search tool — search must be enabled on the toolset
+toolset = StackOneToolSet(search={"method": "auto"})
 account_id = os.getenv("STACKONE_ACCOUNT_ID")
-all_tools = toolset.fetch_tools(account_ids=[account_id])
 search_tool = toolset.get_search_tool()
 
-# Search for relevant tools — returns a Tools collection
-tools = search_tool("manage employees", top_k=5)
+# Search for relevant tools — returns a Tools collection scoped to the account
+tools = search_tool("manage employees", top_k=5, account_ids=[account_id])
 
 # Execute a discovered tool directly
 tools[0](limit=10)
@@ -416,7 +448,9 @@ Discover tools using natural language instead of exact names. Queries like "onbo
 import os
 from stackone_ai import StackOneToolSet
 
-toolset = StackOneToolSet()
+# Search must be enabled on the constructor — pass `search={}` for defaults,
+# or set a backend / top_k explicitly.
+toolset = StackOneToolSet(search={"method": "auto"})
 
 # Search by intent — returns Tools collection ready for any framework
 account_id = os.getenv("STACKONE_ACCOUNT_ID")

{stackone_ai-2.9.0 → stackone_ai-2.10.0}/README.md

@@ -114,6 +114,35 @@ tools = toolset.fetch_tools(providers=["hibob"])
   - Glob pattern: `["*_list_employees"]` matches all tools ending with `_list_employees`
   - Provider prefix: `["workday_*"]` matches all Workday tools
 
+## File Downloads
+
+Actions that return a file — e.g. `googledrive_unified_download_file`, `documents_download_file`, any `*_unified_download_file` — resolve to **raw bytes plus metadata**, not parsed JSON. The SDK decides this from the response `Content-Type`: a JSON content type is parsed as before; anything else is treated as a file download. This applies to both `tool.execute()` and `tool.call()`.
+
+```python
+tools = toolset.fetch_tools(actions=["googledrive_*"], account_ids=[account_id])
+download = tools.get_tool("googledrive_unified_download_file")
+
+result = download.execute({"id": "file-id"})
+
+# `result` is a dict describing the file — write the bytes straight to disk:
+with open(result["file_name"] or "download.bin", "wb") as f:
+    f.write(result["content"])
+```
+
+The returned dict:
+
+| Key            | Type          | Description                                                                                  |
+| -------------- | ------------- | -------------------------------------------------------------------------------------------- |
+| `content`      | `bytes`       | Raw file bytes. **Not JSON-serializable** — see the caveat below.                            |
+| `content_type` | `str`         | The file's MIME type (e.g. `application/pdf`), or `application/octet-stream` if unspecified. |
+| `status_code`  | `int`         | HTTP status of the download response.                                                        |
+| `headers`      | `dict`        | Response headers.                                                                            |
+| `file_name`    | `str \| None` | Filename from the `Content-Disposition` header (handles RFC 5987 `filename*`), else `None`.  |
+
+> **Caveat:** `content` holds raw bytes, which are not JSON-serializable. If you forward tool results to an LLM — or anywhere that re-serializes them to JSON — handle or strip the `content` key (for example, base64-encode it on the LLM-facing path).
+
+JSON responses are unchanged: any action returning `application/json` (or a `…+json` type) is parsed and returned as a dict exactly as before.
+
 ## Implicit Feedback (Beta)
 
 The Python SDK can emit implicit behavioral feedback to LangSmith so you can triage low-quality tool results without manually tagging runs.
@@ -228,7 +257,10 @@ For the full catalog (or the meta search/execute tools), use the `.pydantic_ai()
 ```python
 toolset = StackOneToolSet()
 tools = toolset.pydantic_ai(account_ids=[os.environ["STACKONE_ACCOUNT_ID"]])
-# or pydantic_ai(mode="search_and_execute") for agent-driven discovery
+
+# For agent-driven discovery, enable search on the constructor:
+# toolset = StackOneToolSet(search={"method": "auto"})
+# tools = toolset.pydantic_ai(mode="search_and_execute")
 ```
 
 </details>
@@ -359,15 +391,15 @@ Search for tools using natural language queries. Works with both semantic (cloud
 
 ```python
 import os
+from stackone_ai import StackOneToolSet
 
-# Get a callable search tool
-toolset = StackOneToolSet()
+# Get a callable search tool — search must be enabled on the toolset
+toolset = StackOneToolSet(search={"method": "auto"})
 account_id = os.getenv("STACKONE_ACCOUNT_ID")
-all_tools = toolset.fetch_tools(account_ids=[account_id])
 search_tool = toolset.get_search_tool()
 
-# Search for relevant tools — returns a Tools collection
-tools = search_tool("manage employees", top_k=5)
+# Search for relevant tools — returns a Tools collection scoped to the account
+tools = search_tool("manage employees", top_k=5, account_ids=[account_id])
 
 # Execute a discovered tool directly
 tools[0](limit=10)
@@ -381,7 +413,9 @@ Discover tools using natural language instead of exact names. Queries like "onbo
 import os
 from stackone_ai import StackOneToolSet
 
-toolset = StackOneToolSet()
+# Search must be enabled on the constructor — pass `search={}` for defaults,
+# or set a backend / top_k explicitly.
+toolset = StackOneToolSet(search={"method": "auto"})
 
 # Search by intent — returns Tools collection ready for any framework
 account_id = os.getenv("STACKONE_ACCOUNT_ID")

{stackone_ai-2.9.0 → stackone_ai-2.10.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "stackone-ai"
-version = "2.9.0"
+version = "2.10.0"
 description = "agents performing actions on your SaaS"
 readme = "README.md"
 requires-python = ">=3.10"

{stackone_ai-2.9.0 → stackone_ai-2.10.0}/stackone_ai/__init__.py

@@ -23,4 +23,4 @@ __all__ = [
     "SemanticSearchResponse",
     "SemanticSearchError",
 ]
-__version__ = "2.9.0"
+__version__ = "2.10.0"

{stackone_ai-2.9.0 → stackone_ai-2.10.0}/stackone_ai/models.py

@@ -3,11 +3,12 @@ from __future__ import annotations
 import base64
 import json
 import logging
+import re
 from collections.abc import Sequence
 from datetime import datetime, timezone
 from enum import Enum
 from typing import TYPE_CHECKING, Annotated, Any, ClassVar, TypeAlias, cast
-from urllib.parse import quote
+from urllib.parse import quote, unquote
 
 import httpx
 from langchain_core.tools import BaseTool
@@ -57,6 +58,47 @@ def validate_method(v: str) -> str:
     return method
 
 
+def _is_json_content_type(content_type: str) -> bool:
+    """Whether a response body should be parsed as JSON based on its Content-Type.
+
+    Only genuine JSON media types are parsed (``application/json`` and structured
+    suffixes such as ``application/problem+json``). Anything else - including a
+    missing Content-Type - is treated as opaque content (a file download), so the
+    raw bytes are returned instead of being force-decoded as UTF-8/JSON. This mirrors
+    how the StackOne generated SDKs default unknown bodies to ``application/octet-stream``.
+    """
+    media_type = content_type.split(";", 1)[0].strip().lower()
+    return media_type == "application/json" or media_type.endswith("+json")
+
+
+def _filename_from_content_disposition(value: str | None) -> str | None:
+    """Extract the filename from a Content-Disposition header value, if present.
+
+    Handles both the plain ``filename="example.pdf"`` form and the RFC 5987 extended
+    ``filename*=UTF-8''example%20file.pdf`` form (which takes precedence when present).
+    The extended form is percent-decoded using its declared charset (RFC 5987 permits
+    both ``UTF-8`` and ``ISO-8859-1``); an unknown or empty charset falls back to UTF-8.
+    """
+    if not value:
+        return None
+    extended = re.search(r"filename\*\s*=\s*([^']*)'[^']*'([^;]+)", value, re.IGNORECASE)
+    if extended:
+        charset = extended.group(1).strip() or "utf-8"
+        encoded = extended.group(2).strip().strip('"')
+        try:
+            return unquote(encoded, encoding=charset, errors="replace") or None
+        except LookupError:
+            # Unrecognised charset label - decode as UTF-8 rather than failing.
+            return unquote(encoded, encoding="utf-8", errors="replace") or None
+    quoted = re.search(r'filename\s*=\s*"([^"]*)"', value, re.IGNORECASE)
+    if quoted:
+        return quoted.group(1).strip() or None
+    bare = re.search(r"filename\s*=\s*([^;]+)", value, re.IGNORECASE)
+    if bare:
+        return bare.group(1).strip().strip('"') or None
+    return None
+
+
 class ExecuteConfig(BaseModel):
     """Configuration for executing a tool against an API endpoint"""
 
@@ -206,7 +248,14 @@ class StackOneTool(BaseModel):
             options: Execution options (e.g. feedback metadata)
 
         Returns:
-            API response as dict
+            For JSON responses, the parsed API response as a dict.
+
+            For file downloads (any non-JSON Content-Type, e.g. a
+            ``documents_download_file`` action), a dict describing the file:
+            ``{"content": <bytes>, "content_type": str, "status_code": int,
+            "headers": dict, "file_name": str | None}``. Note ``content`` holds
+            the raw bytes and is therefore not JSON-serializable - callers that
+            re-serialize tool results (e.g. for an LLM) should handle this key.
 
         Raises:
             StackOneAPIError: If the API request fails
@@ -257,9 +306,23 @@ class StackOneTool(BaseModel):
             response_status = response.status_code
             response.raise_for_status()
 
-            result = response.json()
-            result_payload = cast(JsonDict, result) if isinstance(result, dict) else {"result": result}
-            return result_payload
+            content_type = response.headers.get("content-type", "")
+            if _is_json_content_type(content_type):
+                result = response.json()
+                result_payload = cast(JsonDict, result) if isinstance(result, dict) else {"result": result}
+                return result_payload
+
+            # Non-JSON bodies are file downloads (e.g. documents_download_file), which the
+            # API serves as raw binary with the file's own MIME type and a Content-Disposition
+            # header. Return the bytes plus metadata rather than forcing a JSON/UTF-8 decode.
+            # The shape mirrors the StackOne generated SDKs' download response.
+            return {
+                "content": response.content,
+                "content_type": content_type or "application/octet-stream",
+                "status_code": response.status_code,
+                "headers": dict(response.headers),
+                "file_name": _filename_from_content_disposition(response.headers.get("content-disposition")),
+            }
 
         except json.JSONDecodeError as exc:
             status = "error"

{stackone_ai-2.9.0 → stackone_ai-2.10.0}/stackone_ai/toolset.py

@@ -7,6 +7,7 @@ import fnmatch
 import json
 import logging
 import os
+import re
 import threading
 from collections.abc import Coroutine, Sequence
 from dataclasses import dataclass
@@ -92,6 +93,14 @@ _RPC_PARAMETER_LOCATIONS = {
 }
 _USER_AGENT = f"stackone-ai-python/{_SDK_VERSION}"
 
+# Param-style pinned on the /mcp tool-listing URL. The MCP schema and the RPC-execution unwrap
+# (_split_envelope_params) must agree on this, so it is pinned rather than following the server
+# default — the server default is free to change without breaking the SDK.
+_MCP_PARAM_STYLE = "flat_prefixed"
+
+# Matches a flat_prefixed envelope key: `<location>_<field>` (e.g. `path_id`, `query_limit`).
+_FLAT_ENVELOPE_KEY_PATTERN = re.compile(r"^(path|query|body|headers)_(.+)$")
+
 
 # --- Internal tool_search + tool_execute ---
 
@@ -444,24 +453,17 @@ class _StackOneRpcTool(StackOneTool):
     ) -> dict[str, Any]:
         parsed_arguments = self._parse_arguments(arguments)
 
-        body_payload = self._extract_record(parsed_arguments.pop("body", None))
-        headers_payload = self._extract_record(parsed_arguments.pop("headers", None))
-        path_payload = self._extract_record(parsed_arguments.pop("path", None))
-        query_payload = self._extract_record(parsed_arguments.pop("query", None))
-
-        rpc_body: dict[str, Any] = dict(body_payload or {})
-        for key, value in parsed_arguments.items():
-            rpc_body[key] = value
+        envelope = self._split_envelope_params(parsed_arguments)
 
         payload: dict[str, Any] = {
             "action": self.name,
-            "body": rpc_body,
-            "headers": self._build_action_headers(headers_payload),
+            "body": envelope["body"],
+            "headers": self._build_action_headers(envelope["headers"] or None),
         }
-        if path_payload:
-            payload["path"] = path_payload
-        if query_payload:
-            payload["query"] = query_payload
+        if envelope["path"]:
+            payload["path"] = envelope["path"]
+        if envelope["query"]:
+            payload["query"] = envelope["query"]
 
         return super().execute(payload, options=options)
 
@@ -477,10 +479,28 @@ class _StackOneRpcTool(StackOneTool):
         return dict(parsed)
 
     @staticmethod
-    def _extract_record(value: Any) -> dict[str, Any] | None:
-        if isinstance(value, dict):
-            return dict(value)
-        return None
+    def _split_envelope_params(params: dict[str, Any]) -> dict[str, dict[str, Any]]:
+        """Split LLM-supplied tool arguments into the RPC envelope (path/query/headers/body).
+
+        Tools are listed with ``?param-style=flat_prefixed``, so keys arrive as
+        ``<location>_<field>`` (for example ``path_id``, ``query_limit``). The prefix carries
+        the parameter location, so the split needs no per-action schema. A bare dict-valued
+        ``path``/``query``/``headers``/``body`` key is still bucketed for clients holding a
+        cached nested schema, and any other key falls through to the body.
+        """
+        buckets: dict[str, dict[str, Any]] = {"path": {}, "query": {}, "headers": {}, "body": {}}
+        for key, value in params.items():
+            match = _FLAT_ENVELOPE_KEY_PATTERN.match(key)
+            if match:
+                location, field = match.group(1), match.group(2)
+                buckets[location].setdefault(field, value)
+                continue
+            if key in ("path", "query", "headers", "body") and isinstance(value, dict):
+                for field, field_value in value.items():
+                    buckets[key].setdefault(field, field_value)
+                continue
+            buckets["body"][key] = value
+        return buckets
 
     def _build_action_headers(self, additional_headers: dict[str, Any] | None) -> dict[str, str]:
         headers: dict[str, str] = {}
@@ -645,13 +665,14 @@ class StackOneToolSet:
 
         Example::
 
-            toolset = StackOneToolSet()
+            toolset = StackOneToolSet(search={"method": "auto"})
             search_tool = toolset.get_search_tool()
             tools = search_tool("manage employee records", account_ids=["acc-123"])
         """
         if self._search_config is None:
             raise ToolsetConfigError(
-                "Search is disabled. Initialize StackOneToolSet with a search config to enable."
+                "Search is disabled. Pass search={} (or search={'method': 'auto'}) to "
+                "StackOneToolSet(...) to enable. See README 'Search Tool' for options."
             )
 
         config: SearchConfig = {**self._search_config}
@@ -664,7 +685,8 @@ class StackOneToolSet:
         """Build tool_search + tool_execute tools scoped to this toolset."""
         if self._search_config is None:
             raise ToolsetConfigError(
-                "Search is disabled. Initialize StackOneToolSet with a search config to enable."
+                "Search is disabled. Pass search={} (or search={'method': 'auto'}) to "
+                "StackOneToolSet(...) to enable. See README 'Search Tool' for options."
             )
 
         if account_ids:
@@ -713,8 +735,8 @@ class StackOneToolSet:
             toolset = StackOneToolSet()
             tools = toolset.openai()
 
-            # Meta tools for agent-driven discovery
-            toolset = StackOneToolSet()
+            # Meta tools for agent-driven discovery — search must be enabled
+            toolset = StackOneToolSet(search={"method": "auto"})
             tools = toolset.openai(mode="search_and_execute")
         """
         effective_account_ids = account_ids or (
@@ -783,7 +805,8 @@ class StackOneToolSet:
             tools = toolset.pydantic_ai()
             agent = Agent("openai:gpt-5.4", tools=tools)
 
-            # Meta tools for agent-driven discovery
+            # Meta tools for agent-driven discovery — search must be enabled
+            toolset = StackOneToolSet(search={"method": "auto"})
             tools = toolset.pydantic_ai(mode="search_and_execute")
         """
         effective_account_ids = account_ids or (
@@ -929,7 +952,8 @@ class StackOneToolSet:
         """
         if self._search_config is None:
             raise ToolsetConfigError(
-                "Search is disabled. Initialize StackOneToolSet with a search config to enable."
+                "Search is disabled. Pass search={} (or search={'method': 'auto'}) to "
+                "StackOneToolSet(...) to enable. See README 'Search Tool' for options."
             )
 
         # Merge constructor defaults with per-call overrides
@@ -1082,7 +1106,8 @@ class StackOneToolSet:
         """
         if self._search_config is None:
             raise ToolsetConfigError(
-                "Search is disabled. Initialize StackOneToolSet with search config to enable."
+                "Search is disabled. Pass search={} (or search={'method': 'auto'}) to "
+                "StackOneToolSet(...) to enable. See README 'Search Tool' for options."
             )
 
         # Merge constructor defaults with per-call overrides
@@ -1235,7 +1260,7 @@ class StackOneToolSet:
             if cached is not None:
                 return cached
 
-            endpoint = f"{self.base_url.rstrip('/')}/mcp"
+            endpoint = f"{self.base_url.rstrip('/')}/mcp?param-style={_MCP_PARAM_STYLE}"
 
             def _fetch_for_account(account: str | None) -> list[StackOneTool]:
                 headers = self._build_mcp_headers(account)

{stackone_ai-2.9.0 → stackone_ai-2.10.0}/tests/test_fetch_tools.py

@@ -662,3 +662,21 @@ class TestToolIndexCache:
         toolset.search_tools("bar")
 
         assert build_count["count"] == 2
+
+
+class TestMcpParamStylePinning:
+    """The /mcp listing URL must pin param-style so the schema matches the RPC unwrap."""
+
+    def test_fetch_tools_pins_flat_prefixed_param_style(self, monkeypatch):
+        captured: dict[str, str] = {}
+
+        def fake_fetch(endpoint: str, headers: dict[str, str]) -> list[_McpToolDefinition]:
+            captured["endpoint"] = endpoint
+            return []
+
+        monkeypatch.setattr("stackone_ai.toolset._fetch_mcp_tools", fake_fetch)
+
+        toolset = StackOneToolSet(api_key="test-key", base_url="https://api.example.com")
+        toolset.fetch_tools(account_ids=["acc1"])
+
+        assert captured["endpoint"] == "https://api.example.com/mcp?param-style=flat_prefixed"