fix: refs styling (#354)

mdrxy · web-flow · commit 8b02c5316de7 · 2025-10-30T17:35:09.000-04:00
diff --git a/langchain_mcp_adapters/client.py b/langchain_mcp_adapters/client.py
@@ -1,6 +1,6 @@
 """Client for connecting to multiple MCP servers and loading LangChain tools/resources.
 
-This module provides the MultiServerMCPClient class for managing connections to multiple
+This module provides the `MultiServerMCPClient` class for managing connections to multiple
 MCP servers and loading tools, prompts, and resources from them.
 """
 
@@ -55,49 +55,49 @@ def __init__(
         callbacks: Callbacks | None = None,
         tool_interceptors: list[ToolCallInterceptor] | None = None,
     ) -> None:
-        """Initialize a MultiServerMCPClient with MCP servers connections.
+        """Initialize a `MultiServerMCPClient` with MCP servers connections.
 
         Args:
-            connections: A dictionary mapping server names to connection configurations.
-                If None, no initial connections are established.
+            connections: A `dict` mapping server names to connection configurations. If
+                `None`, no initial connections are established.
             callbacks: Optional callbacks for handling notifications and events.
             tool_interceptors: Optional list of tool call interceptors for modifying
                 requests and responses.
 
-        Example: basic usage (starting a new session on each tool call)
-
-        ```python
-        from langchain_mcp_adapters.client import MultiServerMCPClient
-
-        client = MultiServerMCPClient(
-            {
-                "math": {
-                    "command": "python",
-                    # Make sure to update to the full absolute path to your
-                    # math_server.py file
-                    "args": ["/path/to/math_server.py"],
-                    "transport": "stdio",
-                },
-                "weather": {
-                    # Make sure you start your weather server on port 8000
-                    "url": "http://localhost:8000/mcp",
-                    "transport": "streamable_http",
+        !!! example "Basic usage (starting a new session on each tool call)"
+
+            ```python
+            from langchain_mcp_adapters.client import MultiServerMCPClient
+
+            client = MultiServerMCPClient(
+                {
+                    "math": {
+                        "command": "python",
+                        # Make sure to update to the full absolute path to your
+                        # math_server.py file
+                        "args": ["/path/to/math_server.py"],
+                        "transport": "stdio",
+                    },
+                    "weather": {
+                        # Make sure you start your weather server on port 8000
+                        "url": "http://localhost:8000/mcp",
+                        "transport": "streamable_http",
+                    }
                 }
-            }
-        )
-        all_tools = await client.get_tools()
-        ```
+            )
+            all_tools = await client.get_tools()
+            ```
 
-        Example: explicitly starting a session
+        !!! example "Explicitly starting a session"
 
-        ```python
-        from langchain_mcp_adapters.client import MultiServerMCPClient
-        from langchain_mcp_adapters.tools import load_mcp_tools
+            ```python
+            from langchain_mcp_adapters.client import MultiServerMCPClient
+            from langchain_mcp_adapters.tools import load_mcp_tools
 
-        client = MultiServerMCPClient({...})
-        async with client.session("math") as session:
-            tools = await load_mcp_tools(session)
-        ```
+            client = MultiServerMCPClient({...})
+            async with client.session("math") as session:
+                tools = await load_mcp_tools(session)
+            ```
         """
         self.connections: dict[str, Connection] = (
             connections if connections is not None else {}
@@ -122,7 +122,7 @@ async def session(
             ValueError: If the server name is not found in the connections
 
         Yields:
-            An initialized ClientSession
+            An initialized `ClientSession`
 
         """
         if server_name not in self.connections:
@@ -148,12 +148,14 @@ async def get_tools(self, *, server_name: str | None = None) -> list[BaseTool]:
 
         Args:
             server_name: Optional name of the server to get tools from.
-                If None, all tools from all servers will be returned (default).
+                If `None`, all tools from all servers will be returned.
+
+        !!! note
 
-        NOTE: a new session will be created for each tool call
+            A new session will be created for each tool call
 
         Returns:
