pygeai 0.2.7b43__tar.gz → 0.2.7b45__tar.gz

{pygeai-0.2.7b43/pygeai.egg-info → pygeai-0.2.7b45}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pygeai
-Version: 0.2.7b43
+Version: 0.2.7b45
 Summary: Software Development Kit to interact with Globant Enterprise AI.
 Author-email: Globant <geai-sdk@globant.com>
 License-Expression: MIT

pygeai-0.2.7b45/docs/geai-proxy/README.md

@@ -0,0 +1,256 @@
+# GEAI Proxy Documentation
+
+## NAME
+`geai-proxy` – proxy service for managing Model Context Protocol (MCP) servers with GEAI
+
+## SYNOPSIS
+```bash
+geai-proxy [OPTIONS] CONFIG_FILE
+```
+
+## DESCRIPTION
+The GEAI Proxy is a Python-based tool that acts as an intermediary between the GEAI API and various tool servers. It manages the registration, execution, and result handling of tool operations through a proxy service.
+
+To install:
+
+```bash
+pip install pygeai
+```
+
+## CONFIGURATION
+
+The GEAI Proxy requires two distinct types of configuration:
+
+### 1. MCP Servers Configuration
+
+This section declares the Model Context Protocol (MCP) servers that this proxy will link with GEAI. The configuration follows the Claude Desktop standard format and supports multiple servers in one file.
+
+#### Configuration File Format
+
+```json
+{
+  "mcpServers": {
+    "serverName1": {
+      "command": "command-to-launch-server",
+      "args": ["arg1", "arg2", "..."]
+    },
+    "serverName2": {
+      "command": "command-to-launch-server",
+      "args": ["arg1", "arg2", "..."]
+    }
+  }
+}
+```
+
+#### Example: Puppeteer Server
+
+```json
+{
+  "mcpServers": {
+    "puppeteer": {
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-puppeteer"]
+    }
+  }
+}
+```
+
+#### Example: Filesystem Server
+
+```json
+{
+  "mcpServers": {
+    "filesystem": {
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-filesystem", "~/mcp-shared-folder"]
+    }
+  }
+}
+```
+
+#### Example: HTTP+SSE Server
+
+```json
+{
+  "mcpServers": {
+    "markitdown": {
+      "uri": "http://localhost:5000/sse"
+    }
+  }
+}
+```
+
+#### Example: Multiple Servers Combined
+
+```json
+{
+  "mcpServers": {
+    "puppeteer": {
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-puppeteer"]
+    },
+    "filesystem": {
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-filesystem", "~/mcp-shared-folder"]
+    },
+    "markitdown": {
+      "uri": "http://localhost:5000/sse"
+    },
+    "custom-server": {
+      "command": "python",
+      "args": ["path/to/your/custom_mcp_server.py"]
+    }
+  }
+}
+```
+
+## PUBLIC TOOL REGISTRATION
+
+Tools provided by both MCP and A2A servers can be published to GEAI under a public namespace by including the `public_prefix` field in their configuration entry.
+
+This allows tools to be registered under a well-defined global identifier, making them discoverable and shareable across proxies and clients.
+
+### MCP Server Example with Public Prefix
+
+Registers tools from the `puppeteer` MCP server under the prefix `com.globant.puppeteer`:
+
+```json
+{
+  "mcpServers": {
+    "public_prefix": "com.globant.puppeteer",
+    "puppeteer": {
+      "command": "npx",
+      "args": ["-y", "@modelcontextprotocol/server-puppeteer"]
+    }
+  }
+}
+```
+
+### A2A Server Example with Public Prefix
+
+Registers tools from the `hello-world` A2A agent under the prefix `com.genexus.a2a.sampleagent`:
+
+```json
+{
+  "a2aServers": {
+    "hello-world": {
+      "public_prefix": "com.genexus.a2a.sampleagent",
+      "url": "http://localhost:9999",
+      "headers": {
+        "Authorization": "Bearer fh84ff...."
+      }
+    }
+  }
+}
+```
+
+### Resulting Tool Identifiers
+
+For example, a tool named `translate_text` would be available as:
+
+```text
+com.genexus.a2a.sampleagent.translate_text
+```
+
+### 2. Proxy Authentication Configuration
+
+This section establishes the connection between the proxy and GEAI and manages user aliases.
+
+#### Automatic Configuration (First Run)
+
+```bash
+geai-proxy sample-mcp-config.json --alias myalias
+```
+
+#### Manual Configuration (Reconfiguration)
+
+```bash
+geai-proxy --configure --alias myalias
+```
+
+During interactive setup, the CLI will prompt:
+
+```
+# Configuring GEAI proxy settings...
+Generated new proxy ID: 37bae96b-bc99-4110-bb61-b912b28f9e32
+-> Insert proxy ID (UUID) (Current: 37bae96b-bc99-4110-bb61-b912b28f9e32, Leave empty to keep):
+-> Insert proxy API key:
+-> Insert proxy base URL:
+-> Insert proxy name:
+-> Insert proxy description:
+```
+
+## PROXY CONFIGURATION PARAMETERS
+
+During interactive setup, the following parameters are requested:
+
+- **proxy ID (UUID)**  
+  A unique identifier for this proxy instance. If left empty, the automatically generated UUID will be used.
+
+- **proxy API key**  
+  The API key used to authenticate the proxy with the GEAI backend. Must be a token from GEAI for a specific project.
+
+- **proxy base URL**  
+  The base URL of the GEAI installation to connect to.  
+  Example: `https://api.beta.saia.ai`
+
+- **proxy name**  
+  Human-readable name for this proxy instance, stored under the alias.
+
+- **proxy description**  
+  Optional. Helps identify this proxy instance when using multiple aliases.
+
+### Environment Variables
+
+All of the above configuration parameters can also be set via environment variables:
+
+- `GEAI_API_KEY`  
+- `GEAI_API_BASE_URL`  
+- `PROXY_ID`  
+- `PROXY_NAME`  
+- `PROXY_DESCRIPTION`  
+
+These environment variables override or represent the configuration of the **default alias**. Therefore, they will only be taken into account if the proxy is invoked with `--alias default`. When using a different alias, these variables are ignored.
+
+## USAGE
+
+To start the proxy server with a config and alias:
+
+```bash
+geai-proxy sample-mcp-config.json --alias myalias
+```
+
+### Command Line Arguments
+
+- **config_file**: Path to the MCP servers configuration file (JSON).
+- **--alias ALIAS**: Alias for the proxy settings.
+- **--configure**: Reconfigure proxy authentication settings.
+
+## FILES
+
+- `pygeai/proxy/sample-mcp-config.json` – Sample configuration file for MCP servers.
+
+## SEE ALSO
+
+- `pygeai (1)`
+
+## THIRD-PARTY COMPONENTS
+
+This software includes code from the `a2a-python` project by Google LLC, licensed under the Apache License 2.0.
+
+Only the vendored component in `pygeai/vendor/a2a/` is Apache-licensed. The rest is MIT-licensed.
+
+License sources:
+
+- https://github.com/google/a2a-python
+- `pygeai/vendor/a2a/LICENSE`
+
+## AUTHOR
+
+Written by the GEAI development team.
+
+## COPYRIGHT
+
+Copyright © 2025 GEAI development team.
+
+This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

