gllm-tools-binary 0.1.3__py3-none-any.whl

gllm_tools/mcp/client/__init__.pyi

@@ -0,0 +1,3 @@
+from gllm_tools.mcp.client.client import MCPClient as MCPClient
+
+__all__ = ['MCPClient']

gllm_tools/mcp/client/client.pyi

@@ -0,0 +1,105 @@
+from _typeshed import Incomplete
+from abc import ABC
+from gllm_tools.mcp.client.config import MCPConfiguration as MCPConfiguration
+from gllm_tools.mcp.client.resource import MCPResource as MCPResource, load_mcp_resources as load_mcp_resources
+from gllm_tools.mcp.client.session import create_session as create_session
+from gllm_tools.mcp.client.tool import MCPTool as MCPTool, load_mcp_tools as load_mcp_tools
+from typing import Any
+
+logger: Incomplete
+
+class MCPClient(ABC):
+    """The MCP (Model Context Protocol) Client handler.
+
+    Responsible for creating MCP client sessions, managing its lifecycle, and
+    connecting generating the tools, resources, and all server features MCP
+    has to offer.
+
+    Attributes:
+        servers: A dictionary of MCP server configurations.
+    """
+    servers: dict[str, MCPConfiguration]
+    def __init__(self, servers: dict[str, MCPConfiguration]) -> None:
+        """Creates a new MCP client.
+
+        Args:
+            servers (dict[str, MCPConfiguration]): A dictionary of MCP server
+                configurations.
+
+        Example: how to get the tools from the MCP servers.
+
+        ```python
+        client = MCPClient(servers)
+        tools = await client.get_tools()
+        ```
+        """
+    def get_servers(self) -> list[str]:
+        '''Returns a list of available MCP servers.
+
+        This function retrieves the names of the available MCP servers from the
+        MCP servers configuration dictionary.
+
+        Returns:
+            list[str]: A list of available MCP servers.
+
+        Example: getting the available MCP servers:
+
+        ```python
+        servers = {
+            "github": MCPConfiguration(...),
+            "slack": MCPConfiguration(...),
+        }
+        client = MCPClient(servers)
+        servers = await client.get_servers()
+        print(servers)
+        # Output: ["github", "slack"]
+        ```
+        '''
+    async def get_tools(self, server: str | None = None) -> list[MCPTool | Any]:
+        """Returns a list of available tools.
+
+        This function retrieves the names of the available tools from the
+        MCP servers configuration dictionary.
+
+        NOTE: a new session is created for each tool call.
+
+        Args:
+            server (str | None): The name of the MCP server to connect to.
+
+        Returns:
+            list[MCPTool | Any]: A list of available tools. The tool can be adapted to a specific
+                framework's tool using `tool_adapter`.
+        """
+    async def get_resources(self, server: str | None = None) -> list[MCPResource]:
+        """Returns a list of available resources.
+
+        This function retrieves the names of the available resources from the
+        MCP servers configuration dictionary. Note that this function only
+        returns the metadata of the resources, not the actual content. For the
+        content, use the `get_resource` function.
+
+        NOTE: a new session is created for each resource call.
+
+        Args:
+            server (str | None): The name of the MCP server to connect to.
+
+        Returns:
+            list[MCPResource]: A list of available resources. Only the metadata of the
+                resources is returned.
+        """
+    async def get_resource(self, server: str, resource_uri: str) -> Any:
+        """Returns a resource's entire content.
+
+        This function retrieves the resource from the MCP servers configuration dictionary.
+        Be careful with this function, as it will return the entire content of the resource,
+
+        NOTE: a new session is created for each resource call.
+
+        Args:
+            server (str): The name of the MCP server to connect to.
+            resource_uri (str): The URI of the resource to retrieve.
+
+        Returns:
+            Any: The resource's entire content. The resource can be adapted to a specific
+                framework's resource using `resource_adapter`.
+        """

gllm_tools/mcp/client/config.pyi