-            A list of LangChain tools
+            A list of LangChain [tools](https://docs.langchain.com/oss/python/langchain/tools)
 
         """
         if server_name is not None:
@@ -214,7 +216,7 @@ async def get_resources(
                 all resources will be loaded.
 
         Returns:
-            A list of LangChain Blobs
+            A list of LangChain [Blob][langchain_core.documents.base.Blob] objects.
 
         """
         async with self.session(server_name) as session:
diff --git a/langchain_mcp_adapters/prompts.py b/langchain_mcp_adapters/prompts.py
@@ -1,4 +1,4 @@
-"""Prompts adapter for converting MCP prompts to LangChain messages.
+"""Prompts adapter for converting MCP prompts to LangChain [messages](https://docs.langchain.com/oss/python/langchain/messages).
 
 This module provides functionality to convert MCP prompt messages into LangChain
 message objects, handling both user and assistant message types.
@@ -41,15 +41,16 @@ async def load_mcp_prompt(
     *,
     arguments: dict[str, Any] | None = None,
 ) -> list[HumanMessage | AIMessage]:
-    """Load MCP prompt and convert to LangChain messages.
+    """Load MCP prompt and convert to LangChain [messages](https://docs.langchain.com/oss/python/langchain/messages).
 
     Args:
         session: The MCP client session.
         name: Name of the prompt to load.
         arguments: Optional arguments to pass to the prompt.
 
     Returns:
-        A list of LangChain messages converted from the MCP prompt.
+        A list of LangChain [messages](https://docs.langchain.com/oss/python/langchain/messages)
+            converted from the MCP prompt.
     """
     response = await session.get_prompt(name, arguments)
     return [
diff --git a/langchain_mcp_adapters/resources.py b/langchain_mcp_adapters/resources.py
@@ -1,8 +1,8 @@
-"""Resources adapter for converting MCP resources to LangChain Blobs.
+"""Resources adapter for converting MCP resources to LangChain [Blob objects][langchain_core.documents.base.Blob].
 
 This module provides functionality to convert MCP resources into LangChain Blob
 objects, handling both text and binary resource content types.
-"""
+"""  # noqa: E501
 
 import base64
 
@@ -38,15 +38,15 @@ def convert_mcp_resource_to_langchain_blob(
 
 
 async def get_mcp_resource(session: ClientSession, uri: str) -> list[Blob]:
-    """Fetch a single MCP resource and convert it to LangChain Blobs.
+    """Fetch a single MCP resource and convert it to LangChain [Blob objects][langchain_core.documents.base.Blob].
 
     Args:
         session: MCP client session.
         uri: URI of the resource to fetch.
 
     Returns:
-        A list of LangChain Blobs.
-    """
+        A list of LangChain [Blob][langchain_core.documents.base.Blob] objects.
+    """  # noqa: E501
     contents_result = await session.read_resource(uri)
     if not contents_result.contents or len(contents_result.contents) == 0:
         return []
@@ -62,21 +62,24 @@ async def load_mcp_resources(
     *,
     uris: str | list[str] | None = None,
 ) -> list[Blob]:
-    """Load MCP resources and convert them to LangChain Blobs.
+    """Load MCP resources and convert them to LangChain [Blob objects][langchain_core.documents.base.Blob].
 
     Args:
         session: MCP client session.
-        uris: List of URIs to load. If None, all resources will be loaded.
-            Note: Dynamic resources will NOT be loaded when None is specified,
-            as they require parameters and are ignored by the MCP SDK's
-            session.list_resources() method.
+        uris: List of URIs to load. If `None`, all resources will be loaded.
+
+            !!! note
+
+                Dynamic resources will NOT be loaded when `None` is specified,
+                as they require parameters and are ignored by the MCP SDK's
+                `session.list_resources()` method.
 
     Returns:
-        A list of LangChain Blobs.
+        A list of LangChain [Blob][langchain_core.documents.base.Blob] objects.
 
     Raises:
         RuntimeError: If an error occurs while fetching a resource.
-    """
+    """  # noqa: E501
     blobs = []
 
     if uris is None:
diff --git a/langchain_mcp_adapters/tools.py b/langchain_mcp_adapters/tools.py
@@ -314,18 +314,18 @@ async def load_mcp_tools(
     tool_interceptors: list[ToolCallInterceptor] | None = None,
     server_name: str | None = None,
 ) -> list[BaseTool]:
-    """Load all available MCP tools and convert them to LangChain tools.
+    """Load all available MCP tools and convert them to LangChain [tools](https://docs.langchain.com/oss/python/langchain/tools).
 
     Args:
-        session: The MCP client session. If None, connection must be provided.
-        connection: Connection config to create a new session if session is None.
-        callbacks: Optional callbacks for handling notifications and events.
+        session: The MCP client session. If `None`, connection must be provided.
+        connection: Connection config to create a new session if session is `None`.
+        callbacks: Optional `Callbacks` for handling notifications and events.
         tool_interceptors: Optional list of interceptors for tool call processing.
         server_name: Name of the server these tools belong to.
 
     Returns:
-        List of LangChain tools. Tool annotations are returned as part
-        of the tool metadata object.
+        List of LangChain [tools](https://docs.langchain.com/oss/python/langchain/tools).
+            Tool annotations are returned as part of the tool metadata object.
 
     Raises:
         ValueError: If neither session nor connection is provided.
