glaip-sdk 0.0.20__py3-none-any.whl → 0.7.7__py3-none-any.whl

glaip_sdk/client/base.py

@@ -3,10 +3,12 @@
 
 Authors:
     Raymond Christopher (raymond.christopher@gdplabs.id)
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
 """
 
 import logging
 import os
+from collections.abc import Iterable, Mapping
 from typing import Any, NoReturn, Union
 
 import httpx
@@ -151,12 +153,7 @@ class BaseClient:
     def timeout(self, value: float) -> None:
         """Set timeout and rebuild client."""
         self._timeout = value
-        if (
-            hasattr(self, "http_client")
-            and self.http_client
-            and not self._session_scoped
-            and not self._parent_client
-        ):
+        if hasattr(self, "http_client") and self.http_client and not self._session_scoped and not self._parent_client:
             self.http_client.close()
             self.http_client = self._build_client(value)
 
@@ -246,18 +243,14 @@ class BaseClient:
             client_log.debug(f"Response status: {response.status_code}")
             return response
         except httpx.ConnectError as e:
-            client_log.warning(
-                f"Connection error on {method} {endpoint}, retrying once: {e}"
-            )
+            client_log.warning(f"Connection error on {method} {endpoint}, retrying once: {e}")
             try:
                 response = self.http_client.request(method, endpoint, **kwargs)
-                client_log.debug(
-                    f"Retry successful, response status: {response.status_code}"
-                )
+                client_log.debug(f"Retry successful, response status: {response.status_code}")
                 return response
             except httpx.ConnectError:
                 client_log.error(f"Retry failed for {method} {endpoint}: {e}")
-                raise e
+                raise
 
     def _request(self, method: str, endpoint: str, **kwargs) -> Any:
         """Make HTTP request with error handling and unwrap success envelopes."""
@@ -298,7 +291,7 @@ class BaseClient:
                 return parsed.get("data", parsed) if unwrap else parsed
             else:
                 error_type = parsed.get("error", "UnknownError")
-                message = parsed.get("message", DEFAULT_ERROR_MESSAGE)
+                message = self._format_error_dict({key: value for key, value in parsed.items() if key != "success"})
                 self._raise_api_error(
                     400,
                     message,
@@ -341,12 +334,58 @@ class BaseClient:
                 return validation_message
             return f"Validation error: {parsed}"
 
+        formatted_details = None
+        if "details" in parsed:
+            formatted_details = self._format_error_details(parsed["details"])
+
         message = parsed.get("message")
         if message:
+            if formatted_details:
+                return f"{message}\n{formatted_details}"
             return message
 
+        if formatted_details:
+            return formatted_details
+
         return str(parsed) if parsed else DEFAULT_ERROR_MESSAGE
 
+    def _format_error_details(self, details: Any) -> str | None:
+        """Render generic error details into a human-readable string."""
+        if details is None:
+            return None
+
+        if isinstance(details, dict):
+            return self._format_detail_mapping(details)
+
+        if isinstance(details, (list, tuple, set)):
+            return self._format_detail_iterable(details)
+
+        return f"Details: {details}"
+
+    @staticmethod
+    def _format_detail_mapping(details: Mapping[str, Any]) -> str | None:
+        """Format details provided as a mapping."""
+        entries = [f"  {key}: {value}" for key, value in details.items()]
+        if not entries:
+            return None
+        return "Details:\n" + "\n".join(entries)
+
+    @staticmethod
+    def _format_detail_iterable(details: Iterable[Any]) -> str | None:
+        """Format details provided as an iterable collection."""
+        entries: list[str] = []
+        for item in details:
+            if isinstance(item, Mapping):
+                inner = ", ".join(f"{k}={v}" for k, v in item.items())
+                entries.append(f"  - {inner if inner else '{}'}")
+            else:
+                entries.append(f"  - {item}")
+
+        if not entries:
+            return None
+
+        return "Details:\n" + "\n".join(entries)
+
     def _format_validation_errors(self, errors: list[Any]) -> str | None:
         """Render validation errors into a human-readable string."""
         entries: list[str] = []
@@ -365,6 +404,22 @@ class BaseClient:
 
         return "Validation errors:\n" + "\n".join(entries)
 
+    @staticmethod
+    def _is_no_content_response(response: httpx.Response) -> bool:
+        """Return True when the response contains no content."""
+        return response.status_code == 204
+
+    @staticmethod
+    def _is_success_status(response: httpx.Response) -> bool:
+        """Return True for successful HTTP status codes."""
+        return 200 <= response.status_code < 300
+
+    def _handle_error_response(self, response: httpx.Response) -> None:
+        """Raise an API error for non-success responses."""
+        error_message = self._get_error_message(response)
+        parsed_content = self._parse_response_content(response)
+        self._raise_api_error(response.status_code, error_message, payload=parsed_content)
+
     def _handle_response(
         self,
         response: httpx.Response,
@@ -373,24 +428,17 @@ class BaseClient:
     ) -> Any:
         """Handle HTTP response with proper error handling."""
         # Handle no-content success before general error handling
-        if response.status_code == 204:
+        if self._is_no_content_response(response):
             return None
 
-        # Handle error status codes
-        if not (200 <= response.status_code < 300):
-            error_message = self._get_error_message(response)
-            # Try to parse response content for payload
-            parsed_content = self._parse_response_content(response)
-            self._raise_api_error(
-                response.status_code, error_message, payload=parsed_content
-            )
-            return None  # Won't be reached but helps with type checking
-
-        parsed = self._parse_response_content(response)
-        if parsed is None:
-            return None
+        if self._is_success_status(response):
+            parsed = self._parse_response_content(response)
+            if parsed is None:
+                return None
+            return self._handle_success_response(parsed, unwrap=unwrap)
 
-        return self._handle_success_response(parsed, unwrap=unwrap)
+        self._handle_error_response(response)
+        return None
 
     def _raise_api_error(
         self,
@@ -435,12 +483,7 @@ class BaseClient:
 
     def close(self) -> None:
         """Close the HTTP client."""
-        if (
-            hasattr(self, "http_client")
-            and self.http_client
-            and not self._session_scoped
-            and not self._parent_client
-        ):
+        if hasattr(self, "http_client") and self.http_client and not self._session_scoped and not self._parent_client:
             self.http_client.close()
 
     def __enter__(self) -> "BaseClient":

glaip_sdk/client/hitl.py

@@ -0,0 +1,136 @@
+#!/usr/bin/env python3
+"""HITL REST client for manual approval operations.
+
+Authors:
+    GLAIP SDK Team
+"""
+
+from typing import Any
+
+from glaip_sdk.client.base import BaseClient
+from glaip_sdk.hitl.base import HITLDecision
+
+
+class HITLClient(BaseClient):
+    """Client for HITL REST endpoints.
+
+    Use for manual approval workflows separate from agent runs.
+
+    Example:
+        >>> # List pending approvals
+        >>> pending = client.hitl.list_pending()
+        >>>
+        >>> # Approve a request
+        >>> client.hitl.approve(
+        ...     request_id="bc4d0a77-7800-470e-a91c-7fd663a66b4d",
+        ...     operator_input="Verified and approved",
+        ... )
+    """
+
+    def approve(
+        self,
+        request_id: str,
+        operator_input: str | None = None,
+        run_id: str | None = None,
+    ) -> dict[str, Any]:
+        """Approve a HITL request.
+
+        Args:
+            request_id: HITL request ID from SSE stream
+            operator_input: Optional notes/reason for approval
+            run_id: Optional client-side run correlation ID
+
+        Returns:
+            Response dict: {"status": "ok", "message": "..."}
+        """
+        return self._post_decision(
+            request_id,
+            HITLDecision.APPROVED,
+            operator_input,
+            run_id,
+        )
+
+    def reject(
+        self,
+        request_id: str,
+        operator_input: str | None = None,
+        run_id: str | None = None,
+    ) -> dict[str, Any]:
+        """Reject a HITL request.
+
+        Args:
+            request_id: HITL request ID
+            operator_input: Optional reason for rejection
+            run_id: Optional run correlation ID
+
+        Returns:
+            Response dict
+        """
+        return self._post_decision(
+            request_id,
+            HITLDecision.REJECTED,
+            operator_input,
+            run_id,
+        )
+
+    def skip(
+        self,
+        request_id: str,
+        operator_input: str | None = None,
+        run_id: str | None = None,
+    ) -> dict[str, Any]:
+        """Skip a HITL request.
+
+        Args:
+            request_id: HITL request ID
+            operator_input: Optional notes
+            run_id: Optional run correlation ID
+
+        Returns:
+            Response dict
+        """
+        return self._post_decision(
+            request_id,
+            HITLDecision.SKIPPED,
+            operator_input,
+            run_id,
+        )
+
+    def _post_decision(
+        self,
+        request_id: str,
+        decision: HITLDecision,
+        operator_input: str | None,
+        run_id: str | None,
+    ) -> dict[str, Any]:
+        """Post HITL decision to backend."""
+        payload = {
+            "request_id": request_id,
+            "decision": decision.value,
+        }
+
+        if operator_input:
+            payload["operator_input"] = operator_input
+        if run_id:
+            payload["run_id"] = run_id
+
+        return self._request("POST", "/agents/hitl/decision", json=payload)
+
+    def list_pending(self) -> list[dict[str, Any]]:
+        """List all pending HITL requests.
+
+        Returns:
+            List of pending request dicts with metadata:
+            [
+                {
+                    "request_id": "...",
+                    "tool": "...",
+                    "arguments": {...},
+                    "created_at": "...",
+                    "agent_id": "...",
+                    "hitl_metadata": {...},
+                },
+                ...
+            ]
+        """
+        return self._request("GET", "/agents/hitl/pending")

glaip_sdk/client/main.py

@@ -3,15 +3,26 @@
 
 Authors:
     Raymond Christopher (raymond.christopher@gdplabs.id)
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
 """
 
