fix: pipeline create and update should not leak transport details (#19)

- return clean response
- raise any errors that might have occurred

Author: mathislucka

src/deepset_mcp/api/pipeline/models.py

@@ -59,3 +59,10 @@ class PipelineValidationResult(BaseModel):
 
     valid: bool
     errors: list[ValidationError] = []
+
+
+class NoContentResponse(BaseModel):
+    """Response model for an empty response."""
+
+    success: bool = True
+    message: str = "No content"

src/deepset_mcp/api/pipeline/resource.py

@@ -1,9 +1,14 @@
 from typing import Any
 
 from deepset_mcp.api.exceptions import UnexpectedAPIError
-from deepset_mcp.api.pipeline.models import DeepsetPipeline, PipelineValidationResult, ValidationError
+from deepset_mcp.api.pipeline.models import (
+    DeepsetPipeline,
+    NoContentResponse,
+    PipelineValidationResult,
+    ValidationError,
+)
 from deepset_mcp.api.protocols import AsyncClientProtocol, PipelineResourceProtocol
-from deepset_mcp.api.transport import TransportResponse, raise_for_status
+from deepset_mcp.api.transport import raise_for_status
 
 
 class PipelineResource(PipelineResourceProtocol):
@@ -109,7 +114,7 @@ async def get(self, pipeline_name: str, include_yaml: bool = True) -> DeepsetPip
 
         return pipeline
 
-    async def create(self, name: str, yaml_config: str) -> TransportResponse:
+    async def create(self, name: str, yaml_config: str) -> NoContentResponse:
         """Create a new pipeline with a name and YAML config."""
         data = {"name": name, "query_yaml": yaml_config}
         resp = await self._client.request(
@@ -120,14 +125,14 @@ async def create(self, name: str, yaml_config: str) -> TransportResponse:
 
         raise_for_status(resp)
 
-        return resp
+        return NoContentResponse(message="Pipeline created successfully.")
 
     async def update(
         self,
         pipeline_name: str,
         updated_pipeline_name: str | None = None,
         yaml_config: str | None = None,
-    ) -> TransportResponse:
+    ) -> NoContentResponse:
         """Update name and/or YAML config of an existing pipeline."""
         # Handle name update first if any
         if updated_pipeline_name is not None:
@@ -142,7 +147,7 @@ async def update(
             pipeline_name = updated_pipeline_name
 
             if yaml_config is None:
-                return name_resp
+                return NoContentResponse(message="Pipeline name updated successfully.")
 
         if yaml_config is not None:
             yaml_resp = await self._client.request(
@@ -153,6 +158,11 @@ async def update(
 
             raise_for_status(yaml_resp)
 
-            return yaml_resp
+            if updated_pipeline_name is not None:
+                response = NoContentResponse(message="Pipeline name and YAML updated successfully.")
+            else:
+                response = NoContentResponse(message="Pipeline YAML updated successfully.")
+
+            return response
 
         raise ValueError("Either `updated_pipeline_name` or `yaml_config` must be provided.")

src/deepset_mcp/api/protocols.py

@@ -1,7 +1,7 @@
 from types import TracebackType
 from typing import Any, Protocol, Self
 
-from deepset_mcp.api.pipeline.models import DeepsetPipeline, PipelineValidationResult
+from deepset_mcp.api.pipeline.models import DeepsetPipeline, NoContentResponse, PipelineValidationResult
 from deepset_mcp.api.transport import TransportResponse
 
 
@@ -56,7 +56,7 @@ async def list(
         """List pipelines in the configured workspace with optional pagination."""
         ...
 
-    async def create(self, name: str, yaml_config: str) -> Any:
+    async def create(self, name: str, yaml_config: str) -> NoContentResponse:
         """Create a new pipeline with a name and YAML config."""
         ...
 
@@ -65,6 +65,6 @@ async def update(
         pipeline_name: str,
         updated_pipeline_name: str | None = None,
         yaml_config: str | None = None,
-    ) -> Any:
+    ) -> NoContentResponse:
         """Update name and/or YAML config of an existing pipeline."""
         ...

src/deepset_mcp/tools/pipeline.py

@@ -43,14 +43,16 @@ async def create_pipeline(
     if not validation_response.valid:
         return validation_result_to_llm_readable_string(validation_response)
 
-    creation_response = await client.pipelines(workspace=workspace).create(
-        name=pipeline_name, yaml_config=yaml_configuration
-    )
-
-    if creation_response.success:
-        return f"Pipeline '{pipeline_name}' created successfully."
+    try:
+        await client.pipelines(workspace=workspace).create(name=pipeline_name, yaml_config=yaml_configuration)
+    except ResourceNotFoundError:
+        return f"There is no workspace named '{workspace}'. Did you mean to configure it?"
+    except BadRequestError as e:
+        return f"Failed to create pipeline '{pipeline_name}': {e}"
+    except UnexpectedAPIError as e:
+        return f"Failed to create pipeline '{pipeline_name}': {e}"
 
-    return f"Failed to create pipeline '{pipeline_name}': {creation_response.text}"
+    return f"Pipeline '{pipeline_name}' created successfully."
 
 
 async def update_pipeline(
@@ -96,7 +98,7 @@ async def update_pipeline(
         return validation_result_to_llm_readable_string(validation_response)
 
     try:
-        update_response = await client.pipelines(workspace=workspace).update(
+        await client.pipelines(workspace=workspace).update(
             pipeline_name=pipeline_name, yaml_config=updated_yaml_configuration
         )
     except ResourceNotFoundError:
@@ -106,7 +108,4 @@ async def update_pipeline(
     except UnexpectedAPIError as e:
         return f"Failed to update the pipeline '{pipeline_name}': {e}"
 
-    if update_response.success:
-        return f"The pipeline '{pipeline_name}' was successfully updated."
-
-    return f"Failed to update the pipeline '{pipeline_name}': {update_response.text}"
+    return f"The pipeline '{pipeline_name}' was successfully updated."

test/unit/tools/test_pipeline.py

@@ -1,5 +1,5 @@
 from datetime import datetime
-from typing import Any, Self
+from typing import Self
 
 import pytest
 
@@ -11,6 +11,7 @@
 from deepset_mcp.api.pipeline.models import (
     DeepsetPipeline,
     DeepsetUser,
+    NoContentResponse,
     PipelineServiceLevel,
     PipelineValidationResult,
     ValidationError,
@@ -32,15 +33,17 @@ def __init__(
         list_response: list[DeepsetPipeline] | None = None,
         get_response: DeepsetPipeline | None = None,
         validate_response: PipelineValidationResult | None = None,
-        create_response: Any | None = None,
-        update_response: Any | None = None,
+        create_response: NoContentResponse | None = None,
+        update_response: NoContentResponse | None = None,
         get_exception: Exception | None = None,
         update_exception: Exception | None = None,
+        create_exception: Exception | None = None,
     ) -> None:
         self._list_response = list_response
         self._get_response = get_response
         self._validate_response = validate_response
         self._create_response = create_response
+        self._create_exception = create_exception
         self._update_response = update_response
         self._get_exception = get_exception
         self._update_exception = update_exception
@@ -62,7 +65,9 @@ async def validate(self, yaml_config: str) -> PipelineValidationResult:
             return self._validate_response
         raise NotImplementedError
 
-    async def create(self, name: str, yaml_config: str) -> Any:
+    async def create(self, name: str, yaml_config: str) -> NoContentResponse:
+        if self._create_exception:
+            raise self._create_exception
         if self._create_response is not None:
             return self._create_response
         raise NotImplementedError
@@ -72,7 +77,7 @@ async def update(
         pipeline_name: str,
         updated_pipeline_name: str | None = None,
         yaml_config: str | None = None,
-    ) -> Any:
+    ) -> NoContentResponse:
         if self._update_exception:
             raise self._update_exception
         if self._update_response is not None:
@@ -204,27 +209,23 @@ async def test_create_pipeline_handles_validation_failure() -> None:
 async def test_create_pipeline_handles_success_and_failure_response() -> None:
     valid_result = PipelineValidationResult(valid=True, errors=[])
 
-    class Creation:
-        def __init__(self, success: bool, text: str = "") -> None:
-            self.success = success
-            self.text = text
-
     # success
     resource_succ = FakePipelineResource(
         validate_response=valid_result,
-        create_response=Creation(success=True),
+        create_response=NoContentResponse(message="created successfully"),
     )
     client_succ = FakeClient(resource_succ)
     res_succ = await create_pipeline(client_succ, workspace="ws", pipeline_name="p1", yaml_configuration="a: b")
+
     assert "created successfully" in res_succ
     # failure
     resource_fail = FakePipelineResource(
         validate_response=valid_result,
-        create_response=Creation(success=False, text="bad things"),
+        create_exception=BadRequestError(message="bad things"),
     )
     client_fail = FakeClient(resource_fail)
     res_fail = await create_pipeline(client_fail, workspace="ws", pipeline_name="p1", yaml_configuration="a: b")
-    assert "Failed to create pipeline 'p1': bad things" == res_fail
+    assert "Failed to create pipeline 'p1': bad things (Status Code: 400)" == res_fail
 
 
 @pytest.mark.asyncio
@@ -373,7 +374,7 @@ async def test_update_pipeline_exceptions_on_update() -> None:
 
 
 @pytest.mark.asyncio
-async def test_update_pipeline_success_and_failure_response() -> None:
+async def test_update_pipeline_success_response() -> None:
     user = DeepsetUser(user_id="u1", given_name="A", family_name="B")
     orig_yaml = "foo: 1"
     original = DeepsetPipeline(
@@ -389,14 +390,11 @@ async def test_update_pipeline_success_and_failure_response() -> None:
     )
     val_ok = PipelineValidationResult(valid=True, errors=[])
 
-    class UpdateResp:
-        def __init__(self, success: bool, text: str = "") -> None:
-            self.success = success
-            self.text = text
-
     # success
     res_succ = FakePipelineResource(
-        get_response=original, validate_response=val_ok, update_response=UpdateResp(success=True)
+        get_response=original,
+        validate_response=val_ok,
+        update_response=NoContentResponse(message="successfully updated"),
     )
     client_succ = FakeClient(res_succ)
     r_success = await update_pipeline(
@@ -407,16 +405,3 @@ def __init__(self, success: bool, text: str = "") -> None:
         replacement_config_snippet="foo: 2",
     )
     assert "successfully updated" in r_success.lower()
-    # failure
-    res_fail = FakePipelineResource(
-        get_response=original, validate_response=val_ok, update_response=UpdateResp(success=False, text="nope")
-    )
-    client_fail = FakeClient(res_fail)
-    r_fail = await update_pipeline(
-        client_fail,
-        workspace="ws",
-        pipeline_name="np",
-        original_config_snippet="foo: 1",
-        replacement_config_snippet="foo: 2",
-    )
-    assert r_fail == "Failed to update the pipeline 'np': nope"