{pygeai-0.2.7b43 → pygeai-0.2.7b45}/pygeai/man/man1/geai-proxy.1

@@ -191,6 +191,21 @@ A human-readable name assigned to this instance of \fBgeai-proxy\fR. This name i
 \fBproxy description\fR
 An optional description to help identify this proxy instance, especially when multiple proxies are used under different aliases.
 
+.SS Environment Variables
+The above configuration parameters can also be set using environment variables:
+
+.TP
+\fBGEAI_API_KEY\fR
+.TP
+\fBGEAI_API_BASE_URL\fR
+.TP
+\fBPROXY_ID\fR
+.TP
+\fBPROXY_NAME\fR
+.TP
+\fBPROXY_DESCRIPTION\fR
+
+These environment variables override or represent the configuration of the \fBdefault alias\fR. Therefore, they are only taken into account if the proxy is invoked with \fB\-\-alias default\fR. When using a different alias, these variables are ignored.
 
 .SH USAGE
 To start the proxy server with a specific configuration and alias:

{pygeai-0.2.7b43 → pygeai-0.2.7b45/pygeai.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pygeai
-Version: 0.2.7b43
+Version: 0.2.7b45
 Summary: Software Development Kit to interact with Globant Enterprise AI.
 Author-email: Globant <geai-sdk@globant.com>
 License-Expression: MIT

{pygeai-0.2.7b43 → pygeai-0.2.7b45}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pygeai"
-version = "0.2.7b43"
+version = "0.2.7b45"
 description = "Software Development Kit to interact with Globant Enterprise AI."
 license = "MIT"
 requires-python = ">=3.10"

pygeai-0.2.7b43/docs/geai-proxy/README.md

@@ -1,237 +0,0 @@
-# GEAI Proxy Documentation
-
-## Overview
-
-The GEAI Proxy is a Python-based tool that acts as an intermediary between the GEAI API and various tool servers. It manages the registration, execution, and result handling of tool operations through a proxy service.
-
-## Installation
-
-## Third-party Components
-
-This project includes code from [`a2a-python`](https://github.com/google/a2a-python) by Google LLC, used under the Apache License, Version 2.0.
-
-Only the vendored component located in `pygeai/vendor/a2a/` is subject to the Apache License.  
-The rest of this project is licensed under the MIT License (see `LICENSE` file for details).
-
-
-```bash
-pip install pygeai
-```
-
-## Configuration
-
-The GEAI Proxy requires two distinct types of configuration:
-
-### 1. MCP Servers Configuration
-
-This section declares the Model Context Protocol (MCP) servers that this proxy will link with GEAI. The configuration follows the Claude Desktop standard format and supports multiple servers in one file.
-
-#### Configuration File Format
-
-```json
-{
-  "mcpServers": {
-    "serverName1": {
-      "command": "command-to-launch-server",
-      "args": ["arg1", "arg2", ...]
-    },
-    "serverName2": {
-      "command": "command-to-launch-server",
-      "args": ["arg1", "arg2", ...]
-    }
-  }
-}
-```
-
-#### Example Configurations
-
-1. **Puppeteer Server** (for web automation):
-```json
-{
-  "mcpServers": {
-    "puppeteer": {
-      "command": "npx",
-      "args": ["-y", "@modelcontextprotocol/server-puppeteer"]
-    }
-  }
-}
-```
-
-2. **Filesystem Server** (for file operations):
-```json
-{
-  "mcpServers": {
-    "filesystem": {
-      "command": "npx",
-      "args": [
-        "-y",
-        "@modelcontextprotocol/server-filesystem",
-        "~/mcp-shared-folder"
-      ]
-    }
-  }
-}
-```
-
-2. **Location Services Server** (Using http+sse protocol):
-```json
-{
-  "mcpServers": {
-    "location-services": {
-      "uri": "https://location.public-services.com/",
-      "headers": [
-        "X-API-KEY", "<my api key"
-      ]
-    }
-  }
-}
-```
-
-3. **Multiple Servers Combined**:
-```json
-{
-  "mcpServers": {
-    "puppeteer": {
-      "command": "npx",
-      "args": ["-y", "@modelcontextprotocol/server-puppeteer"]
-    },
-    "filesystem": {
-      "command": "npx",
-      "args": [
-        "-y",
-        "@modelcontextprotocol/server-filesystem",
-        "~/mcp-shared-folder"
-      ]
-    },
-    "custom-server": {
-      "command": "python",
-      "args": ["path/to/your/custom_mcp_server.py"]
-    }
-  }
-}
-```
-
-### 1. A2A Servers Configuration
-
-This section declares the Agent to Agent Protocol (A2A) servers that this proxy will link with GEAI. The configuration follows the standard format and supports multiple servers in one file.
-
-#### Configuration File Format
-
-```json
-{
-  "a2aServers": {
-    "hello-world": {
-      "url": "http://localhost:9999",
-      "headers":{
-        "Authorization": "Bearer fh84ff...."
-      }
-    }
-  }
-}
-```
-
-A sample configuration file is provided at:
-```
-pygeai/proxy/sample-mcp-config.json
-```
-
-### 2. Proxy Authentication Configuration
-
-This section establishes the connection between the proxy and GEAI and manages user aliases. You can configure it automatically on first run or manually reconfigure an existing alias.
-
-#### Automatic Configuration (First Run)
-```bash
-geai-proxy sample-mcp-config.json --alias myalias
-```
-
-#### Manual Configuration (Reconfiguration)
-```bash
-geai-proxy --configure --alias myalias
-```
-
-During interactive setup, the CLI will prompt you for each required setting:
-
-```bash
-# Configuring GEAI proxy settings...
-Generated new proxy ID: 37bae96b-bc99-4110-bb61-b912b28f9e32
--> Insert proxy ID (UUID) (Current: 37bae96b-bc99-4110-bb61-b912b28f9e32, Leave empty to keep):
--> Insert proxy API key:
--> Insert proxy base URL:
--> Insert proxy name:
--> Insert proxy description:
-```
-
-## Proxy Configuration Parameters
-
-During interactive setup, the following parameters are requested:
-
-- **proxy ID (UUID)**  
-  A unique identifier for this proxy instance. If left empty, the automatically generated UUID will be used.
-
-- **proxy API key**  
-  The API key used to authenticate the proxy with the GEAI backend.  
-  This must be an API token generated in GEAI for a specific project.
-
-- **proxy base URL**  
-  The base URL of the GEAI installation this proxy will connect to.  
-  For example: `https://api.beta.saia.ai`
-
-- **proxy name**  
-  A human-readable name assigned to this instance of `geai-proxy`.  
-  This name is stored under the configured alias.
-
-- **proxy description**  
-  An optional description to help identify this proxy instance, especially when using multiple proxies under different aliases.
-
-## Usage
-
-### Starting the Proxy
-
-To start the proxy server with a specific configuration and alias:
-
-```bash
-geai-proxy sample-mcp-config.json --alias myalias
-```
-
-### Command Line Arguments
-
-| Argument | Description | Required |
-|----------|-------------|----------|
-| `config_file` | Path to the MCP servers configuration file (JSON format) | Yes |
-| `--alias` | Alias for the proxy settings | No |
-| `--configure` | Command to reconfigure proxy authentication | No |
-
-## Command Line Usage
-
-```bash
-geai-proxy sample-mcp-config.json --alias beta
-``` 
-
-## Architecture
-
-```mermaid
-graph TD
-    user["User (Person)\nClient interacting with the GEAI"]
-    geai["GEAI (Software System)\nGlobant Enterprise AI"]
-    proxy["MCP Proxy \nProxy that connects to multiple MCP Servers to call tools"]
-
-    mcpA["MCP Server A"]
-    a2aB["A2A Server B "]
-    mcpC["MCP Server C "]
-
-    %% Conexiones
-    user -->|Interacts/Calls tools via| geai
-    geai -->|Returns tool responses| user
-    geai -->|Calls tools via| proxy
-    proxy -->|Returns tool responses| geai
-
-    user -->|Calls Search Tool| proxy
-    proxy -->|Calls Search Tool| mcpA
-    mcpA -->|Returns search results| proxy
-
-    proxy -->|Calls Code Tool| a2aB
-    mcpB -->|Returns code output| proxy
-
-    proxy -->|Calls DB Tool| mcpC
-    mcpC -->|Returns query results| proxy
-```