refactor: pass URL params using params parameter instead of hand-rolling URLs (#37)

* refactor: pass URL params via params parameter instead of URL string

* refactor: pass URL params via params parameter instead of URL string

* refactor: update test to match new params approach

* refactor: update test to match new params approach

* refactor: pass URL params via params parameter instead of URL string

* fix: tests

Author: mathislucka

src/deepset_mcp/api/client.py

@@ -57,6 +57,7 @@ async def request(
         method: str = "GET",
         data: dict[str, Any] | None = None,
         headers: dict[str, str] | None = None,
+        **kwargs: Any,
     ) -> TransportResponse[T]: ...
 
     @overload
@@ -68,6 +69,7 @@ async def request(
         method: str = "GET",
         data: dict[str, Any] | None = None,
         headers: dict[str, str] | None = None,
+        **kwargs: Any,
     ) -> TransportResponse[Any]: ...
 
     async def request(
@@ -78,6 +80,7 @@ async def request(
         data: dict[str, Any] | None = None,
         headers: dict[str, str] | None = None,
         response_type: type[T] | None = None,
+        **kwargs: Any,
     ) -> TransportResponse[Any]:
         """Make a request to the deepset API."""
         if not endpoint.startswith("/"):
@@ -102,6 +105,7 @@ async def request(
             json=data,
             headers=request_headers,
             response_type=response_type,
+            **kwargs,
         )
 
     async def close(self) -> None:

src/deepset_mcp/api/haystack_service/resource.py

@@ -39,9 +39,10 @@ async def get_component_input_output(self, component_name: str) -> dict[str, Any
             The component input/output schema as a dictionary
         """
         resp = await self._client.request(
-            endpoint=f"v1/haystack/components/input-output?domain=deepset-cloud&names={component_name}",
+            endpoint="v1/haystack/components/input-output",
             method="GET",
             headers={"accept": "application/json"},
+            params={"domain": "deepset-cloud", "names": component_name},
             response_type=list[dict[str, Any]],
         )
 

src/deepset_mcp/api/pipeline/resource.py

@@ -77,10 +77,10 @@ async def list(
             "limit": limit,
         }
 
-        query = "?" + "&".join(f"{k}={v}" for k, v in params.items()) if params else ""
         resp = await self._client.request(
-            endpoint=f"v1/workspaces/{self._workspace}/pipelines{query}",
+            endpoint=f"v1/workspaces/{self._workspace}/pipelines",
             method="GET",
+            params=params,
         )
 
         raise_for_status(resp)

src/deepset_mcp/api/pipeline_template/resource.py

@@ -55,8 +55,9 @@ async def list_templates(self, limit: int = 100) -> list[PipelineTemplate]:
             List of pipeline templates
         """
         response = await self._client.request(
-            f"/v1/workspaces/{self._workspace}/pipeline_templates?limit={limit}&page_number=1&field=created_at&order=DESC",
+            f"/v1/workspaces/{self._workspace}/pipeline_templates",
             method="GET",
+            params={"limit": limit, "page_number": 1, "field": "created_at", "order": "DESC"},
         )
 
         raise_for_status(response)

src/deepset_mcp/api/protocols.py

@@ -33,6 +33,7 @@ async def request(
         method: str = "GET",
         data: dict[str, Any] | None = None,
         headers: dict[str, str] | None = None,
+        **kwargs: Any,
     ) -> TransportResponse[T]: ...
 
     @overload
@@ -44,6 +45,7 @@ async def request(
         method: str = "GET",
         data: dict[str, Any] | None = None,
         headers: dict[str, str] | None = None,
+        **kwargs: Any,
     ) -> TransportResponse[Any]: ...
 
     async def request(
@@ -54,6 +56,7 @@ async def request(
         method: str = "GET",
         data: dict[str, Any] | None = None,
         headers: dict[str, str] | None = None,
+        **kwargs: Any,
     ) -> TransportResponse[Any]:
         """Make a request to the API."""
         ...

test/unit/api/haystack_service/test_haystack_service_resource.py

@@ -40,7 +40,7 @@ def mock_schema_error_response(mock_client: BaseFakeClient) -> None:
 
 @pytest.fixture
 def mock_successful_io_response(mock_client: BaseFakeClient) -> None:
-    mock_client.responses["v1/haystack/components/input-output?domain=deepset-cloud&names=Agent"] = TransportResponse(
+    mock_client.responses["v1/haystack/components/input-output"] = TransportResponse(
         status_code=200,
         json=[{"name": "Agent", "input": "Mock input", "output": "Mock output"}],
         text=json.dumps([{"name": "Agent", "input": "Mock input", "output": "Mock output"}]),
@@ -49,7 +49,7 @@ def mock_successful_io_response(mock_client: BaseFakeClient) -> None:
 
 @pytest.fixture
 def mock_io_error_response(mock_client: BaseFakeClient) -> None:
-    mock_client.responses["v1/haystack/components/input-output?domain=deepset-cloud&names=Agent"] = TransportResponse(
+    mock_client.responses["v1/haystack/components/input-output"] = TransportResponse(
         status_code=500,
         json={"message": "Internal server error"},
         text="Internal server error",

test/unit/api/pipeline/test_pipeline_resource.py

@@ -68,7 +68,7 @@ async def test_list_pipelines_default_params(self) -> None:
         # Create client with predefined response
         client = DummyClient(
             responses={
-                "test-workspace/pipelines?page_number=1&limit=10": {
+                "test-workspace/pipelines": {
                     "data": sample_pipelines,
                     "has_more": False,
                     "total": 2,
@@ -88,8 +88,9 @@ async def test_list_pipelines_default_params(self) -> None:
 
         # Verify request
         assert len(client.requests) == 1
-        assert client.requests[0]["endpoint"] == "v1/workspaces/test-workspace/pipelines?page_number=1&limit=10"
+        assert client.requests[0]["endpoint"] == "v1/workspaces/test-workspace/pipelines"
         assert client.requests[0]["method"] == "GET"
+        assert client.requests[0]["params"] == {"page_number": 1, "limit": 10}
 
     @pytest.mark.asyncio
     async def test_list_pipelines_with_pagination(self) -> None:
@@ -103,7 +104,7 @@ async def test_list_pipelines_with_pagination(self) -> None:
         # Create client with predefined response
         client = DummyClient(
             responses={
-                "test-workspace/pipelines?page_number=2&limit=5": {
+                "test-workspace/pipelines": {
                     "data": sample_pipelines,
                     "has_more": False,
                     "total": 10,
@@ -121,15 +122,14 @@ async def test_list_pipelines_with_pagination(self) -> None:
         assert result[1].id == "4"
 
         # Verify request
-        assert client.requests[0]["endpoint"] == "v1/workspaces/test-workspace/pipelines?page_number=2&limit=5"
+        assert client.requests[0]["endpoint"] == "v1/workspaces/test-workspace/pipelines"
+        assert client.requests[0]["params"] == {"page_number": 2, "limit": 5}
 
     @pytest.mark.asyncio
     async def test_list_pipelines_empty_result(self) -> None:
         """Test listing pipelines when there are no pipelines."""
         # Create client with empty response
-        client = DummyClient(
-            responses={"test-workspace/pipelines?page_number=1&limit=10": {"data": [], "has_more": False, "total": 0}}
-        )
+        client = DummyClient(responses={"test-workspace/pipelines": {"data": [], "has_more": False, "total": 0}})
 
         # Create resource and call list method
         resource = PipelineResource(client=client, workspace="test-workspace")
@@ -142,7 +142,7 @@ async def test_list_pipelines_empty_result(self) -> None:
     async def test_list_pipelines_error(self) -> None:
         """Test handling of errors when listing pipelines."""
         # Create client that raises an exception
-        client = DummyClient(responses={"test-workspace/pipelines?page_number=1&limit=10": ValueError("API Error")})
+        client = DummyClient(responses={"test-workspace/pipelines": ValueError("API Error")})
 
         # Create resource
         resource = PipelineResource(client=client, workspace="test-workspace")
@@ -155,9 +155,7 @@ async def test_list_pipelines_error(self) -> None:
     async def test_list_pipelines_with_zero_limit(self) -> None:
         """Test listing pipelines with a limit of zero (edge case)."""
         # Create client
-        client = DummyClient(
-            responses={"test-workspace/pipelines?page_number=1&limit=0": {"data": [], "has_more": False, "total": 10}}
-        )
+        client = DummyClient(responses={"test-workspace/pipelines": {"data": [], "has_more": False, "total": 10}})
 
         # Create resource and call list method with limit=0
         resource = PipelineResource(client=client, workspace="test-workspace")
@@ -167,7 +165,8 @@ async def test_list_pipelines_with_zero_limit(self) -> None:
         assert len(result) == 0
 
         # Verify request
-        assert client.requests[0]["endpoint"] == "v1/workspaces/test-workspace/pipelines?page_number=1&limit=0"
+        assert client.requests[0]["endpoint"] == "v1/workspaces/test-workspace/pipelines"
+        assert client.requests[0]["params"] == {"page_number": 1, "limit": 0}
 
     @pytest.mark.asyncio
     async def test_get_pipeline_with_yaml(self) -> None:

test/unit/api/pipeline_template/test_pipeline_template_resource.py

@@ -105,7 +105,7 @@ async def test_list_templates_default_params(self) -> None:
         # Create client with predefined response
         client = DummyClient(
             responses={
-                "test-workspace/pipeline_templates?limit=100&page_number=1&field=created_at&order=DESC": {
+                "test-workspace/pipeline_templates": {
                     "data": sample_templates,
                     "has_more": False,
                     "total": 2,
@@ -125,10 +125,7 @@ async def test_list_templates_default_params(self) -> None:
 
         # Verify request
         assert len(client.requests) == 1
-        assert (
-            client.requests[0]["endpoint"]
-            == "/v1/workspaces/test-workspace/pipeline_templates?limit=100&page_number=1&field=created_at&order=DESC"
-        )
+        assert client.requests[0]["endpoint"] == "/v1/workspaces/test-workspace/pipeline_templates"
         assert client.requests[0]["method"] == "GET"
 
     @pytest.mark.asyncio
@@ -142,7 +139,7 @@ async def test_list_templates_custom_limit(self) -> None:
         # Create client with predefined response
         client = DummyClient(
             responses={
-                "test-workspace/pipeline_templates?limit=1&page_number=1&field=created_at&order=DESC": {
+                "test-workspace/pipeline_templates": {
                     "data": sample_templates,
                     "has_more": True,
                     "total": 2,
@@ -160,18 +157,15 @@ async def test_list_templates_custom_limit(self) -> None:
         assert result[0].template_name == "Template 1"
 
         # Verify request
-        assert (
-            client.requests[0]["endpoint"]
-            == "/v1/workspaces/test-workspace/pipeline_templates?limit=1&page_number=1&field=created_at&order=DESC"
-        )
+        assert client.requests[0]["endpoint"] == "/v1/workspaces/test-workspace/pipeline_templates"
 
     @pytest.mark.asyncio
     async def test_list_templates_empty_result(self) -> None:
         """Test listing templates when there are no templates."""
         # Create client with empty response
         client = DummyClient(
             responses={
-                "test-workspace/pipeline_templates?limit=100&page_number=1&field=created_at&order=DESC": {
+                "test-workspace/pipeline_templates": {
                     "data": [],
                     "has_more": False,
                     "total": 0,

test/unit/conftest.py

@@ -38,6 +38,7 @@ async def request(
         method: str = "GET",
         data: dict[str, Any] | None = None,
         headers: dict[str, str] | None = None,
+        **kwargs: Any,
     ) -> TransportResponse[T]: ...
 
     @overload
@@ -49,6 +50,7 @@ async def request(
         method: str = "GET",
         data: dict[str, Any] | None = None,
         headers: dict[str, str] | None = None,
+        **kwargs: Any,
     ) -> TransportResponse[Any]: ...
 
     async def request(
@@ -59,6 +61,7 @@ async def request(
         method: str = "GET",
         data: dict[str, Any] | None = None,
         headers: dict[str, str] | None = None,
+        **kwargs: Any,
     ) -> TransportResponse[Any]:
         """
         Record the request and return a predefined response.
@@ -84,7 +87,7 @@ async def request(
         ValueError
             If no response is predefined for the endpoint.
         """
-        self.requests.append({"endpoint": endpoint, "method": method, "data": data, "headers": headers})
+        self.requests.append({"endpoint": endpoint, "method": method, "data": data, "headers": headers, **kwargs})
 
         # Find the appropriate response
         for resp_key, resp_data in self.responses.items():