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

glaip_sdk/mcps/base.py

@@ -0,0 +1,345 @@
+"""MCP (Model Context Protocol) helper for glaip_sdk.
+
+Provides a simple, migration-ready way to declare and resolve MCPs with
+in-memory caching and create-on-missing functionality.
+
+The MCP class also supports runtime operations (update, delete, get_tools)
+when retrieved from the API via client.mcps.get().
+
+Authors:
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
+
+Example - Lazy Reference:
+    >>> from glaip_sdk.mcps import MCP
+    >>>
+    >>> # Create from known ID
+    >>> mcp = MCP.from_id("mcp_abc123")
+    >>>
+    >>> # Create lookup-only by name (error if not found)
+    >>> mcp = MCP.from_native("arxiv-search")
+    >>>
+    >>> # Create for lookup/creation by name (create if missing)
+    >>> mcp = MCP(name="my-filesystem-mcp", transport="sse", config={"url": "..."})
+
+Example - Runtime Operations:
+    >>> from glaip_sdk import Glaip
+    >>>
+    >>> client = Glaip()
+    >>> mcp = client.mcps.get("mcp-123")
+    >>> tools = mcp.get_tools()  # Get tools from MCP
+    >>> mcp.update(description="Updated description")
+    >>> mcp.delete()
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from glaip_sdk.models import MCPResponse
+
+# Type alias for MCP configuration values
+MCPConfigValue = str | int | bool | list[str] | dict[str, str]
+
+_MCP_NOT_DEPLOYED_MSG = "MCP not available on platform. No ID set."
+_CLIENT_NOT_AVAILABLE_MSG = "Client not available. Use client.mcps.get() to get a client-connected MCP."
+
+
+class MCP:
+    """MCP reference helper for declaring MCPs in Agent definitions.
+
+    Supports both lazy references and runtime operations:
+    - Lazy reference: Created via from_native() or from_id()
+    - Runtime: Created via from_response() or client.mcps.get()
+
+    Attributes:
+        name: Human-readable MCP name (used for lookup/creation).
+        id: Backend MCP ID (used for direct fetch if known).
+        transport: Transport type (e.g., "sse", "stdio", "websocket").
+        config: Transport configuration dict (URLs, args, env vars).
+        description: Optional description for the MCP.
+        metadata: Optional additional metadata dict.
+        authentication: Authentication configuration.
+
+    Example - Lazy Reference:
+        >>> # Create from known ID
+        >>> mcp = MCP.from_id("mcp_abc123")
+        >>>
+        >>> # Create lookup-only by name (error if not found)
+        >>> mcp = MCP.from_native("arxiv-search")
+        >>>
+        >>> # Create for lookup/creation by name (create if missing)
+        >>> mcp = MCP(name="my-filesystem-mcp", transport="sse", config={"url": "..."})
+
+    Example - Runtime Operations:
+        >>> mcp = client.mcps.get("mcp-123")
+        >>> mcp.update(description="New description")
+        >>> mcp.delete()
+    """
+
+    def __init__(
+        self,
+        name: str | None = None,
+        *,
+        id: str | None = None,  # noqa: A002 - Allow shadowing builtin for API compat
+        transport: str | None = None,
+        config: dict[str, MCPConfigValue] | None = None,
+        description: str | None = None,
+        metadata: dict[str, Any] | None = None,
+        authentication: dict[str, Any] | None = None,
+        _lookup_only: bool = False,
+        _client: Any = None,
+    ) -> None:
+        """Initialize an MCP.
+
+        Args:
+            name: Human-readable MCP name.
+            id: Backend MCP ID.
+            transport: Transport type (e.g., "sse", "stdio").
+            config: Transport configuration dict.
+            description: Optional description.
+            metadata: Optional metadata dict.
+            authentication: Authentication configuration.
+            _lookup_only: If True, don't create if not found.
+            _client: Internal client reference.
+
+        Raises:
+            ValueError: If neither name nor id is provided.
+        """
+        if not name and not id:
+            raise ValueError("At least one of 'name' or 'id' must be provided")
+
+        self.name = name
+        self._id = id
+        self.transport = transport
+        self.config = config
+        self.description = description
+        self.metadata = metadata
+        self.authentication = authentication
+        self._lookup_only = _lookup_only
+        self._client = _client
+
+    @property
+    def id(self) -> str | None:  # noqa: A003 - Allow shadowing builtin for API compat
+        """MCP ID on the platform."""
+        return self._id
+
+    @id.setter
+    def id(self, value: str | None) -> None:  # noqa: A003
+        """Set the MCP ID."""
+        self._id = value
+
+    def __repr__(self) -> str:
+        """Return string representation."""
+        if self._id:
+            return f"MCP(id={self._id!r}, name={self.name!r})"
+        if self._lookup_only:
+            return f"MCP.from_native({self.name!r})"
+        return f"MCP(name={self.name!r})"
+
+    def __eq__(self, other: object) -> bool:
+        """Check equality based on id if available, else name."""
+        if not isinstance(other, MCP):
+            return NotImplemented
+        if self._id and other._id:
+            return self._id == other._id
+        return self.name == other.name
+
+    def __hash__(self) -> int:
+        """Hash based on id if available, else name."""
+        if self._id:
+            return hash(self._id)
+        return hash(self.name)
+
+    def model_dump(self, *, exclude_none: bool = False) -> dict[str, Any]:
+        """Return a dict representation of the MCP.
+
+        Provides Pydantic-style serialization for backward compatibility.
+
+        Args:
+            exclude_none: If True, exclude None values from the output.
+
+        Returns:
+            Dictionary containing MCP attributes.
+        """
+        data = {
+            "id": self._id,
+            "name": self.name,
+            "transport": self.transport,
+            "config": self.config,
+            "description": self.description,
+            "metadata": self.metadata,
+            "authentication": self.authentication,
+        }
+        if exclude_none:
+            return {k: v for k, v in data.items() if v is not None}
+        return data
+
+    @classmethod
+    def from_native(cls, name: str) -> MCP:
+        """Create a lookup-only MCP reference by name.
+
+        Use this when referencing an MCP that already exists on the platform.
+        Resolution will NOT create the MCP if not found - it will raise an error.
+
+        Args:
+            name: The name of the existing MCP.
+
+        Returns:
+            MCP instance configured for lookup-only resolution.
+
+        Raises:
+            ValueError: If name is empty.
+
+        Example:
+            >>> mcp = MCP.from_native("arxiv-search")
+            >>> # Registry will find by name, error if not found or ambiguous
+        """
+        if not name:
+            raise ValueError("Name cannot be empty")
+        return cls(name=name, _lookup_only=True)
+
+    @classmethod
+    def from_id(cls, mcp_id: str) -> MCP:
+        """Create an MCP helper for lookup-only by ID.
+
+        This creates a minimal MCP reference that will be resolved
+        from the backend using the ID. Use this when you know the
+        backend MCP ID but don't have the full configuration.
+
+        Args:
+            mcp_id: The backend MCP ID.
+
+        Returns:
+            An MCP instance with only the ID set, marked for lookup-only.
+
+        Raises:
+            ValueError: If mcp_id is empty.
+
+        Example:
+            >>> mcp = MCP.from_id("550e8400-e29b-41d4-a716-446655440000")
+            >>> # Registry will fetch directly by ID
+        """
+        if not mcp_id:
+            raise ValueError("ID cannot be empty")
+        return cls(id=mcp_id, _lookup_only=True)
+
+    # ─────────────────────────────────────────────────────────────────
+    # Runtime Methods (require client connection)
+    # ─────────────────────────────────────────────────────────────────
+
+    def _set_client(self, client: Any) -> MCP:
+        """Set the client reference for this MCP.
+
+        Args:
+            client: The Glaip client instance.
+
+        Returns:
+            Self for method chaining.
+        """
+        self._client = client
+        return self
+
+    def get_tools(self) -> list[dict[str, Any]]:
+        """Get tools available from this MCP.
+
+        Returns:
+            List of tool definitions from the MCP.
+
+        Raises:
+            ValueError: If the MCP has no ID.
+            RuntimeError: If client is not available.
+        """
+        if not self._id:
+            raise ValueError(_MCP_NOT_DEPLOYED_MSG)
+        if not self._client:
+            raise RuntimeError(_CLIENT_NOT_AVAILABLE_MSG)
+
+        # Delegate to the client's MCP tools endpoint
+        return self._client.mcps.get_tools(mcp_id=self._id)
+
+    def update(self, **kwargs: Any) -> MCP:
+        """Update the MCP with new configuration.
+
+        Args:
+            **kwargs: MCP properties to update (name, description, config, etc.).
+
+        Returns:
+            Self with updated properties.
+
+        Raises:
+            ValueError: If the MCP has no ID.
+            RuntimeError: If client is not available.
+        """
+        if not self._id:
+            raise ValueError(_MCP_NOT_DEPLOYED_MSG)
+        if not self._client:
+            raise RuntimeError(_CLIENT_NOT_AVAILABLE_MSG)
+
+        response = self._client.mcps.update(mcp_id=self._id, **kwargs)
+
+        # Update local properties from response
+        if hasattr(response, "name") and response.name:
+            self.name = response.name
+        if hasattr(response, "description"):
+            self.description = response.description
+        if hasattr(response, "config"):
+            self.config = response.config
+        if hasattr(response, "transport"):
+            self.transport = response.transport
+
+        return self
+
+    def delete(self) -> None:
+        """Delete the MCP from the platform.
+
+        Raises:
+            ValueError: If the MCP has no ID.
+            RuntimeError: If client is not available.
+        """
+        if not self._id:
+            raise ValueError(_MCP_NOT_DEPLOYED_MSG)
+        if not self._client:
+            raise RuntimeError(_CLIENT_NOT_AVAILABLE_MSG)
+
+        self._client.mcps.delete(mcp_id=self._id)
+        self._id = None
+        self._client = None
+
+    @classmethod
+    def from_response(
+        cls,
+        response: MCPResponse,
+        client: Any = None,
+    ) -> MCP:
+        """Create an MCP instance from an API response.
+
+        This allows you to work with MCPs retrieved from the API
+        as full MCP instances with all methods available.
+
+        Args:
+            response: The MCPResponse from an API call.
+            client: The Glaip client instance for API operations.
+
+        Returns:
+            An MCP instance initialized from the response.
+
+        Example:
+            >>> response = client.mcps.get("mcp-123")
+            >>> mcp = MCP.from_response(response, client)
+            >>> tools = mcp.get_tools()
+        """
+        mcp = cls(
+            name=response.name,
+            id=response.id,
+            description=getattr(response, "description", None),
+            transport=getattr(response, "transport", None),
+            config=getattr(response, "config", None),
+            metadata=getattr(response, "metadata", None),
+            authentication=getattr(response, "authentication", None),
+        )
+
+        if client:
+            mcp._set_client(client)
+
+        return mcp

glaip_sdk/models/__init__.py

@@ -0,0 +1,90 @@
+"""Models package for AIP SDK.
+
+This package provides Pydantic models for API responses.
+
+For the public runtime API with methods like run(), deploy(), update(), delete():
+- glaip_sdk.agents.Agent
+- glaip_sdk.tools.Tool
+- glaip_sdk.mcps.MCP
+
+The Agent, Tool, and MCP exports from this module are DEPRECATED.
+They redirect to glaip_sdk.agents.Agent, glaip_sdk.tools.Tool, glaip_sdk.mcps.MCP
+respectively with deprecation warnings.
+
+Authors:
+    Raymond Christopher (raymond.christopher@gdplabs.id)
+"""
+
+import warnings
+
+# Pure Pydantic models for API responses (no runtime methods)
+from glaip_sdk.models.agent import AgentResponse
+from glaip_sdk.models.agent_runs import (
+    RunOutputChunk,
+    RunsPage,
+    RunSummary,
+    RunWithOutput,
+)
+from glaip_sdk.models.common import LanguageModelResponse, TTYRenderer
+from glaip_sdk.models.mcp import MCPResponse
+from glaip_sdk.models.tool import ToolResponse
+
+
+def __getattr__(name: str) -> type:
+    """Deprecation warnings for backward compatibility."""
+    if name == "Agent":
+        warnings.warn(
+            "Importing Agent from glaip_sdk.models is deprecated. "
+            "Use 'from glaip_sdk.agents import Agent' instead. "
+            "This will be removed in v1.0.0",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        from glaip_sdk.agents import Agent  # noqa: PLC0415
+
+        return Agent
+
+    if name == "Tool":
+        warnings.warn(
+            "Importing Tool from glaip_sdk.models is deprecated. "
+            "Use 'from glaip_sdk.tools import Tool' instead. "
+            "This will be removed in v1.0.0",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        from glaip_sdk.tools import Tool  # noqa: PLC0415
+
+        return Tool
+
+    if name == "MCP":
+        warnings.warn(
+            "Importing MCP from glaip_sdk.models is deprecated. "
+            "Use 'from glaip_sdk.mcps import MCP' instead. "
+            "This will be removed in v1.0.0",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        from glaip_sdk.mcps import MCP  # noqa: PLC0415
+
+        return MCP
+
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+__all__ = [
+    # Pure Pydantic response models (recommended for type hints)
+    "AgentResponse",
+    "ToolResponse",
+    "MCPResponse",
+    # Deprecated aliases (redirect to runtime classes with warning)
+    "Agent",
+    "Tool",
+    "MCP",
+    # Other models
+    "LanguageModelResponse",
+    "TTYRenderer",
+    "RunSummary",
+    "RunsPage",
+    "RunWithOutput",
+    "RunOutputChunk",
+]

glaip_sdk/models/agent.py

@@ -0,0 +1,47 @@
+"""Agent response model for AIP SDK.
+
+This module contains the Pydantic model for Agent API responses.
+This is a pure data model with no runtime behavior.
+
+For the runtime Agent class with deploy/run methods, use glaip_sdk.agents.Agent.
+
+Authors:
+    Raymond Christopher (raymond.christopher@gdplabs.id)
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
+"""
+
+from datetime import datetime
+from typing import Any
+
+from glaip_sdk.config.constants import DEFAULT_AGENT_RUN_TIMEOUT
+from pydantic import BaseModel
+
+
+class AgentResponse(BaseModel):
+    """Pydantic model for Agent API responses.
+
+    This is a pure data model for deserializing API responses.
+    It does NOT have runtime methods (run, update, delete).
+
+    For the runtime Agent class, use glaip_sdk.agents.Agent.
+    """
+
+    id: str
+    name: str
+    instruction: str | None = None
+    description: str | None = None
+    type: str | None = None
+    framework: str | None = None
+    version: str | None = None
+    tools: list[dict[str, Any]] | None = None
+    agents: list[dict[str, Any]] | None = None
+    mcps: list[dict[str, Any]] | None = None
+    tool_configs: dict[str, Any] | None = None
+    mcp_configs: dict[str, Any] | None = None
+    agent_config: dict[str, Any] | None = None
+    timeout: int = DEFAULT_AGENT_RUN_TIMEOUT
+    metadata: dict[str, Any] | None = None
+    language_model_id: str | None = None
+    a2a_profile: dict[str, Any] | None = None
+    created_at: datetime | None = None
+    updated_at: datetime | None = None

glaip_sdk/models/agent_runs.py

@@ -0,0 +1,116 @@
+#!/usr/bin/env python3
+"""Agent run models for AIP SDK.
+
+Authors:
+    Raymond Christopher (raymond.christopher@gdplabs.id)
+"""
+
+from datetime import datetime, timedelta
+from typing import Any, Literal
+from uuid import UUID
+
+from pydantic import BaseModel, Field, field_validator, model_validator
+
+# Type alias for SSE event dictionaries
+RunOutputChunk = dict[str, Any]
+
+
+class RunSummary(BaseModel):
+    """Represents a single agent run in list/table views with metadata only."""
+
+    id: UUID
+    agent_id: UUID
+    run_type: Literal["manual", "schedule"]
+    schedule_id: UUID | None = None
+    status: Literal["started", "success", "failed", "cancelled", "aborted", "unavailable"]
+    started_at: datetime
+    completed_at: datetime | None = None
+    input: str | None = None
+    config: dict[str, Any] | None = None
+    created_at: datetime
+    updated_at: datetime
+
+    @field_validator("completed_at")
+    @classmethod
+    def validate_completed_after_started(cls, v: datetime | None, info) -> datetime | None:
+        """Validate that completed_at is after started_at if present."""
+        if v is not None and "started_at" in info.data:
+            started_at = info.data["started_at"]
+            if v < started_at:
+                raise ValueError("completed_at must be after started_at")
+        return v
+
+    def duration(self) -> timedelta | None:
+        """Calculate duration from started_at to completed_at.
+
+        Returns:
+            Duration as timedelta if completed_at exists, None otherwise
+        """
+        if self.completed_at is not None:
+            return self.completed_at - self.started_at
+        return None
+
+    def duration_formatted(self) -> str:
+        """Format duration as HH:MM:SS string.
+
+        Returns:
+            Formatted duration string or "—" if not completed
+        """
+        duration = self.duration()
+        if duration is None:
+            return "—"
+        total_seconds = int(duration.total_seconds())
+        hours = total_seconds // 3600
+        minutes = (total_seconds % 3600) // 60
+        seconds = total_seconds % 60
+        return f"{hours:02d}:{minutes:02d}:{seconds:02d}"
+
+    def input_preview(self, max_length: int = 120) -> str:
+        """Generate truncated input preview for table display.
+
+        Args:
+            max_length: Maximum length of preview string
+
+        Returns:
+            Truncated input string or "—" if input is None or empty
+        """
+        if not self.input:
+            return "—"
+        # Strip newlines and collapse whitespace
+        preview = " ".join(self.input.split())
+        if len(preview) > max_length:
+            return preview[:max_length] + "…"
+        return preview
+
+
+class RunsPage(BaseModel):
+    """Represents a paginated collection of run summaries from the list endpoint."""
+
+    data: list[RunSummary]
+    total: int = Field(ge=0)
+    page: int = Field(ge=1)
+    limit: int = Field(ge=1, le=100)
+    has_next: bool
+    has_prev: bool
+
+    @model_validator(mode="after")
+    def validate_pagination_consistency(self) -> "RunsPage":
+        """Validate pagination consistency."""
+        # If has_next is True, then page * limit < total
+        if self.has_next and self.page * self.limit >= self.total:
+            raise ValueError("has_next inconsistency: page * limit must be < total when has_next is True")
+        return self
+
+
+class RunWithOutput(RunSummary):
+    """Extends RunSummary with the complete SSE event stream for detailed viewing."""
+
+    output: list[RunOutputChunk] = Field(default_factory=list)
+
+    @field_validator("output", mode="before")
+    @classmethod
+    def normalize_output(cls, v: Any) -> list[RunOutputChunk]:
+        """Normalize output field to empty list when null."""
+        if v is None:
+            return []
+        return v

glaip_sdk/models/common.py

@@ -0,0 +1,42 @@
+"""Common models for AIP SDK.
+
+This module contains common models that don't fit into specific categories.
+
+Authors:
+    Raymond Christopher (raymond.christopher@gdplabs.id)
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
+"""
+
+from pydantic import BaseModel
+
+
+class LanguageModelResponse(BaseModel):
+    """Language model response model."""
+
+    name: str
+    provider: str
+    description: str | None = None
+    capabilities: list[str] | None = None
+    max_tokens: int | None = None
+    supports_streaming: bool = False
+
+
+class TTYRenderer:
+    """Simple TTY renderer for non-Rich environments."""
+
+    def __init__(self, use_color: bool = True):
+        """Initialize the TTY renderer.
+
+        Args:
+            use_color: Whether to use color output
+        """
+        self.use_color = use_color
+
+    def render_message(self, message: str, event_type: str = "message") -> None:
+        """Render a message with optional color."""
+        if event_type == "error":
+            print(f"ERROR: {message}", flush=True)
+        elif event_type == "done":
+            print(f"\n✅ {message}", flush=True)
+        else:
+            print(message, flush=True)

glaip_sdk/models/mcp.py

@@ -0,0 +1,33 @@
+"""MCP response model for AIP SDK.
+
+This module contains the Pydantic model for MCP API responses.
+This is a pure data model with no runtime behavior.
+
+For the runtime MCP class with update/delete methods, use glaip_sdk.mcps.MCP.
+
+Authors:
+    Raymond Christopher (raymond.christopher@gdplabs.id)
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
+"""
+
+from typing import Any
+
+from pydantic import BaseModel
+
+
+class MCPResponse(BaseModel):
+    """Pydantic model for MCP API responses.
+
+    This is a pure data model for deserializing API responses.
+    It does NOT have runtime methods (update, delete, get_tools).
+
+    For the runtime MCP class, use glaip_sdk.mcps.MCP.
+    """
+
+    id: str
+    name: str
+    description: str | None = None
+    config: dict[str, Any] | None = None
+    transport: str | None = None  # "sse" or "http"
+    authentication: dict[str, Any] | None = None
+    metadata: dict[str, Any] | None = None