fix docstrings

Author: twishabansal

packages/toolbox-core/src/toolbox_core/sync_client.py

@@ -26,11 +26,10 @@
 
 class ToolboxSyncClient:
     """
-    A synchronous client for interacting with a Toolbox service.
+    An synchronous client for interacting with a Toolbox service.
 
     Provides methods to discover and load tools defined by a remote Toolbox
-    service endpoint, returning synchronous tool wrappers (`ToolboxSyncTool`).
-    It manages an underlying asynchronous `ToolboxClient`.
+    service endpoint.
     """
 
     __session: Optional[ClientSession] = None
@@ -42,7 +41,7 @@ def __init__(
         url: str,
     ):
         """
-        Initializes the ToolboxSyncClient.
+        Initializes the ToolboxClient.
 
         Args:
             url: The base URL for the Toolbox service API (e.g., "http://localhost:5000").
@@ -91,31 +90,45 @@ async def __run_as_async(self, coro: Awaitable[T]) -> T:
             asyncio.run_coroutine_threadsafe(coro, self.__loop)
         )
 
+    def close(self):
+        """
+        Synchronously closes the underlying client session. Doing so will cause
+        any tools created by this Client to cease to function.
+
+        If the session was provided externally during initialization, the caller
+        is responsible for its lifecycle, but calling close here will still
+        attempt to close it.
+        """
+        coro = self.__session.close()
+        self.__run_as_sync(coro)
+
     def load_tool(
         self,
-        tool_name: str,
+        name: str,
         auth_token_getters: dict[str, Callable[[], str]] = {},
         bound_params: Mapping[str, Union[Callable[[], Any], Any]] = {},
     ) -> ToolboxSyncTool:
         """
         Synchronously loads a tool from the server.
 
-        Retrieves the schema for the specified tool and returns a callable,
-        synchronous object (`ToolboxSyncTool`) that can be used to invoke the
+        Retrieves the schema for the specified tool from the Toolbox server and
+        returns a callable object (`ToolboxSyncTool`) that can be used to invoke the
         tool remotely.
 
         Args:
-            tool_name: Name of the tool to load.
+            name: The unique name or identifier of the tool to load.
             auth_token_getters: A mapping of authentication service names to
                 callables that return the corresponding authentication token.
             bound_params: A mapping of parameter names to bind to specific values or
                 callables that are called to produce values as needed.
 
         Returns:
-            ToolboxSyncTool: A synchronous callable object representing the loaded tool.
+            ToolboxSyncTool: A callable object representing the loaded tool, ready
+                for execution. The specific arguments and behavior of the callable
+                depend on the tool itself.
         """
         async_tool = self.__run_as_sync(
-            self.__async_client.load_tool(tool_name, auth_token_getters, bound_params)
+            self.__async_client.load_tool(name, auth_token_getters, bound_params)
         )
 
         if not self.__loop or not self.__thread:
@@ -124,27 +137,27 @@ def load_tool(
 
     def load_toolset(
         self,
-        toolset_name: str,
+        name: str,
         auth_token_getters: dict[str, Callable[[], str]] = {},
         bound_params: Mapping[str, Union[Callable[[], Any], Any]] = {},
     ) -> list[ToolboxSyncTool]:
         """
         Synchronously fetches a toolset and loads all tools defined within it.
 
         Args:
-            toolset_name: Name of the toolset to load tools from.
+            name: Name of the toolset to load tools.
             auth_token_getters: A mapping of authentication service names to
                 callables that return the corresponding authentication token.
             bound_params: A mapping of parameter names to bind to specific values or
                 callables that are called to produce values as needed.
 
         Returns:
-            list[ToolboxSyncTool]: A list of synchronous callables, one for each
-            tool defined in the toolset.
+            list[ToolboxSyncTool]: A list of callables, one for each tool defined
+            in the toolset.
         """
         async_tools = self.__run_as_sync(
             self.__async_client.load_toolset(
-                toolset_name, auth_token_getters, bound_params
+                name, auth_token_getters, bound_params
             )
         )
 
@@ -155,12 +168,6 @@ def load_toolset(
             tools.append(ToolboxSyncTool(async_tool, self.__loop, self.__thread))
         return tools
 
-    def close(self):
-        """
-        Synchronously closes the client session if it was created internally by the client.
-        """
-        coro = self.__session.close()
-        self.__run_as_sync(coro)
 
     def __enter__(self):
         """Enter the runtime context related to this client instance."""

packages/toolbox-core/src/toolbox_core/sync_tool.py

@@ -24,22 +24,28 @@
 
 class ToolboxSyncTool:
     """