-from typing import Any
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
 
 from glaip_sdk.client.agents import AgentClient
 from glaip_sdk.client.base import BaseClient
+from glaip_sdk.client.hitl import HITLClient
 from glaip_sdk.client.mcps import MCPClient
+from glaip_sdk.client.schedules import ScheduleClient
+from glaip_sdk.client.shared import build_shared_config
 from glaip_sdk.client.tools import ToolClient
-from glaip_sdk.models import MCP, Agent, Tool
+
+if TYPE_CHECKING:  # pragma: no cover
+    from glaip_sdk.agents import Agent
+    from glaip_sdk.client.payloads.agent import AgentListResult
+    from glaip_sdk.mcps import MCP
+    from glaip_sdk.tools import Tool
 
 
 class Client(BaseClient):
@@ -25,15 +36,12 @@ class Client(BaseClient):
         """
         super().__init__(**kwargs)
         # Share the single httpx.Client + config with sub-clients
-        shared_config = {
-            "parent_client": self,
-            "api_url": self.api_url,
-            "api_key": self.api_key,
-            "timeout": self._timeout,
-        }
+        shared_config = build_shared_config(self)
         self.agents = AgentClient(**shared_config)
         self.tools = ToolClient(**shared_config)
         self.mcps = MCPClient(**shared_config)
+        self.schedules = ScheduleClient(**shared_config)
+        self.hitl = HITLClient(**shared_config)
 
     # ---- Core API Methods (Public Interface) ----
 
@@ -53,7 +61,7 @@ class Client(BaseClient):
         name: str | None = None,
         version: str | None = None,
         sync_langflow_agents: bool = False,
-    ) -> list[Agent]:
+    ) -> AgentListResult:
         """List agents with optional filtering.
 
         Args:
@@ -64,7 +72,7 @@ class Client(BaseClient):
             sync_langflow_agents: Sync with LangFlow server before listing (only applies when agent_type=langflow)
 
         Returns:
-            List of agents matching the filters
+            AgentListResult with agents and pagination metadata. Supports iteration and indexing.
         """
         return self.agents.list_agents(
             agent_type=agent_type,
@@ -217,6 +225,11 @@ class Client(BaseClient):
 
     @timeout.setter
     def timeout(self, value: float) -> None:  # type: ignore[override]
+        """Set the client timeout and propagate to sub-clients.
+
+        Args:
+            value: Timeout value in seconds.
+        """
         # Rebuild the root http client
         BaseClient.timeout.fset(self, value)  # call parent setter
         # Propagate the new session to sub-clients so they don't hold a closed client
@@ -227,6 +240,8 @@ class Client(BaseClient):
                 self.tools.http_client = self.http_client
             if hasattr(self, "mcps"):
                 self.mcps.http_client = self.http_client
+            if hasattr(self, "schedules"):
+                self.schedules.http_client = self.http_client
         except Exception:
             pass
 

glaip_sdk/client/mcps.py

@@ -3,18 +3,22 @@
 
 Authors:
     Raymond Christopher (raymond.christopher@gdplabs.id)
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
 """
 
 import logging
 from typing import Any
 
 from glaip_sdk.client.base import BaseClient
