mcp-haystack 0.2.0__tar.gz → 0.3.0__tar.gz

{mcp_haystack-0.2.0 → mcp_haystack-0.3.0}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [integrations/mcp-v0.2.0] - 2025-05-06
+
+### 🚀 Features
+
+- [**breaking**] Deprecate SSEServerInfo base_url in favour of url (#1662)
+
+### 📚 Documentation
+
+- Add_mcptoolset_docs (#1668)
+
 ## [integrations/mcp-v0.1.0] - 2025-04-22
 
 ### 🚀 Features
@@ -13,6 +23,10 @@
 
 - Fix MCPTool import in code example (#1578)
 
+### ⚙️ CI
+
+- Review testing workflows (#1541)
+
 ### 🌀 Miscellaneous
 
 - Feat: Add AsyncExecutor in MCPTool, ensure MCPTool works in hayhooks (#1643)

{mcp_haystack-0.2.0 → mcp_haystack-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcp-haystack
-Version: 0.2.0
+Version: 0.3.0
 Summary: Haystack integration for Model Context Protocol (MCP)
 Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/mcp#readme
 Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues

mcp_haystack-0.3.0/examples/mcp_client.py

@@ -0,0 +1,69 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import argparse
+import logging
+
+from haystack_integrations.tools.mcp import MCPTool, SSEServerInfo, StreamableHttpServerInfo
+
+# Setup targeted logging - only show debug logs from our package
+logging.basicConfig(level=logging.WARNING)  # Set root logger to WARNING
+mcp_logger = logging.getLogger("haystack_integrations.tools.mcp")
+mcp_logger.setLevel(logging.DEBUG)
+# Ensure we have at least one handler to avoid messages going to root logger
+if not mcp_logger.handlers:
+    handler = logging.StreamHandler()
+    handler.setFormatter(logging.Formatter("%(levelname)s:%(name)s:%(message)s"))
+    mcp_logger.addHandler(handler)
+    mcp_logger.propagate = False  # Prevent propagation to root logger
+
+# Run this client after running the server mcp_server.py
+# It shows how easy it is to use the MCPTool with different transport options
+
+
+def main():
+    """Example of MCPTool usage with server connection."""
+
+    # Parse command line arguments
+    parser = argparse.ArgumentParser(description="Run an MCP client to connect to the server")
+    parser.add_argument(
+        "--transport",
+        type=str,
+        default="sse",
+        choices=["sse", "streamable-http"],
+        help="Transport mechanism for the MCP client (default: sse)",
+    )
+    args = parser.parse_args()
+
+    # Construct the appropriate URL based on transport type
+    if args.transport == "sse":
+        server_info = SSEServerInfo(url="http://localhost:8000/sse")
+    else:  # streamable-http
+        server_info = StreamableHttpServerInfo(url="http://localhost:8000/mcp")
+    tool = None
+    tool_subtract = None
+    try:
+        tool = MCPTool(name="add", server_info=server_info)
+        tool_subtract = MCPTool(name="subtract", server_info=server_info)
+
+        result = tool.invoke(a=7, b=3)
+        print(f"7 + 3 = {result}")
+
+        result = tool_subtract.invoke(a=5, b=3)
+        print(f"5 - 3 = {result}")
+
+        result = tool.invoke(a=10, b=20)
+        print(f"10 + 20 = {result}")
+
+    except Exception as e:
+        print(f"Error in client example: {e}")
+    finally:
+        if tool:
+            tool.close()
+        if tool_subtract:
+            tool_subtract.close()
+
+
+if __name__ == "__main__":
+    main()

{mcp_haystack-0.2.0 → mcp_haystack-0.3.0}/examples/mcp_filtered_tools.py

@@ -6,18 +6,20 @@ from haystack_integrations.tools.mcp import MCPToolset, SSEServerInfo
 
 # This example demonstrates using MCPToolset with SSE transport
 # and filtering tools by name
-# Run this client after running the server mcp_sse_server.py
+# Run this client after running the server mcp_server.py with sse transport
 # It shows how MCPToolset can selectively include only specific tools
 
 
 def main():
     """Example of using MCPToolset with filtered tools."""
 
+    full_toolset = None
+    filtered_toolset = None
     try:
         print("Creating toolset with all available tools:")
         # Create a toolset with all available tools
         full_toolset = MCPToolset(
-            server_info=SSEServerInfo(base_url="http://localhost:8000"),
+            server_info=SSEServerInfo(url="http://localhost:8000/sse"),
         )
 
         # Print all discovered tools
@@ -29,7 +31,7 @@ def main():
         # Create a toolset with only specific tools
         # In this example, we're only including the 'add' tool
         filtered_toolset = MCPToolset(
-            server_info=SSEServerInfo(base_url="http://localhost:8000"),
+            server_info=SSEServerInfo(url="http://localhost:8000/sse"),
             tool_names=["add"],  # Only include the 'add' tool
         )
 
@@ -48,6 +50,11 @@ def main():
 
     except Exception as e:
         print(f"Error in filtered toolset example: {e}")
+    finally:
+        if full_toolset:
+            full_toolset.close()
+        if filtered_toolset:
+            filtered_toolset.close()
 
 
 if __name__ == "__main__":

mcp_haystack-0.3.0/examples/mcp_server.py

@@ -0,0 +1,42 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import argparse
+
+from mcp.server.fastmcp import FastMCP
+
+# run this server first before running the client mcp_filtered_tools.py or mcp_client.py
+# it shows how easy it is to create a MCP server in just a few lines of code
+# then we'll use the MCPTool to invoke the server
+
+
+mcp = FastMCP("MCP Calculator")
+
+
+@mcp.tool()
+def add(a: int, b: int) -> int:
+    """Add two numbers"""
+    return a + b
+
+
+@mcp.tool()
+def subtract(a: int, b: int) -> int:
+    """Subtract two numbers"""
+    return a - b
+
+
+if __name__ == "__main__":
+    # Parse command line arguments
+    parser = argparse.ArgumentParser(
+        description="Run an MCP server with different transport options (sse or streamable-http)"
+    )
+    parser.add_argument(
+        "--transport",
+        type=str,
+        default="sse",
+        choices=["sse", "streamable-http"],
+        help="Transport mechanism for the MCP server (default: sse)",
+    )
+    args = parser.parse_args()
+    mcp.run(transport=args.transport)

{mcp_haystack-0.2.0 → mcp_haystack-0.3.0}/examples/mcp_sse_toolset.py

@@ -5,7 +5,7 @@
 from haystack_integrations.tools.mcp import MCPToolset, SSEServerInfo
 
 # This example demonstrates using MCPToolset with SSE transport
-# Run this client after running the server mcp_sse_server.py
+# Run this client after running the server mcp_server.py with sse transport
 # It shows how MCPToolset automatically discovers and creates tools from the MCP server
 
 
@@ -26,11 +26,12 @@ def find_tool(toolset, tool_name):
 def main():
     """Example of using MCPToolset with SSE transport."""
 
+    sse_toolset = None
     try:
         # Create the toolset - this automatically discovers all available tools
         # from the MCP server and creates Tool instances for each one
         sse_toolset = MCPToolset(
-            server_info=SSEServerInfo(base_url="http://localhost:8000"),
+            server_info=SSEServerInfo(url="http://localhost:8000/sse"),
         )
 
         # Print discovered tools
@@ -62,6 +63,10 @@ def main():
     except Exception as e:
         print(f"Error in SSE toolset example: {e}")
 
+    finally:
+        if sse_toolset:
+            sse_toolset.close()
+
 
 if __name__ == "__main__":
     main()

{mcp_haystack-0.2.0 → mcp_haystack-0.3.0}/examples/mcp_stdio_client.py

@@ -20,6 +20,7 @@ logger.setLevel(logging.DEBUG)
 def main():
     """Example of using the MCPTool implementation with stdio transport."""
 
+    stdio_tool = None
     try:
 
         stdio_tool = MCPTool(
@@ -36,6 +37,9 @@ def main():
         print(f"Current time in Los Angeles: {result}")
     except Exception as e:
         print(f"Error in stdio example: {e}")
+    finally:
+        if stdio_tool:
+            stdio_tool.close()
 
 
 if __name__ == "__main__":

{mcp_haystack-0.2.0 → mcp_haystack-0.3.0}/examples/mcp_stdio_toolset.py

@@ -28,6 +28,7 @@ def find_tool(toolset, tool_name):
 def main():
     """Example of using the MCPToolset implementation with stdio transport."""
 
+    stdio_toolset = None
     try:
         # Create server info for the time service
         server_info = StdioServerInfo(command="uvx", args=["mcp-server-time", "--local-timezone=Europe/Berlin"])
@@ -54,6 +55,9 @@ def main():
         print(f"Current time in Los Angeles: {result.content[0].text}")
     except Exception as e:
         print(f"Error in stdio toolset example: {e}")
+    finally:
+        if stdio_toolset:
+            stdio_toolset.close()
 
 
 if __name__ == "__main__":

mcp_haystack-0.3.0/examples/time_pipeline.py

@@ -0,0 +1,69 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# Full example of a pipeline that uses MCPTool to get the current time
+# and then uses the time to answer a user question.
+# Here we use the mcp-server-time mcp package
+# See https://github.com/modelcontextprotocol/servers/tree/main/src/time for more details
+# prior to running this script, pip install mcp-server-time
+
+import logging
+
+from haystack import Pipeline
+from haystack.components.converters import OutputAdapter
+from haystack.components.generators.chat import OpenAIChatGenerator
+from haystack.components.tools import ToolInvoker
+from haystack.dataclasses import ChatMessage
+
+from haystack_integrations.tools.mcp.mcp_tool import MCPTool, StdioServerInfo
+
+# Setup targeted logging - only show debug logs from our package
+logging.basicConfig(level=logging.WARNING)  # Set root logger to WARNING
+mcp_logger = logging.getLogger("haystack_integrations.tools.mcp")
+mcp_logger.setLevel(logging.DEBUG)
+# Ensure we have at least one handler to avoid messages going to root logger
+if not mcp_logger.handlers:
+    handler = logging.StreamHandler()
+    handler.setFormatter(logging.Formatter("%(levelname)s:%(name)s:%(message)s"))
+    mcp_logger.addHandler(handler)
+    mcp_logger.propagate = False  # Prevent propagation to root logger
+
+
+def main():
+    time_tool = None
+    try:
+        time_tool = MCPTool(
+            name="get_current_time",
+            server_info=StdioServerInfo(command="uvx", args=["mcp-server-time", "--local-timezone=Europe/Berlin"]),
+        )
+        pipeline = Pipeline()
+        pipeline.add_component("llm", OpenAIChatGenerator(model="gpt-4o-mini", tools=[time_tool]))
+        pipeline.add_component("tool_invoker", ToolInvoker(tools=[time_tool]))
+        pipeline.add_component(
+            "adapter",
+            OutputAdapter(
+                template="{{ initial_msg + initial_tool_messages + tool_messages }}",
+                output_type=list[ChatMessage],
+                unsafe=True,
+            ),
+        )
+        pipeline.add_component("response_llm", OpenAIChatGenerator(model="gpt-4o-mini"))
+        pipeline.connect("llm.replies", "tool_invoker.messages")
+        pipeline.connect("llm.replies", "adapter.initial_tool_messages")
+        pipeline.connect("tool_invoker.tool_messages", "adapter.tool_messages")
+        pipeline.connect("adapter.output", "response_llm.messages")
+
+        user_input = "What is the time in New York? Be brief."  # can be any city
+        user_input_msg = ChatMessage.from_user(text=user_input)
+
+        result = pipeline.run({"llm": {"messages": [user_input_msg]}, "adapter": {"initial_msg": [user_input_msg]}})
+
+        print(result["response_llm"]["replies"][0].text)
+    finally:
+        if time_tool:
+            time_tool.close()
+
+
+if __name__ == "__main__":
+    main()

mcp_haystack-0.3.0/examples/time_pipeline_toolset.py

@@ -0,0 +1,67 @@
+# SPDX-FileCopyrightText: 2022-present deepset GmbH <info@deepset.ai>
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# Full example of a pipeline that uses MCPToolset to get the current time
+# and then uses the time to answer a user question.
+# Here we use the mcp-server-time mcp package
+# See https://github.com/modelcontextprotocol/servers/tree/main/src/time for more details
+# prior to running this script, pip install mcp-server-time
+
+import os
+
+from haystack import Pipeline
+from haystack.components.converters import OutputAdapter
+from haystack.components.generators.chat import OpenAIChatGenerator
+from haystack.components.tools import ToolInvoker
+from haystack.dataclasses import ChatMessage
+
+from haystack_integrations.tools.mcp import MCPToolset, StdioServerInfo
+
+
+def main():
+    # Create server info for the time service
+    server_info = StdioServerInfo(command="uvx", args=["mcp-server-time", "--local-timezone=Europe/Berlin"])
+
+    mcp_toolset = None
+    try:
+        # Create the toolset - this will automatically discover all available tools
+        mcp_toolset = MCPToolset(server_info)
+        # Check if OpenAI API key is set
+        api_key = os.environ.get("OPENAI_API_KEY")
+        if not api_key:
+            print("OPENAI_API_KEY environment variable is not set.")
+            print("You need to set it to run the pipeline example.")
+            print("For now, demonstrating direct tool usage:")
+
+        pipeline = Pipeline()
+        pipeline.add_component("llm", OpenAIChatGenerator(model="gpt-4o-mini", tools=mcp_toolset))
+        pipeline.add_component("tool_invoker", ToolInvoker(tools=mcp_toolset))
+        pipeline.add_component(
+            "adapter",
+            OutputAdapter(
+                template="{{ initial_msg + initial_tool_messages + tool_messages }}",
+                output_type=list[ChatMessage],
+                unsafe=True,
+            ),
+        )
+        pipeline.add_component("response_llm", OpenAIChatGenerator(model="gpt-4o-mini"))
+        pipeline.connect("llm.replies", "tool_invoker.messages")
+        pipeline.connect("llm.replies", "adapter.initial_tool_messages")
+        pipeline.connect("tool_invoker.tool_messages", "adapter.tool_messages")
+        pipeline.connect("adapter.output", "response_llm.messages")
+
+        user_input = "What is the time in New York? Be brief."  # can be any city
+        user_input_msg = ChatMessage.from_user(text=user_input)
+
+        result = pipeline.run({"llm": {"messages": [user_input_msg]}, "adapter": {"initial_msg": [user_input_msg]}})
+
+        print(result["response_llm"]["replies"][0].text)
+
+    finally:
+        if mcp_toolset:
+            mcp_toolset.close()
+
+
+if __name__ == "__main__":
+    main()

{mcp_haystack-0.2.0 → mcp_haystack-0.3.0}/src/haystack_integrations/tools/mcp/__init__.py

@@ -14,6 +14,8 @@ from .mcp_tool import (
     SSEServerInfo,
     StdioClient,
     StdioServerInfo,
+    StreamableHttpClient,
+    StreamableHttpServerInfo,
 )
 from .mcp_toolset import MCPToolset
 
@@ -30,4 +32,6 @@ __all__ = [
     "SSEServerInfo",
     "StdioClient",
     "StdioServerInfo",
+    "StreamableHttpClient",
+    "StreamableHttpServerInfo",
 ]