chore: remove WorkspaceList (#185)

Author: mathislucka

src/deepset_mcp/api/workspace/models.py

@@ -21,14 +21,3 @@ class Workspace(BaseModel):
     "Supported languages and their configuration settings"
     default_idle_timeout_in_seconds: int
     "Default timeout in seconds before workspace becomes idle"
-
-
-class WorkspaceList(BaseModel):
-    """Model representing a list of workspaces."""
-
-    data: list[Workspace]
-    "List of workspace objects for the current page"
-    has_more: bool = False
-    "Whether there are more workspaces available beyond this page"
-    total: int
-    "Total number of workspaces across all pages"

src/deepset_mcp/api/workspace/protocols.py

@@ -7,16 +7,16 @@
 from typing import Protocol
 
 from deepset_mcp.api.shared_models import NoContentResponse
-from deepset_mcp.api.workspace.models import Workspace, WorkspaceList
+from deepset_mcp.api.workspace.models import Workspace
 
 
 class WorkspaceResourceProtocol(Protocol):
     """Protocol defining the interface for workspace resources."""
 
-    async def list(self) -> WorkspaceList:
+    async def list(self) -> list[Workspace]:
         """List all workspaces.
 
-        :returns: A WorkspaceList containing all workspaces.
+        :returns: A list containing all workspaces.
         """
         ...
 

src/deepset_mcp/api/workspace/resource.py

@@ -9,7 +9,7 @@
 
 from deepset_mcp.api.shared_models import NoContentResponse
 from deepset_mcp.api.transport import raise_for_status
-from deepset_mcp.api.workspace.models import Workspace, WorkspaceList
+from deepset_mcp.api.workspace.models import Workspace
 from deepset_mcp.api.workspace.protocols import WorkspaceResourceProtocol
 
 logger = logging.getLogger(__name__)
@@ -28,10 +28,10 @@ def __init__(self, client: "AsyncClientProtocol") -> None:
         """
         self._client = client
 
-    async def list(self) -> WorkspaceList:
+    async def list(self) -> list[Workspace]:
         """List all workspaces.
 
-        :returns: A WorkspaceList containing all workspaces.
+        :returns: A list containing all workspaces.
         """
         resp = await self._client.request(
             endpoint="v1/workspaces",
@@ -42,13 +42,9 @@ async def list(self) -> WorkspaceList:
 
         if resp.json is not None and isinstance(resp.json, list):
             workspaces = [Workspace.model_validate(item) for item in resp.json]
-            return WorkspaceList(
-                data=workspaces,
-                has_more=False,
-                total=len(workspaces),
-            )
+            return workspaces
         else:
-            return WorkspaceList(data=[], has_more=False, total=0)
+            return []
 
     async def get(self, workspace_name: str) -> Workspace:
         """Get a specific workspace by name.

src/deepset_mcp/tools/workspace.py

@@ -7,10 +7,10 @@
 from deepset_mcp.api.exceptions import BadRequestError, ResourceNotFoundError, UnexpectedAPIError
 from deepset_mcp.api.protocols import AsyncClientProtocol
 from deepset_mcp.api.shared_models import NoContentResponse
-from deepset_mcp.api.workspace.models import Workspace, WorkspaceList
+from deepset_mcp.api.workspace.models import Workspace
 
 
-async def list_workspaces(*, client: AsyncClientProtocol) -> WorkspaceList | str:
+async def list_workspaces(*, client: AsyncClientProtocol) -> list[Workspace] | str:
     """Retrieves a list of all workspaces available to the user.
 
     This tool provides an overview of all workspaces that the user has access to.

test/integration/test_integration_workspace_resource.py

@@ -10,7 +10,7 @@
 
 from deepset_mcp.api.client import AsyncDeepsetClient
 from deepset_mcp.api.exceptions import ResourceNotFoundError
-from deepset_mcp.api.workspace.models import Workspace, WorkspaceList
+from deepset_mcp.api.workspace.models import Workspace
 
 pytestmark = pytest.mark.integration
 
@@ -23,13 +23,11 @@ async def test_list_workspaces(self) -> None:
         """Test listing workspaces."""
         async with AsyncDeepsetClient() as client:
             workspaces = await client.workspaces().list()
-            assert isinstance(workspaces, WorkspaceList)
-            assert isinstance(workspaces.data, list)
-            assert workspaces.total >= 0
+            assert isinstance(workspaces, list)
 
             # If we have workspaces, verify their structure
-            if workspaces.data:
-                workspace = workspaces.data[0]
+            if workspaces:
+                workspace = workspaces[0]
                 assert isinstance(workspace, Workspace)
                 assert isinstance(workspace.name, str)
                 assert isinstance(workspace.workspace_id, uuid.UUID)

test/unit/api/workspace/test_workspace_resource.py

@@ -11,7 +11,7 @@
 from deepset_mcp.api.exceptions import BadRequestError, ResourceNotFoundError, UnexpectedAPIError
 from deepset_mcp.api.shared_models import NoContentResponse
 from deepset_mcp.api.transport import TransportResponse
-from deepset_mcp.api.workspace.models import Workspace, WorkspaceList
+from deepset_mcp.api.workspace.models import Workspace
 from deepset_mcp.api.workspace.resource import WorkspaceResource
 from test.unit.conftest import BaseFakeClient
 
@@ -52,22 +52,20 @@ def workspaces(self) -> WorkspaceResource:
         result = await resource.list()
 
         # Assert
-        assert isinstance(result, WorkspaceList)
-        assert len(result.data) == 2
-        assert result.total == 2
-        assert not result.has_more
+        assert isinstance(result, list)
+        assert len(result) == 2
 
         # Check first workspace
-        assert result.data[0].name == "copilot-testing"
-        assert result.data[0].workspace_id == UUID("76d361b5-a551-40e3-a5c9-fdbc20028021")
-        assert result.data[0].languages == {}
-        assert result.data[0].default_idle_timeout_in_seconds == 43200
+        assert result[0].name == "copilot-testing"
+        assert result[0].workspace_id == UUID("76d361b5-a551-40e3-a5c9-fdbc20028021")
+        assert result[0].languages == {}
+        assert result[0].default_idle_timeout_in_seconds == 43200
 
         # Check second workspace
-        assert result.data[1].name == "default"
-        assert result.data[1].workspace_id == UUID("91ee7798-004d-4808-906a-1777ea262d1c")
-        assert result.data[1].languages == {}
-        assert result.data[1].default_idle_timeout_in_seconds == 43200
+        assert result[1].name == "default"
+        assert result[1].workspace_id == UUID("91ee7798-004d-4808-906a-1777ea262d1c")
+        assert result[1].languages == {}
+        assert result[1].default_idle_timeout_in_seconds == 43200
 
         # Verify request was made correctly
         assert len(client.requests) == 1
@@ -93,10 +91,8 @@ def workspaces(self) -> WorkspaceResource:
         result = await resource.list()
 
         # Assert
-        assert isinstance(result, WorkspaceList)
-        assert len(result.data) == 0
-        assert result.total == 0
-        assert not result.has_more
+        assert isinstance(result, list)
+        assert len(result) == 0
 
     @pytest.mark.asyncio
     async def test_list_null_response(self) -> None:
@@ -117,10 +113,8 @@ def workspaces(self) -> WorkspaceResource:
         result = await resource.list()
 
         # Assert
-        assert isinstance(result, WorkspaceList)
-        assert len(result.data) == 0
-        assert result.total == 0
-        assert not result.has_more
+        assert isinstance(result, list)
+        assert len(result) == 0
 
     @pytest.mark.asyncio
     async def test_list_error_response(self) -> None:

test/unit/tools/test_workspace.py

@@ -8,7 +8,7 @@
 
 from deepset_mcp.api.exceptions import BadRequestError, ResourceNotFoundError, UnexpectedAPIError
 from deepset_mcp.api.shared_models import NoContentResponse
-from deepset_mcp.api.workspace.models import Workspace, WorkspaceList
+from deepset_mcp.api.workspace.models import Workspace
 from deepset_mcp.api.workspace.protocols import WorkspaceResourceProtocol
 from deepset_mcp.tools.workspace import create_workspace, get_workspace, list_workspaces
 from test.unit.conftest import BaseFakeClient
@@ -37,12 +37,12 @@ def __init__(
         self._create_exception = create_exception
         self._delete_exception = delete_exception
 
-    async def list(self) -> WorkspaceList:
+    async def list(self) -> list[Workspace]:
         """List all workspaces."""
         if self._list_exception:
             raise self._list_exception
         if self._list_response is not None:
-            return WorkspaceList(data=self._list_response, has_more=False, total=len(self._list_response))
+            return self._list_response
         raise NotImplementedError
 
     async def get(self, workspace_name: str) -> Workspace:
@@ -101,12 +101,10 @@ async def test_list_workspaces_returns_workspace_list() -> None:
 
     result = await list_workspaces(client=client)
 
-    assert isinstance(result, WorkspaceList)
-    assert len(result.data) == 2
-    assert result.data[0].name == "workspace1"
-    assert result.data[1].name == "workspace2"
-    assert result.total == 2
-    assert result.has_more is False
+    assert isinstance(result, list)
+    assert len(result) == 2
+    assert result[0].name == "workspace1"
+    assert result[1].name == "workspace2"
 
 
 @pytest.mark.asyncio
@@ -237,7 +235,5 @@ async def test_list_workspaces_empty_response() -> None:
 
     result = await list_workspaces(client=client)
 
-    assert isinstance(result, WorkspaceList)
-    assert len(result.data) == 0
-    assert result.total == 0
-    assert result.has_more is False
+    assert isinstance(result, list)
+    assert len(result) == 0