-from glaip_sdk.config.constants import (
-    DEFAULT_MCP_TRANSPORT,
-    DEFAULT_MCP_TYPE,
+from glaip_sdk.config.constants import DEFAULT_MCP_TRANSPORT, DEFAULT_MCP_TYPE
+from glaip_sdk.mcps import MCP
+from glaip_sdk.models import MCPResponse
+from glaip_sdk.utils.client_utils import (
+    add_kwargs_to_payload,
+    create_model_instances,
+    find_by_name,
 )
-from glaip_sdk.models import MCP
-from glaip_sdk.utils.client_utils import create_model_instances, find_by_name
+from glaip_sdk.utils.resource_refs import is_uuid
 
 # API endpoints
 MCPS_ENDPOINT = "/mcps/"
@@ -45,7 +49,8 @@ class MCPClient(BaseClient):
     def get_mcp_by_id(self, mcp_id: str) -> MCP:
         """Get MCP by ID."""
         data = self._request("GET", f"{MCPS_ENDPOINT}{mcp_id}")
-        return MCP(**data)._set_client(self)
+        response = MCPResponse(**data)
+        return MCP.from_response(response, client=self)
 
     def find_mcps(self, name: str | None = None) -> list[MCP]:
         """Find MCPs by name."""
@@ -77,34 +82,156 @@ class MCPClient(BaseClient):
             get_endpoint_fmt=f"{MCPS_ENDPOINT}{{id}}",
             json=payload,
         )
-        return MCP(**full_mcp_data)._set_client(self)
+        response = MCPResponse(**full_mcp_data)
+        return MCP.from_response(response, client=self)
 
-    def update_mcp(self, mcp_id: str, **kwargs) -> MCP:
+    def update_mcp(self, mcp_id: str | MCP, **kwargs) -> MCP:
         """Update an existing MCP.
 
-        Automatically chooses between PUT (full update) and PATCH (partial update)
-        based on the provided fields:
-        - Uses PUT if name, config, and transport are all provided (full update)
-        - Uses PATCH otherwise (partial update)
+        Notes:
+            - Payload construction is centralized via ``_build_update_payload`` so required
+              defaults (e.g., ``type``) and value normalization stay consistent across SDK and CLI.
+            - For backward compatibility, still chooses PATCH vs PUT based on which fields the
+              caller provided, but uses the SDK payload builder for the final payload.
         """
-        # Check if all required fields for full update are provided
+        # Backward-compatible: allow passing an MCP instance to avoid an extra fetch.
+        if isinstance(mcp_id, MCP):
+            current_mcp = mcp_id
+            if not current_mcp.id:
+                raise ValueError("MCP instance has no id; cannot update.")
+            mcp_id_value = str(current_mcp.id)
+        else:
+            current_mcp = None
+            mcp_id_value = mcp_id
+
         required_fields = {"name", "config", "transport"}
         provided_fields = set(kwargs.keys())