@@ -0,0 +1,54 @@
+from _typeshed import Incomplete
+from typing import Any, Literal, TypedDict
+
+STDIO_TRANSPORT: str
+SSE_TRANSPORT: str
+STREAMABLE_HTTP_TRANSPORT: str
+EncodingErrorHandler: Incomplete
+
+class MCPConfiguration(TypedDict):
+    """Base MCP Configuration class. Not intended to be used directly."""
+    transport: Literal['stdio', 'sse', 'streamable_http']
+    session_kwargs: dict[str, Any] | None
+
+class StdioConfiguration(MCPConfiguration):
+    """Configuration for STDIO-based MCP.
+
+    STDIO-based MCP uses the `subprocess` module to execute commands.
+    More information can be found here:
+    https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#stdio
+    """
+    transport: Literal['stdio']
+    command: str
+    args: list[str]
+    env: dict[str, str]
+    cwd: str
+    encoding: str
+    encoding_error_handler: EncodingErrorHandler
+
+class SseConfiguration(MCPConfiguration):
+    """Configuration for SSE-based MCP.
+
+    The SSE MCP Transport is a deprecated transport that uses Server-Sent
+    Events to send messages to the client. More information can be found
+    here:
+    https://modelcontextprotocol.io/specification/2024-11-05/basic/transports#http-with-sse
+    """
+    transport: Literal['sse']
+    url: str
+    headers: dict[str, str]
+    timeout: float | None
+    sse_read_timeout: float | None
+
+class StreamConfiguration(MCPConfiguration):
+    """The configuration for connecting to a Streamable HTTP server.
+
+    The Streamable HTTP server is a HTTP Protocol that replaces the
+    Server-Sent Events transport. More information can be found here:
+    https://modelcontextprotocol.io/specification/2025-03-26/basic/transports#streamable-http
+    """
+    transport: Literal['streamable_http']
+    url: str
+    headers: dict[str, str]
+    timeout: float | None
+    sse_read_timeout: float | None

gllm_tools/mcp/client/langchain/__init__.pyi

@@ -0,0 +1,3 @@
+from gllm_tools.mcp.client.langchain.client import LangchainMCPClient as LangchainMCPClient
+
+__all__ = ['LangchainMCPClient']

gllm_tools/mcp/client/langchain/client.pyi

@@ -0,0 +1,17 @@
+from gllm_tools.mcp.client.client import MCPClient as MCPClient
+from gllm_tools.mcp.client.config import MCPConfiguration as MCPConfiguration
+from gllm_tools.mcp.client.resource import MCPResource as MCPResource
+from gllm_tools.mcp.client.session import create_session as create_session
+from gllm_tools.mcp.client.tool import MCPTool as MCPTool
+from mcp.types import CallToolResult as CallToolResult, EmbeddedResource, ImageContent
+from pydantic import AnyUrl as AnyUrl
+
+NonTextContent = ImageContent | EmbeddedResource
+
+class LangchainMCPClient(MCPClient):
+    """Langchain MCP Client.
+
+    This client is a wrapper around the MCPClient that converts MCP tools and resources
+    into Langchain tools and resources. It is used to integrate MCP with Langchain.
+    """
+    RESOURCE_FETCH_TIMEOUT: int

gllm_tools/mcp/client/resource.pyi

@@ -0,0 +1,41 @@
+from _typeshed import Incomplete
+from gllm_tools.mcp.client.config import MCPConfiguration as MCPConfiguration
+from gllm_tools.mcp.client.session import create_session as create_session
+from mcp.types import Annotations as Annotations
+from pydantic import AnyUrl as AnyUrl, UrlConstraints as UrlConstraints
+from typing import Annotated
+
+logger: Incomplete
+
+class MCPResource:
+    """The MCP (Model Context Protocol) Resource."""
+    uri: Annotated[AnyUrl, None]
+    name: str
+    description: str | None
+    mime_type: str | None
+    size: int | None
+    annotations: Annotations | None
+    def __init__(self, name: str, description: str | None = None, uri: AnyUrl | None = None, mime_type: str | None = None, size: int | None = None, annotations: Annotations | None = None) -> None:
+        """Constructs a new MCP resource.
+
+        Args:
+            name (str): The name of the resource.
+            description (str | None): The description of the resource.
+            uri (AnyUrl | None): The URI of the resource.
+            mime_type (str | None): The MIME type of the resource.
+            size (int | None): The size of the resource in bytes.
+            annotations (Annotations | None): The annotations of the resource.
+        """
+
+async def load_mcp_resources(*, config: MCPConfiguration) -> list[MCPResource]:
+    """Load all available MCP resources and convert them to resource objects.
+
+    This function only returns the metadata of the resources, not the actual
+    content.
+
+    Args:
+        config (MCPConfiguration): The MCP server configuration.
+
+    Returns:
+        list[MCPResource]: A list of MCP resources.
+    """

gllm_tools/mcp/client/session.pyi

