langchain-mcp-tools 0.2.3__py3-none-any.whl → 0.2.4__py3-none-any.whl

langchain_mcp_tools/__init__.py

@@ -3,4 +3,7 @@ from .langchain_mcp_tools import (
   convert_mcp_to_langchain_tools,
   McpServerCleanupFn,
   McpServersConfig,
+  McpServerCommandBasedConfig,
+  McpServerUrlBasedConfig,
+  SingleMcpServerConfig,
 )

langchain_mcp_tools/langchain_mcp_tools.py

@@ -38,6 +38,31 @@ except ImportError as e:
 
 
 class McpServerCommandBasedConfig(TypedDict):
+    """Configuration for an MCP server launched via command line.
+
+    This configuration is used for local MCP servers that are started as child
+    processes using the stdio client. It defines the command to run, optional
+    arguments, environment variables, working directory, and error logging
+    options.
+
+    Attributes:
+        command: The executable command to run (e.g., "npx", "uvx", "python").
+        args: Optional list of command-line arguments to pass to the command.
+        env: Optional dictionary of environment variables to set for the
+                process.
+        cwd: Optional working directory where the command will be executed.
+        errlog: Optional file-like object for redirecting the server's stderr
+                output.
+
+    Example:
+        {
+            "command": "npx",
+            "args": ["-y", "@modelcontextprotocol/server-filesystem", "."],
+            "env": {"NODE_ENV": "production"},
+            "cwd": "/path/to/working/directory",
+            "errlog": open("server.log", "w")
+        }
+    """
     command: str
     args: NotRequired[list[str] | None]
     env: NotRequired[dict[str, str] | None]
@@ -46,21 +71,81 @@ class McpServerCommandBasedConfig(TypedDict):
 
 
 class McpServerUrlBasedConfig(TypedDict):
+    """Configuration for a remote MCP server accessed via URL.
+
+    This configuration is used for remote MCP servers that are accessed via
+    HTTP/HTTPS (Server-Sent Events) or WebSocket connections. It defines the
+    URL to connect to and optional HTTP headers for authentication.
+
+    Attributes:
+        url: The URL of the remote MCP server. For SSE servers,
+                use http:// or https:// prefix. For WebSocket servers,
+                use ws:// or wss:// prefix.
+        headers: Optional dictionary of HTTP headers to include in the request,
+                typically used for authentication (e.g., bearer tokens).
+
+    Example for SSE server:
+        {
+            "url": "https://example.com/mcp/sse",
+            "headers": {"Authorization": "Bearer token123"}
+        }
+
+    Example for WebSocket server:
+        {
+            "url": "wss://example.com/mcp/ws"
+        }
+    """
     url: str
     headers: NotRequired[dict[str, str] | None]
 
 
-McpServerConfig = McpServerCommandBasedConfig | McpServerUrlBasedConfig
-
-McpServersConfig = dict[str, McpServerConfig]
+# Type for a single MCP server configuration, which can be either
+# command-based or URL-based.
+SingleMcpServerConfig = McpServerCommandBasedConfig | McpServerUrlBasedConfig
+"""Configuration for a single MCP server, either command-based or URL-based.
+
+This type represents the configuration for a single MCP server, which can
+be either:
+1. A local server launched via command line (McpServerCommandBasedConfig)
+2. A remote server accessed via URL (McpServerUrlBasedConfig)
+
+The type is determined by the presence of either the "command" key
+(for command-based) or the "url" key (for URL-based).
+"""
+
+# Configuration dictionary for multiple MCP servers
+McpServersConfig = dict[str, SingleMcpServerConfig]
+"""Configuration dictionary for multiple MCP servers.
+
+A dictionary mapping server names (as strings) to their respective
+configurations. Each server name acts as a logical identifier used for logging
+and debugging. The configuration for each server can be either command-based
+or URL-based.
+
+Example:
+    {
+        "filesystem": {
+            "command": "npx",
+            "args": ["-y", "@modelcontextprotocol/server-filesystem", "."]
+        },
+        "fetch": {
+            "command": "uvx",
+            "args": ["mcp-server-fetch"]
+        },
+        "remote-server": {
+            "url": "https://example.com/mcp/sse",
+            "headers": {"Authorization": "Bearer token123"}
+        }
+    }
+"""
 
 
 def fix_schema(schema: dict) -> dict:
     """Converts JSON Schema "type": ["string", "null"] to "anyOf" format.
-    
+
     Args:
         schema: A JSON schema dictionary
-        
+
     Returns:
         Modified schema with converted type formats
     """