+        method = "PUT" if required_fields.issubset(provided_fields) else "PATCH"
+
+        if not kwargs:
+            data = self._request(method, f"{MCPS_ENDPOINT}{mcp_id_value}", json={})
+            response = MCPResponse(**data)
+            return MCP.from_response(response, client=self)
+
+        if current_mcp is None:
+            current_mcp = self.get_mcp_by_id(mcp_id_value)
+
+        payload_kwargs = kwargs.copy()
+        name = payload_kwargs.pop("name", None)
+        description = payload_kwargs.pop("description", None)
+        full_payload = self._build_update_payload(
+            current_mcp=current_mcp,
+            name=name,
+            description=description,
+            **payload_kwargs,
+        )
 
-        if required_fields.issubset(provided_fields):
-            # All required fields provided - use full update (PUT)
-            method = "PUT"
+        if method == "PUT":
+            json_payload = full_payload
         else:
-            # Partial update - use PATCH
-            method = "PATCH"
+            json_payload = {key: full_payload[key] for key in provided_fields if key in full_payload}
+            json_payload["type"] = full_payload["type"]
+            if "config" in provided_fields and "transport" not in provided_fields and "transport" in full_payload:
+                json_payload["transport"] = full_payload["transport"]
 
-        data = self._request(method, f"{MCPS_ENDPOINT}{mcp_id}", json=kwargs)
-        return MCP(**data)._set_client(self)
+        data = self._request(method, f"{MCPS_ENDPOINT}{mcp_id_value}", json=json_payload)
+        response = MCPResponse(**data)
+        return MCP.from_response(response, client=self)
 
     def delete_mcp(self, mcp_id: str) -> None:
         """Delete an MCP."""
         self._request("DELETE", f"{MCPS_ENDPOINT}{mcp_id}")
 