@@ -0,0 +1,21 @@
+from _typeshed import Incomplete
+from contextlib import asynccontextmanager
+from gllm_tools.mcp.client.config import EncodingErrorHandler as EncodingErrorHandler, MCPConfiguration as MCPConfiguration, SSE_TRANSPORT as SSE_TRANSPORT, STDIO_TRANSPORT as STDIO_TRANSPORT, SseConfiguration as SseConfiguration, StdioConfiguration as StdioConfiguration, StreamConfiguration as StreamConfiguration
+from mcp import ClientSession
+from typing import AsyncIterator
+
+logger: Incomplete
+DEFAULT_ENCODING: str
+DEFAULT_ENCODING_ERROR_HANDLER: EncodingErrorHandler
+DEFAULT_HTTP_TIMEOUT: int
+DEFAULT_SSE_READ_TIMEOUT: Incomplete
+DEFAULT_STREAMABLE_HTTP_TIMEOUT: Incomplete
+DEFAULT_STREAMABLE_HTTP_SSE_READ_TIMEOUT: Incomplete
+
+@asynccontextmanager
+async def create_session(config: MCPConfiguration) -> AsyncIterator[ClientSession]:
+    """Create a new session to an MCP server.
+
+    Args:
+        config: MCP configuration
+    """

gllm_tools/mcp/client/tool.pyi

@@ -0,0 +1,43 @@
+from _typeshed import Incomplete
+from gllm_tools.mcp.client.config import MCPConfiguration as MCPConfiguration
+from gllm_tools.mcp.client.session import create_session as create_session
+from mcp.types import ToolAnnotations as ToolAnnotations
+from typing import Any, Callable
+
+logger: Incomplete
+
+class MCPTool:
+    """Represents an MCP tool.
+
+    The MCP tool is an agnostic representation of a tool created by an MCP
+    server. It is not intended to be used directly, but rather to be used as
+    a base class for other tools.
+    """
+    name: str
+    description: str | None
+    parameters: dict[str, Any]
+    annotations: ToolAnnotations | None
+    model_config: Incomplete
+    def __init__(self, *, name: str, parameters: dict[str, Any], description: str | None = None, annotations: ToolAnnotations | None = None) -> None:
+        """Constructs a new MCP tool.
+
+        Args:
+            name (str): The name of the tool.
+            parameters (dict[str, Any]): The parameters of the tool.
+            description (str | None): The description of the tool.
+            annotations (ToolAnnotations | None): The annotations of the tool.
+        """
+
+async def load_mcp_tools(*, config: MCPConfiguration, tool_adapter: Callable[[MCPTool, MCPConfiguration], Any] | None = None) -> list[Any]:
+    """Load all available MCP tools and convert them to tool objects.
+
+    Args:
+        config (MCPConfiguration): The MCP server configuration.
+        tool_adapter (Callable[[MCPTool, MCPConfiguration], Any] | None): The adapter to use to
+            convert the MCP tools to a specific framework's tool. If not provided, the
+            MCP tools are returned as is.
+
+    Returns:
+        list[Any]: A list of MCP tools. The tool can be adapted to a specific
+        tool using `tool_adapter`.
+    """

gllm_tools_binary-0.1.3.dist-info/METADATA

