Class CanvasDeclaration

python/copilot/canvas.py:70–104

Declarative metadata for a single canvas, sent on create/resume. .. note:: **Experimental.** This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

@dataclass
class CanvasDeclaration:
    """Declarative metadata for a single canvas, sent on create/resume.

    .. note::

        **Experimental.** This type is part of an experimental wire-protocol
        surface and may change or be removed in future SDK or CLI releases.
    """

    id: str
    """Canvas identifier, unique within the declaring connection."""

    display_name: str
    """Human-readable name shown in host UI and canvas pickers."""

    description: str
    """Short description shown to the agent in canvas catalogs."""

    input_schema: CanvasJsonSchema | None = None
    """JSON Schema for the ``input`` payload accepted by ``canvas.open``."""

    actions: list[CanvasAction] | None = None
    """Agent-callable actions this canvas exposes."""

    def to_dict(self) -> dict[str, Any]:
        result: dict[str, Any] = {
            "id": self.id,
            "displayName": self.display_name,
            "description": self.description,
        }
        if self.input_schema is not None:
            result["inputSchema"] = self.input_schema
        if self.actions is not None:
            result["actions"] = [action.to_dict() for action in self.actions]
        return result


class CanvasError(Exception):