+    def upsert_mcp(
+        self,
+        identifier: str | MCP,
+        description: str | None = None,
+        config: dict[str, Any] | None = None,
+        **kwargs,
+    ) -> MCP:
+        """Create or update an MCP by instance, ID, or name.
+
+        Args:
+            identifier: MCP instance, ID (UUID string), or name
+            description: MCP description
+            config: MCP configuration dictionary
+            **kwargs: Additional parameters (transport, metadata, etc.)
+
+        Returns:
+            The created or updated MCP.
+
+        Example:
+            >>> # By name (creates if not exists)
+            >>> mcp = client.mcps.upsert_mcp(
+            ...     "deepwiki",
+            ...     transport="sse",
+            ...     config={"url": "https://mcp.deepwiki.com/sse"},
+            ... )
+            >>> # By instance
+            >>> mcp = client.mcps.upsert_mcp(existing_mcp, description="Updated")
+            >>> # By ID
+            >>> mcp = client.mcps.upsert_mcp("uuid-here", description="Updated")
+        """
+        # Handle MCP instance
+        if isinstance(identifier, MCP):
+            if identifier.id:
+                logger.info("Updating MCP by instance: %s", identifier.name)
+                return self._do_upsert_update(identifier.id, identifier.name, description, config, **kwargs)
+            # MCP without ID - treat name as identifier
+            identifier = identifier.name
+
+        # Handle string (ID or name)
+        if isinstance(identifier, str):
+            if is_uuid(identifier):
+                logger.info("Updating MCP by ID: %s", identifier)
+                existing = self.get_mcp_by_id(identifier)
+                return self._do_upsert_update(identifier, existing.name, description, config, **kwargs)
+
+            # It's a name - find or create
+            return self._upsert_by_name(identifier, description, config, **kwargs)
+
+        raise ValueError(f"Invalid identifier type: {type(identifier)}")
+
+    def _do_upsert_update(
+        self,
+        mcp_id: str,
+        name: str | None,
+        description: str | None,
+        config: dict[str, Any] | None,
+        **kwargs,
+    ) -> MCP:
+        """Perform the update part of upsert."""
+        update_kwargs = {**kwargs}
+        if name is not None:
+            update_kwargs["name"] = name
+        if description is not None:
+            update_kwargs["description"] = description
+        if config is not None:
+            update_kwargs["config"] = config
+        return self.update_mcp(mcp_id, **update_kwargs)
+
+    def _upsert_by_name(
+        self,
+        name: str,
+        description: str | None,
+        config: dict[str, Any] | None,
+        **kwargs,
+    ) -> MCP:
+        """Find by name and update, or create if not found."""
+        all_mcps = self.list_mcps()
+        existing = [mcp for mcp in all_mcps if mcp.name.lower() == name.lower()]
+
+        if len(existing) == 1:
+            logger.info("Updating existing MCP: %s", name)
+            return self._do_upsert_update(existing[0].id, name, description, config, **kwargs)
+
+        if len(existing) > 1:
+            raise ValueError(f"Multiple MCPs found with name '{name}'")
+
+        # Create new MCP
+        logger.info("Creating new MCP: %s", name)
+        return self.create_mcp(name=name, description=description, config=config, **kwargs)
+
     def _build_create_payload(
         self,
         name: str,
@@ -147,9 +274,7 @@ class MCPClient(BaseClient):
 
         # Add any other kwargs (excluding already handled ones)
         excluded_keys = {"type"}  # type is handled above
-        for key, value in kwargs.items():
-            if key not in excluded_keys:
-                payload[key] = value
+        add_kwargs_to_payload(payload, kwargs, excluded_keys)
 
         return payload
 
@@ -179,9 +304,7 @@ class MCPClient(BaseClient):
         update_data = {
             "name": name if name is not None else current_mcp.name,
             "type": DEFAULT_MCP_TYPE,  # Required by backend, MCPs are always server type
-            "transport": kwargs.get(
-                "transport", getattr(current_mcp, "transport", DEFAULT_MCP_TRANSPORT)
-            ),
+            "transport": kwargs.get("transport", getattr(current_mcp, "transport", DEFAULT_MCP_TRANSPORT)),
         }
 
         # Handle description with proper None handling
@@ -208,7 +331,23 @@ class MCPClient(BaseClient):
     def get_mcp_tools(self, mcp_id: str) -> list[dict[str, Any]]:
         """Get tools available from an MCP."""
         data = self._request("GET", f"{MCPS_ENDPOINT}{mcp_id}/tools")
-        return data or []
+        if data is None:
+            return []
+        if isinstance(data, list):
+            return data
+        if isinstance(data, dict):
+            if "tools" in data:
+                return data.get("tools", []) or []
+            logger.warning(
+                "Unexpected MCP tools response keys %s; returning empty list",
+                list(data.keys()),
+            )
+            return []
+        logger.warning(
+            "Unexpected MCP tools response type %s; returning empty list",
+            type(data).__name__,
+        )
+        return []
 
     def test_mcp_connection(self, config: dict[str, Any]) -> dict[str, Any]:
         """Test MCP connection using configuration.

glaip_sdk/client/payloads/agent/__init__.py

@@ -0,0 +1,23 @@
+"""Agent payload types for requests and responses.
+
+Authors:
+    Raymond Christopher (raymond.christopher@gdplabs.id)
+"""
+
+from glaip_sdk.client.payloads.agent.requests import (
+    AgentCreateRequest,
+    AgentListParams,
+    AgentUpdateRequest,
+    merge_payload_fields,
+    resolve_language_model_fields,
+)
+from glaip_sdk.client.payloads.agent.responses import AgentListResult
+
+__all__ = [
+    "AgentCreateRequest",
+    "AgentListParams",
+    "AgentListResult",
+    "AgentUpdateRequest",
+    "merge_payload_fields",
+    "resolve_language_model_fields",
+]