-    A synchronous wrapper proxying asynchronous ToolboxTool instance.
+    A callable proxy object representing a specific tool on a remote Toolbox server.
 
-    This class allows calling the underlying async tool synchronously.
-    It also proxies methods like `add_auth_token_getters` and
-    `bind_parameters` to ensure they return new instances of this synchronous
-    wrapper.
+    Instances of this class behave like synchronous functions. When called, they
+    send a request to the corresponding tool's endpoint on the Toolbox server with
+    the provided arguments.
+
+    It utilizes Python's introspection features (`__name__`, `__doc__`,
+    `__signature__`, `__annotations__`) so that standard tools like `help()`
+    and `inspect` work as expected.
     """
 
     def __init__(
         self, async_tool: ToolboxTool, loop: AbstractEventLoop, thread: Thread
     ):
         """
-        Initializes the synchronous wrapper.
+        Initializes a callable that will trigger the tool invocation through the
+        Toolbox server.
 
         Args:
             async_tool: An instance of the asynchronous ToolboxTool.
+            loop: The event loop used to run asynchronous tasks.
+            thread: The thread to run blocking operations in.
         """
         if not isinstance(async_tool, ToolboxTool):
             raise TypeError("async_tool must be an instance of ToolboxTool")
@@ -77,21 +83,17 @@ async def __run_as_async(self, coro: Awaitable[T]) -> T:
 
     def __call__(self, *args: Any, **kwargs: Any) -> str:
         """
-        Synchronously calls the underlying remote tool.
+        Synchronously calls the remote tool with the provided arguments.
 
-        This method blocks until the tool call completes and returns
-        the result.
+        Validates arguments against the tool's signature, then sends them
+        as a JSON payload in a POST request to the tool's invoke URL.
 
         Args:
             *args: Positional arguments for the tool.
             **kwargs: Keyword arguments for the tool.
 
         Returns:
             The string result returned by the remote tool execution.
-
-        Raises:
-            Any exception raised by the underlying async tool's __call__ method
-            or during asyncio execution.
         """
         return self.__run_as_sync(self.__async_tool(**kwargs))
 
@@ -100,14 +102,16 @@ def add_auth_token_getters(
         auth_token_getters: Mapping[str, Callable[[], str]],
     ) -> "ToolboxSyncTool":
         """
-        Registers auth token getters and returns a new SyncToolboxTool instance.
+        Registers an auth token getter function that is used for AuthServices when tools
+        are invoked.
 
         Args:
             auth_token_getters: A mapping of authentication service names to
                 callables that return the corresponding authentication token.
 
         Returns:
-            A new SyncToolboxTool instance wrapping the updated async tool.
+            A new ToolboxSyncTool instance with the specified authentication token
+            getters registered.
         """
         new_async_tool = self.__async_tool.add_auth_token_getters(auth_token_getters)
         return ToolboxSyncTool(new_async_tool, self.__loop, self.__thread)
@@ -116,14 +120,14 @@ def bind_parameters(
         self, bound_params: Mapping[str, Union[Callable[[], Any], Any]]
     ) -> "ToolboxSyncTool":
         """
-        Binds parameters and returns a new SyncToolboxTool instance.
+        Binds parameters to values or callables that produce values.
 
          Args:
              bound_params: A mapping of parameter names to values or callables that
                  produce values.
 
          Returns:
-             A new SyncToolboxTool instance wrapping the updated async tool.
+             A new ToolboxSyncTool instance with the specified parameters bound.
         """
         new_async_tool = self.__async_tool.bind_parameters(bound_params)
         return ToolboxSyncTool(new_async_tool, self.__loop, self.__thread)