feat: add search_pipeline_with_params tool (#203)

Author: tstadel

src/deepset_mcp/mcp/tool_registry.py

@@ -38,6 +38,7 @@
     list_pipelines as list_pipelines_tool,
     search_pipeline as search_pipeline_tool,
     search_pipeline_with_filters as search_pipeline_with_filters_tool,
+    search_pipeline_with_params as search_pipeline_with_params_tool,
     update_pipeline as update_pipeline_tool,
     validate_pipeline as validate_pipeline_tool,
 )
@@ -133,6 +134,10 @@ async def search_docs(query: str) -> str:
         search_pipeline_with_filters_tool,
         ToolConfig(needs_client=True, needs_workspace=True, memory_type=MemoryType.EXPLORABLE),
     ),
+    "search_pipeline_with_params": (
+        search_pipeline_with_params_tool,
+        ToolConfig(needs_client=True, needs_workspace=True, memory_type=MemoryType.EXPLORABLE),
+    ),
     "list_indexes": (
         list_indexes_tool,
         ToolConfig(needs_client=True, needs_workspace=True, memory_type=MemoryType.EXPLORABLE),

src/deepset_mcp/tools/__init__.py

@@ -21,6 +21,7 @@
     list_pipelines,
     search_pipeline,
     search_pipeline_with_filters,
+    search_pipeline_with_params,
     update_pipeline,
     validate_pipeline,
 )
@@ -51,6 +52,7 @@
     "deploy_pipeline",
     "search_pipeline",
     "search_pipeline_with_filters",
+    "search_pipeline_with_params",
     "create_pipeline",
     "update_pipeline",
     "validate_pipeline",

src/deepset_mcp/tools/pipeline.py

@@ -417,3 +417,54 @@ async def search_pipeline_with_filters(
         return f"Failed to search using pipeline '{pipeline_name}': {e}"
     except Exception as e:
         return f"An unexpected error occurred while searching with pipeline '{pipeline_name}': {str(e)}"
+
+
+async def search_pipeline_with_params(
+    *,
+    client: AsyncClientProtocol,
+    workspace: str,
+    pipeline_name: str,
+    query: str,
+    params: dict[str, Any] | None = None,
+) -> DeepsetSearchResponse | str:
+    """Searches using a pipeline with params.
+
+    Uses the specified pipeline to perform a search with the given query and params.
+    Params can be arbitrary parameters to customize the search behavior.
+    Filters can be used as well under the "filters" key in params.
+    Filters follow the Haystack filter syntax: https://docs.haystack.deepset.ai/docs/metadata-filtering.
+    Before executing the search, checks if the pipeline is deployed (status = DEPLOYED).
+    Returns search results.
+
+    :param client: The async client for API communication.
+    :param workspace: The workspace name.
+    :param pipeline_name: Name of the pipeline to use for search.
+    :param query: The search query to execute.
+    :param params: The parameters to customize the search.
+
+    :returns: Search results or error message.
+    """
+    try:
+        # First, check if the pipeline exists and get its status
+        pipeline = await client.pipelines(workspace=workspace).get(pipeline_name=pipeline_name)
+
+        # Check if pipeline is deployed
+        if pipeline.status != "DEPLOYED":
+            return (
+                f"Pipeline '{pipeline_name}' is not deployed (current status: {pipeline.status}). "
+                f"Please deploy the pipeline first using the deploy_pipeline tool before attempting to search."
+            )
+
+        # Execute the search
+        return await client.pipelines(workspace=workspace).search(
+            pipeline_name=pipeline_name, query=query, params=params if params is not None else None
+        )
+
+    except ResourceNotFoundError:
+        return f"There is no pipeline named '{pipeline_name}' in workspace '{workspace}'."
+    except BadRequestError as e:
+        return f"Failed to search using pipeline '{pipeline_name}': {e}"
+    except UnexpectedAPIError as e:
+        return f"Failed to search using pipeline '{pipeline_name}': {e}"
+    except Exception as e:
+        return f"An unexpected error occurred while searching with pipeline '{pipeline_name}': {str(e)}"