@@ -83,7 +168,7 @@ Transport: TypeAlias = tuple[
 
 async def spawn_mcp_server_and_get_transport(
     server_name: str,
-    server_config: McpServerConfig,
+    server_config: SingleMcpServerConfig,
     exit_stack: AsyncExitStack,
     logger: logging.Logger = logging.getLogger(__name__)
 ) -> Transport:
@@ -233,15 +318,15 @@ async def get_mcp_server_tools(
 
                 async def _arun(self, **kwargs: Any) -> Any:
                     """Asynchronously executes the tool with given arguments.
-                    
+
                     Logs input/output and handles errors.
-                    
+
                     Args:
                         **kwargs: Arguments to be passed to the MCP tool
-                        
+
                     Returns:
                         Formatted response from the MCP tool as a string
-                        
+
                     Raises:
                         ToolException: If the tool execution fails
                     """
@@ -319,7 +404,7 @@ async def get_mcp_server_tools(
 # A very simple pre-configured logger for fallback
 def init_logger() -> logging.Logger:
     """Creates a simple pre-configured logger.
-    
+
     Returns:
         A configured Logger instance
     """
@@ -332,10 +417,22 @@ def init_logger() -> logging.Logger:
 
 # Type hint for cleanup function
 McpServerCleanupFn = Callable[[], Awaitable[None]]
+"""Type for the async cleanup function returned by
+    convert_mcp_to_langchain_tools.
+
+This represents an asynchronous function that takes no arguments and returns
+nothing. It's used to properly shut down all MCP server connections and clean
+up resources when the tools are no longer needed.
+
+Example usage:
+    tools, cleanup = await convert_mcp_to_langchain_tools(server_configs)
+    # Use tools...
+    await cleanup()  # Clean up resources when done
+"""
 
 
 async def convert_mcp_to_langchain_tools(
-    server_configs: dict[str, McpServerConfig],
+    server_configs: McpServersConfig,
     logger: logging.Logger | None = None
 ) -> tuple[list[BaseTool], McpServerCleanupFn]:
     """Initialize multiple MCP servers and convert their tools to
@@ -369,11 +466,11 @@ async def convert_mcp_to_langchain_tools(
                 "command": "npx", "args": ["-y","@h1deya/mcp-server-weather"]
             }
         }
-        
+
         tools, cleanup = await convert_mcp_to_langchain_tools(server_configs)
-        
+
         # Use tools...
-        
+
         await cleanup()
     """
 

{langchain_mcp_tools-0.2.3.dist-info → langchain_mcp_tools-0.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: langchain-mcp-tools
-Version: 0.2.3
+Version: 0.2.4
 Summary: Model Context Protocol (MCP) To LangChain Tools Conversion Utility
 Project-URL: Bug Tracker, https://github.com/hideya/langchain-mcp-tools-py/issues
 Project-URL: Source Code, https://github.com/hideya/langchain-mcp-tools-py
@@ -26,6 +26,16 @@ Dynamic: license-file
 
 # MCP To LangChain Tools Conversion Utility [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/hideya/langchain-mcp-tools-py/blob/main/LICENSE) [![pypi version](https://img.shields.io/pypi/v/langchain-mcp-tools.svg)](https://pypi.org/project/langchain-mcp-tools/)
 
+## NOTE
+
+LangChain's official **LangChain MCP Adapters** library has been released at:
+- pypi: https://pypi.org/project/langchain-mcp-adapters/
+- github: https://github.com/langchain-ai/langchain-mcp-adapters
+
+You may want to consider using the above if you don't have specific needs for using this library...
+
+## Introduction
+
 This package is intended to simplify the use of
 [Model Context Protocol (MCP)](https://modelcontextprotocol.io/)
 server tools with LangChain / Python.

langchain_mcp_tools-0.2.4.dist-info/RECORD

@@ -0,0 +1,8 @@
+langchain_mcp_tools/__init__.py,sha256=CYyhniRN10ktRD1z06JyBoeo_m72Q8OIbqHjh-OGoFA,197
+langchain_mcp_tools/langchain_mcp_tools.py,sha256=LximGy_0QYKuwsKFr5SvUwMZ7475CIJWxLtNDq68b-g,19377
+langchain_mcp_tools/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+langchain_mcp_tools-0.2.4.dist-info/licenses/LICENSE,sha256=CRC91e8v116gCpnp7h49oIa6_zjhxqnHFTREeoZFJwA,1072
+langchain_mcp_tools-0.2.4.dist-info/METADATA,sha256=RJ00zZEh3UCSe6S6B_aaD4YZRiYd3SemWQrPrO9BM8M,9377
+langchain_mcp_tools-0.2.4.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+langchain_mcp_tools-0.2.4.dist-info/top_level.txt,sha256=aR_9V2A1Yt-Bca60KmndmGLUWb2wiM5IOG-Gkaf1dxY,20
+langchain_mcp_tools-0.2.4.dist-info/RECORD,,

{langchain_mcp_tools-0.2.3.dist-info → langchain_mcp_tools-0.2.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (79.0.0)
+Generator: setuptools (79.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

langchain_mcp_tools-0.2.3.dist-info/RECORD

@@ -1,8 +0,0 @@
-langchain_mcp_tools/__init__.py,sha256=iatHG2fCpz143wgQUZpyFVilgri4yOh2P0vxr22gguE,114
-langchain_mcp_tools/langchain_mcp_tools.py,sha256=3XfJUW98usqrWmn1RqbVzVr_Z4piv8PLzAm29YVj6z4,15806
-langchain_mcp_tools/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-langchain_mcp_tools-0.2.3.dist-info/licenses/LICENSE,sha256=CRC91e8v116gCpnp7h49oIa6_zjhxqnHFTREeoZFJwA,1072
-langchain_mcp_tools-0.2.3.dist-info/METADATA,sha256=PPZz0kgmD2JQfUntk4D9R1gcm5DZZ_utV6L0YRo3b-M,9049
-langchain_mcp_tools-0.2.3.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
-langchain_mcp_tools-0.2.3.dist-info/top_level.txt,sha256=aR_9V2A1Yt-Bca60KmndmGLUWb2wiM5IOG-Gkaf1dxY,20
-langchain_mcp_tools-0.2.3.dist-info/RECORD,,