@@ -0,0 +1,87 @@
+Metadata-Version: 2.1
+Name: gllm-tools-binary
+Version: 0.1.3
+Summary: A library for managing tools in Gen AI applications.
+Author: Raymond Christopher
+Author-email: raymond.christopher@gdplabs.id
+Requires-Python: >=3.11,<3.14
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: e2b-code-interpreter (>=1.5.2,<2.0.0)
+Requires-Dist: gllm-inference-binary[anthropic,openai] (>=0.5.5,<0.6.0)
+Requires-Dist: langchain-core (>=0.3.63,<0.4.0)
+Requires-Dist: mcp (>=1.9.1,<2.0.0)
+Requires-Dist: pydantic (>=2.9.1,<3.0.0)
+Description-Content-Type: text/markdown
+
+# GLLM Tools
+
+## Description
+
+A library providing a collection of utility tools and functions for Generative AI applications.
+
+## Installation
+
+### Prerequisites
+- Python 3.11+ - [Install here](https://www.python.org/downloads/)
+- Pip (if using Pip) - [Install here](https://pip.pypa.io/en/stable/installation/)
+- Poetry 1.8.1+ (if using Poetry) - [Install here](https://python-poetry.org/docs/#installation)
+- Git (if using Git) - [Install here](https://git-scm.com/downloads)
+- For artifact registry installation:
+  - Google Cloud CLI - [[installed](https://cloud.google.com/sdk/docs/) and [authenticated](https://cloud.google.com/docs/authentication/gcloud)]
+  - Access to the [GDP Labs SDK artifact registry](https://console.cloud.google.com/artifacts/python/gdp-labs/asia-southeast2/gen-ai?project=gdp-labs)
+- For git installation:
+  - Access to the [GDP Labs SDK github repository](https://github.com/GDP-ADMIN/gen-ai-internal)
+
+### 1. Installation from Artifact Registry
+Choose one of the following methods to install the package:
+
+#### Using pip
+```bash
+pip install keyring keyrings.gl-artifactregistry-auth
+pip install gllm-tools-binary --index-url https://glsdk.gdplabs.id/gen-ai/simple
+```
+
+#### Using Poetry
+```bash
+poetry source add --priority=explicit gen-ai https://glsdk.gdplabs.id/gen-ai/simple
+poetry config http-basic.gen-ai oauth2accesstoken "$(gcloud auth print-access-token)"
+poetry add --source gen-ai gllm-tools-binary
+```
+
+### 2. Development Installation (Git)
+For development purposes, you can install directly from the Git repository:
+```bash
+poetry add "git+ssh://git@github.com/GDP-ADMIN/gen-ai-internal.git#subdirectory=libs/gllm-tools"
+```
+
+## Managing Dependencies
+1. Go to root folder of `gllm-tools` module, e.g. `cd libs/gllm-tools`.
+2. Run `poetry shell` to create a virtual environment.
+3. Run `poetry lock` to create a lock file if you haven't done it yet.
+4. Run `poetry install` to install the `gllm-tools` requirements for the first time.
+5. Run `poetry update` if you update any dependency module version at `pyproject.toml`.
+
+## Contributing
+Please refer to this [Python Style Guide](https://docs.google.com/document/d/1uRggCrHnVfDPBnG641FyQBwUwLoFw0kTzNqRm92vUwM/edit?usp=sharing)
+to get information about code style, documentation standard, and SCA that you need to use when contributing to this project
+
+1. Activate `pre-commit` hooks using `pre-commit install`
+2. Run `poetry shell` to create a virtual environment.
+3. Run `poetry lock` to create a lock file if you haven't done it yet.
+4. Run `poetry install` to install the `gllm-tools` requirements for the first time.
+5. Run `which python` to get the path to be referenced at Visual Studio Code interpreter path (`Ctrl`+`Shift`+`P` or `Cmd`+`Shift`+`P`)
+6. Try running the unit test to see if it's working:
+```bash
+poetry run pytest -s tests/unit_tests/
+```
+
+## Components
+
+The main components of the GLLM Tools are listed here alongside their documentations.
+
+### MCP (Model Context Protocol)
+
+The MCP documentation can be found [here](./gllm_tools/mcp/README.md).
+

gllm_tools_binary-0.1.3.dist-info/RECORD

@@ -0,0 +1,13 @@
+gllm_tools/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gllm_tools/mcp/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gllm_tools/mcp/client/__init__.pyi,sha256=kPg839SRWEoiWiVRoTpWuTyGVFknI9qu8pUi9PfPj-4,92
+gllm_tools/mcp/client/client.pyi,sha256=CN1sH3P66uolQD082AMCUGToC767fVXLMtLOTA87uzs,4012
+gllm_tools/mcp/client/config.pyi,sha256=0Siou1etCyn-m6XFhDP7WK4tI3eV3jAmj6bAS8abnt4,1881
+gllm_tools/mcp/client/langchain/__init__.pyi,sha256=4tTZkg7HrVlzvqUhg9TMxMevFB0ChLo78HwG14Wi8XI,129
+gllm_tools/mcp/client/langchain/client.pyi,sha256=vqWQOs6QJdIfUWhdLuqTFurnjvHy3f8g5rKojEpMkHg,817
+gllm_tools/mcp/client/resource.pyi,sha256=bGYI3KWVyURUd7fnVuGxrlJbTJN3BcU3DaKvSp4buYo,1685
+gllm_tools/mcp/client/session.pyi,sha256=4KPe_krISKPZWeT_cNKKJNIn2NlRffXiECrPLC2iMvw,936
+gllm_tools/mcp/client/tool.pyi,sha256=-wN90ZOGdtl6s0WqLsrQq6dUoWtJHZWQ43Qt_6IHRWQ,1846
+gllm_tools_binary-0.1.3.dist-info/METADATA,sha256=MygHHpvwCfABHSjBczxq1xohshUbBydvaqfBxYg1ozg,3735
+gllm_tools_binary-0.1.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+gllm_tools_binary-0.1.3.dist-info/RECORD,,

gllm_tools_binary-0.1.3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.9.0
+Root-Is-Purelib: true
+Tag: py3-none-any