mech-client 0.2.15__tar.gz → 0.2.17__tar.gz

{mech_client-0.2.15 → mech_client-0.2.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mech-client
-Version: 0.2.15
+Version: 0.2.17
 Summary: Basic client to interact with a mech
 License: Apache-2.0
 Author: David Minarsch
@@ -16,6 +16,7 @@ Requires-Dist: open-aea-cli-ipfs (>=1.53.0,<2.0.0)
 Requires-Dist: open-aea-ledger-cosmos (>=1.53.0,<2.0.0)
 Requires-Dist: open-aea-ledger-ethereum (>=1.53.0,<2.0.0)
 Requires-Dist: open-aea[cli] (>=1.53.0,<2.0.0)
+Requires-Dist: tabulate (>=0.9.0,<0.10.0)
 Requires-Dist: websocket-client (>=0.32.0,<1)
 Description-Content-Type: text/markdown
 
@@ -69,10 +70,14 @@ Options:
   --help     Show this message and exit.
 
 Commands:
-  interact        Interact with a mech specifying a prompt and tool.
-  prompt-to-ipfs  Upload a prompt and tool to IPFS as metadata.
-  push-to-ipfs    Upload a file to IPFS.
-  to-png          Convert a stability AI API's diffusion model output...
+  interact         Interact with a mech specifying a prompt and tool.
+  prompt-to-ipfs   Upload a prompt and tool to IPFS as metadata.
+  push-to-ipfs     Upload a file to IPFS.
+  to-png           Convert a stability AI API's diffusion model output.
+  tools-for-agents List tools available for all agents or a specific agent.
+  tool-description Get the description of a specific tool.
+  tool_io_schema   Get the input/output schema of a specific tool.
+
  ```
 
 ### Set up the EOA and private key
@@ -173,6 +178,108 @@ Data arrived: https://gateway.autonolas.tech/ipfs/f01701220a462120d5bb03f406fa5e
 Data from agent: {'requestId': 100407405856633966395081711430940962809568685031934329025999216833965518452765, 'result': "In a world of chaos and strife,\nThere's beauty in the simplest of life.\nA gentle breeze whispers through the trees,\nAnd birds sing melodies with ease.\n\nThe sun sets in a fiery hue,\nPainting the sky in shades of blue.\nStars twinkle in the darkness above,\nGuiding us with their light and love.\n\nSo take a moment to pause and see,\nThe wonders of this world so free.\nEmbrace the joy that each day brings,\nAnd let your heart soar on gentle wings.", 'prompt': 'write a short poem', 'cost_dict': {}, 'metadata': {'model': None, 'tool': 'openai-gpt-3.5-turbo'}}
 ```
 
+
+### List tools available for agents
+
+To list the tools available for a specific agent or for all agents, use the `tools-for-agents` command. You can specify an agent ID to get tools for a specific agent, or omit it to list tools for all agents.
+
+```bash
+mechx tools-for-agents
+```
+```bash
+You will see an output like this:
++------------+---------------------------------------------+-----------------------------------------------+
+|   Agent ID | Tool Name                                   | UniqueIdentifier                             |
++============+=============================================+===============================================+
+|          3 | claude-prediction-offline                   | 3-claude-prediction-offline                   |
++------------+---------------------------------------------+-----------------------------------------------+
+|          3 | claude-prediction-online                    | 3-claude-prediction-online                    |
++------------+---------------------------------------------+-----------------------------------------------+
+|          3 | deepmind-optimization                       | 3-deepmind-optimization                       |
++------------+---------------------------------------------+-----------------------------------------------+
+|          3 | deepmind-optimization-strong                | 3-deepmind-optimization-strong                |
++------------+---------------------------------------------+-----------------------------------------------+
+```
+
+```bash
+mechx tools-for-agents --agent-id "agent_id"
+```
+Eaxmple usage 
+```bash
+mechx tools-for-agents --agent-id 6
+```
+```bash
+You will see an output like this:
++---------------------------------------------+-----------------------------------------------+
+| Tool Name                                   | Unique Identifier                             |
++=============================================+===============================================+
+| claude-prediction-offline                   | 6-claude-prediction-offline                   |
++---------------------------------------------+-----------------------------------------------+
+| claude-prediction-online                    | 6-claude-prediction-online                    |
++---------------------------------------------+-----------------------------------------------+
+| deepmind-optimization                       | 6-deepmind-optimization                       |
++---------------------------------------------+-----------------------------------------------+
+```
+
+### Get Tool Description
+
+To get the description of a specific tool, use the `tool-description` command. You need to specify the unique identifier of the tool.
+
+```bash
+mechx tool-description <unique_identifier> --chain-config <chain_config>
+```
+Example usage:
+
+```bash
+mechx tool-description "6-claude-prediction-offline" --chain-config gnosis
+```
+You will see an output like this:
+```bash
+Description for tool 6-claude-prediction-offline: Makes a prediction using Claude
+```
+
+
+### Get Tool Input/Output Schema
+
+To get the input/output schema of a specific tool, use the `tool_io_schema` command. You need to specify the unique identifier of the tool.
+
+```bash
+mechx tool-io-schema <unique_identifier> --chain-config <chain_config>
+```
+
+Example usage:
+
+```bash
+mechx tool-io-schema "6-prediction-offline" --chain-config gnosis
+```
+You will see an output like this:
+```bash
+Tool Details:
++---------------------------+-----------------------------------------------+
+| Tool Name                 | Tool Description                              |
++===========================+===============================================+
+| OpenAI Prediction Offline | Makes a prediction using OpenAI GPT-3.5 Turbo |
++---------------------------+-----------------------------------------------+
+Input Schema:
++-------------+----------------------------------+
+| Field       | Value                            |
++=============+==================================+
+| type        | text                             |
++-------------+----------------------------------+
+| description | The text to make a prediction on |
++-------------+----------------------------------+
+Output Schema:
++-----------+---------+-----------------------------------------------+
+| Field     | Type    | Description                                   |
++===========+=========+===============================================+
+| requestId | integer | Unique identifier for the request             |
++-----------+---------+-----------------------------------------------+
+| result    | string  | Result information in JSON format as a string |
++-----------+---------+-----------------------------------------------+
+| prompt    | string  | Prompt used for probability estimation.       |
++-----------+---------+-----------------------------------------------+
+```
+
 > **:pencil2: Note** <br />
 > **If you encounter an "Out of gas" error when executing the Mech Client, you will need to increase the gas limit, e.g.,**
 >
@@ -235,6 +342,45 @@ You can also use the Mech Client as a library on your Python project.
     print(result)
     ```
 
+You can also use the Mech Client to programmatically fetch tools for agents in your Python project, as well as retrieve descriptions and input/output schemas for specific tools given their unique identifier.
+
+1. Set up the private key as specified [above](#set-up-the-private-key). Store the resulting key file (e.g., `ethereum_private_key.txt`) in a convenient and secure location.
+
+2. Create a Python script `fetch_tools_script.py`:
+
+    ```bash
+    touch fetch_tools_script.py
+    ```
+
+3. Edit `fetch_tools_script.py` as follows:
+
+    ```python
+    from mech_client.mech_tool_management import get_tools_for_agents, get_tool_description, get_tool_io_schema
+
+    # Fetching tools for a specific agent or all agents
+    agent_id = 6  # Specify the agent ID or set to None to fetch tools for all agents
+    chain_config = "gnosis"  # Specify the chain configuration
+    tools = get_tools_for_agents(agent_id=agent_id, chain_config=chain_config)
+    print(f"Tools for agent {agent_id}:", tools)
+
+    # Assuming you know the tool name, construct the unique identifier
+    tool_name = "claude-prediction-offline"  # Example tool name
+    unique_identifier = f"{agent_id}-{tool_name}"  # Construct the unique identifier
+
+    # Fetching description and I/O schema for a specific tool using the unique identifier
+    description = get_tool_description(unique_identifier, chain_config)
+    print(f"Description for {unique_identifier}:", description)
+
+    io_schema = get_tool_io_schema(unique_identifier, chain_config)
+    print(f"Input/Output Schema for {unique_identifier}:", io_schema)
+    ```
+
+This script will:
+- Fetch and print the tools available for a specified agent or for all agents if `agent_id` is set to `None`.
+- Construct the unique identifier for a tool using the format `agentId-toolName`.
+- Retrieve and display the description of a specific tool using its unique identifier.
+- Retrieve and display the input and output schema of a specific tool using its unique identifier.
+
 ## Developer installation
 
 To setup the development environment for this project, clone the repository and run the following commands:

{mech_client-0.2.15 → mech_client-0.2.17}/README.md

@@ -48,10 +48,14 @@ Options:
   --help     Show this message and exit.
 
 Commands:
-  interact        Interact with a mech specifying a prompt and tool.
-  prompt-to-ipfs  Upload a prompt and tool to IPFS as metadata.
-  push-to-ipfs    Upload a file to IPFS.
-  to-png          Convert a stability AI API's diffusion model output...
+  interact         Interact with a mech specifying a prompt and tool.
+  prompt-to-ipfs   Upload a prompt and tool to IPFS as metadata.
+  push-to-ipfs     Upload a file to IPFS.
+  to-png           Convert a stability AI API's diffusion model output.
+  tools-for-agents List tools available for all agents or a specific agent.
+  tool-description Get the description of a specific tool.
+  tool_io_schema   Get the input/output schema of a specific tool.
+
  ```
 
 ### Set up the EOA and private key
@@ -152,6 +156,108 @@ Data arrived: https://gateway.autonolas.tech/ipfs/f01701220a462120d5bb03f406fa5e
 Data from agent: {'requestId': 100407405856633966395081711430940962809568685031934329025999216833965518452765, 'result': "In a world of chaos and strife,\nThere's beauty in the simplest of life.\nA gentle breeze whispers through the trees,\nAnd birds sing melodies with ease.\n\nThe sun sets in a fiery hue,\nPainting the sky in shades of blue.\nStars twinkle in the darkness above,\nGuiding us with their light and love.\n\nSo take a moment to pause and see,\nThe wonders of this world so free.\nEmbrace the joy that each day brings,\nAnd let your heart soar on gentle wings.", 'prompt': 'write a short poem', 'cost_dict': {}, 'metadata': {'model': None, 'tool': 'openai-gpt-3.5-turbo'}}
 ```
 
+
+### List tools available for agents
+
+To list the tools available for a specific agent or for all agents, use the `tools-for-agents` command. You can specify an agent ID to get tools for a specific agent, or omit it to list tools for all agents.
+
+```bash
+mechx tools-for-agents
+```
+```bash
+You will see an output like this:
++------------+---------------------------------------------+-----------------------------------------------+
+|   Agent ID | Tool Name                                   | UniqueIdentifier                             |
++============+=============================================+===============================================+
+|          3 | claude-prediction-offline                   | 3-claude-prediction-offline                   |
++------------+---------------------------------------------+-----------------------------------------------+
+|          3 | claude-prediction-online                    | 3-claude-prediction-online                    |
++------------+---------------------------------------------+-----------------------------------------------+
+|          3 | deepmind-optimization                       | 3-deepmind-optimization                       |
++------------+---------------------------------------------+-----------------------------------------------+
+|          3 | deepmind-optimization-strong                | 3-deepmind-optimization-strong                |
++------------+---------------------------------------------+-----------------------------------------------+
+```
+
+```bash
+mechx tools-for-agents --agent-id "agent_id"
+```
+Eaxmple usage 
+```bash
+mechx tools-for-agents --agent-id 6
+```
+```bash
+You will see an output like this:
++---------------------------------------------+-----------------------------------------------+
+| Tool Name                                   | Unique Identifier                             |
++=============================================+===============================================+
+| claude-prediction-offline                   | 6-claude-prediction-offline                   |
++---------------------------------------------+-----------------------------------------------+
+| claude-prediction-online                    | 6-claude-prediction-online                    |
++---------------------------------------------+-----------------------------------------------+
+| deepmind-optimization                       | 6-deepmind-optimization                       |
++---------------------------------------------+-----------------------------------------------+
+```
+
+### Get Tool Description
+
+To get the description of a specific tool, use the `tool-description` command. You need to specify the unique identifier of the tool.
+
+```bash
+mechx tool-description <unique_identifier> --chain-config <chain_config>
+```
+Example usage:
+
+```bash
+mechx tool-description "6-claude-prediction-offline" --chain-config gnosis
+```
+You will see an output like this:
+```bash
+Description for tool 6-claude-prediction-offline: Makes a prediction using Claude
+```
+
+
+### Get Tool Input/Output Schema
+
+To get the input/output schema of a specific tool, use the `tool_io_schema` command. You need to specify the unique identifier of the tool.
+
+```bash
+mechx tool-io-schema <unique_identifier> --chain-config <chain_config>
+```
+
+Example usage:
+
+```bash
+mechx tool-io-schema "6-prediction-offline" --chain-config gnosis
+```
+You will see an output like this:
+```bash
+Tool Details:
++---------------------------+-----------------------------------------------+
+| Tool Name                 | Tool Description                              |
++===========================+===============================================+
+| OpenAI Prediction Offline | Makes a prediction using OpenAI GPT-3.5 Turbo |
++---------------------------+-----------------------------------------------+
+Input Schema:
++-------------+----------------------------------+
+| Field       | Value                            |
++=============+==================================+
+| type        | text                             |
++-------------+----------------------------------+
+| description | The text to make a prediction on |
++-------------+----------------------------------+
+Output Schema:
++-----------+---------+-----------------------------------------------+
+| Field     | Type    | Description                                   |
++===========+=========+===============================================+
+| requestId | integer | Unique identifier for the request             |
++-----------+---------+-----------------------------------------------+
+| result    | string  | Result information in JSON format as a string |
++-----------+---------+-----------------------------------------------+
+| prompt    | string  | Prompt used for probability estimation.       |
++-----------+---------+-----------------------------------------------+
+```
+
 > **:pencil2: Note** <br />
 > **If you encounter an "Out of gas" error when executing the Mech Client, you will need to increase the gas limit, e.g.,**
 >
@@ -214,6 +320,45 @@ You can also use the Mech Client as a library on your Python project.
     print(result)
     ```
 
+You can also use the Mech Client to programmatically fetch tools for agents in your Python project, as well as retrieve descriptions and input/output schemas for specific tools given their unique identifier.
+
+1. Set up the private key as specified [above](#set-up-the-private-key). Store the resulting key file (e.g., `ethereum_private_key.txt`) in a convenient and secure location.
+
+2. Create a Python script `fetch_tools_script.py`:
+
+    ```bash
+    touch fetch_tools_script.py
+    ```
+
+3. Edit `fetch_tools_script.py` as follows:
+
+    ```python
+    from mech_client.mech_tool_management import get_tools_for_agents, get_tool_description, get_tool_io_schema
+
+    # Fetching tools for a specific agent or all agents
+    agent_id = 6  # Specify the agent ID or set to None to fetch tools for all agents
+    chain_config = "gnosis"  # Specify the chain configuration
+    tools = get_tools_for_agents(agent_id=agent_id, chain_config=chain_config)
+    print(f"Tools for agent {agent_id}:", tools)
+
+    # Assuming you know the tool name, construct the unique identifier
+    tool_name = "claude-prediction-offline"  # Example tool name
+    unique_identifier = f"{agent_id}-{tool_name}"  # Construct the unique identifier
+
+    # Fetching description and I/O schema for a specific tool using the unique identifier
+    description = get_tool_description(unique_identifier, chain_config)
+    print(f"Description for {unique_identifier}:", description)
+
+    io_schema = get_tool_io_schema(unique_identifier, chain_config)
+    print(f"Input/Output Schema for {unique_identifier}:", io_schema)
+    ```
+
+This script will:
+- Fetch and print the tools available for a specified agent or for all agents if `agent_id` is set to `None`.
+- Construct the unique identifier for a tool using the format `agentId-toolName`.
+- Retrieve and display the description of a specific tool using its unique identifier.
+- Retrieve and display the input and output schema of a specific tool using its unique identifier.
+
 ## Developer installation
 
 To setup the development environment for this project, clone the repository and run the following commands:

mech_client-0.2.17/mech_client/__init__.py

@@ -0,0 +1,3 @@
+"""Mech client."""
+
+__version__ = "0.2.17"

mech_client-0.2.17/mech_client/cli.py

@@ -0,0 +1,290 @@
+# -*- coding: utf-8 -*-
+# ------------------------------------------------------------------------------
+#
+#   Copyright 2023 Valory AG
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+# ------------------------------------------------------------------------------
+
+"""Mech client CLI module."""
+import json
+from typing import Any, Dict, List, Optional, Tuple
+
+import click
+from tabulate import tabulate  # type: ignore
+
+from mech_client import __version__
+from mech_client.interact import ConfirmationType
+from mech_client.interact import interact as interact_
+from mech_client.mech_tool_management import (
+    get_tool_description,
+    get_tool_io_schema,
+    get_tools_for_agents,
+)
+from mech_client.prompt_to_ipfs import main as prompt_to_ipfs_main
+from mech_client.push_to_ipfs import main as push_to_ipfs_main
+from mech_client.to_png import main as to_png_main
+
+
+@click.group(name="mechx")  # type: ignore
+@click.version_option(__version__, prog_name="mechx")
+def cli() -> None:
+    """Command-line tool for interacting with mechs."""
+
+
+@click.command()
+@click.argument("prompt")
+@click.argument("agent_id", type=int)
+@click.option(
+    "--key",
+    type=click.Path(exists=True, file_okay=True, dir_okay=False),
+    help="Path to private key to use for request minting",
+)
+@click.option(
+    "--tool",
+    type=str,
+    help="Name of the tool to be used",
+)
+@click.option(
+    "--extra-attribute",
+    type=str,
+    multiple=True,
+    help="Extra attribute (key=value) to be included in the request metadata",
+    metavar="KEY=VALUE",
+)
+@click.option(
+    "--confirm",
+    type=click.Choice(
+        choices=(ConfirmationType.OFF_CHAIN.value, ConfirmationType.ON_CHAIN.value)
+    ),
+    help="Data verification method (on-chain/off-chain)",
+)
+@click.option(
+    "--retries",
+    type=int,
+    help="Number of retries for sending a transaction",
+)
+@click.option(
+    "--timeout",
+    type=float,
+    help="Timeout to wait for the transaction",
+)
+@click.option(
+    "--sleep",
+    type=float,
+    help="Amount of sleep before retrying the transaction",
+)
+@click.option(
+    "--chain-config",
+    type=str,
+    help="Id of the mech's chain configuration (stored configs/mechs.json)",
+)
+def interact(  # pylint: disable=too-many-arguments
+    prompt: str,
+    agent_id: int,
+    key: Optional[str],
+    tool: Optional[str],
+    extra_attribute: Optional[List[str]] = None,
+    confirm: Optional[str] = None,
+    retries: Optional[int] = None,
+    timeout: Optional[float] = None,
+    sleep: Optional[float] = None,
+    chain_config: Optional[str] = None,
+) -> None:
+    """Interact with a mech specifying a prompt and tool."""
+    try:
+        extra_attributes_dict: Dict[str, Any] = {}
+        if extra_attribute:
+            for pair in extra_attribute:
+                k, v = pair.split("=")
+                extra_attributes_dict[k] = v
+
+        interact_(
+            prompt=prompt,
+            agent_id=agent_id,
+            private_key_path=key,
+            tool=tool,
+            extra_attributes=extra_attributes_dict,
+            confirmation_type=(
+                ConfirmationType(confirm)
+                if confirm is not None
+                else ConfirmationType.WAIT_FOR_BOTH
+            ),
+            retries=retries,
+            timeout=timeout,
+            sleep=sleep,
+            chain_config=chain_config,
+        )
+    except (ValueError, FileNotFoundError) as e:
+        raise click.ClickException(str(e)) from e
+
+
+@click.command()
+@click.argument("prompt")
+@click.argument("tool")
+def prompt_to_ipfs(prompt: str, tool: str) -> None:
+    """Upload a prompt and tool to IPFS as metadata."""
+    prompt_to_ipfs_main(prompt=prompt, tool=tool)
+
+
+@click.command()
+@click.argument("file_path")
+def push_to_ipfs(file_path: str) -> None:
+    """Upload a file to IPFS."""
+    push_to_ipfs_main(file_path=file_path)
+
+
+@click.command()
+@click.argument("ipfs_hash")
+@click.argument("path")
+@click.argument("request_id")
+def to_png(ipfs_hash: str, path: str, request_id: str) -> None:
+    """Convert a stability AI API's diffusion model output into a PNG format."""
+    to_png_main(ipfs_hash, path, request_id)
+
+
+@click.command(name="tools-for-agents")
+@click.option(
+    "--agent-id",
+    type=int,
+    help="Agent ID to fetch tools for. If not provided, fetches for all agents.",
+)
+@click.option("--chain-config", default="gnosis", help="Chain configuration to use.")
+def tools_for_agents(agent_id: Optional[int], chain_config: str) -> None:
+    """Fetch and display tools for agents."""
+    try:
+        result = get_tools_for_agents(agent_id, chain_config)
+
+        if agent_id is not None:
+            headers = ["Tool Name", "Unique Identifier", "Mech Marketplace Support"]
+            data: List[Tuple[str, ...]] = [
+                (
+                    str(tool["tool_name"]),
+                    str(tool["unique_identifier"]),
+                    "✓" if bool(tool["is_marketplace_supported"]) else "✗",
+                )
+                for tool in result["tools"]
+            ]
+        else:
+            headers = [
+                "Agent ID",
+                "Tool Name",
+                "Unique Identifier",
+                "Mech Marketplace Support",
+            ]
+
+            data = [
+                (
+                    str(agent_id),
+                    tool["tool_name"],
+                    tool["unique_identifier"],
+                    (
+                        "✓"
+                        if bool(
+                            tool["is_marketplace_supported"],
+                        )
+                        else "✗"
+                    ),
+                )
+                for agent_id, _ in result["agent_tools_map"].items()
+                for tool in result["all_tools_with_identifiers"]
+                if tool["unique_identifier"].startswith(f"{agent_id}-")
+            ]
+
+        click.echo(tabulate(data, headers=headers, tablefmt="grid"))
+    except (KeyError, TypeError) as e:
+        click.echo(f"Error processing tool data: {str(e)}")
+    except json.JSONDecodeError as e:
+        click.echo(f"Error decoding JSON response: {str(e)}")
+    except IOError as e:
+        click.echo(f"Network or I/O error: {str(e)}")
+
+
+@click.command(name="tool-description")
+@click.argument("tool_id")
+@click.option("--chain-config", default="gnosis", help="Chain configuration to use.")
+def tool_description(tool_id: str, chain_config: str) -> None:
+    """Fetch and display the description of a specific tool."""
+    try:
+        description = get_tool_description(tool_id, chain_config)
+        click.echo(f"Description for tool {tool_id}: {description}")
+    except KeyError as e:
+        click.echo(f"Tool not found or missing description: {str(e)}")
+    except json.JSONDecodeError as e:
+        click.echo(f"Error decoding JSON response: {str(e)}")
+    except IOError as e:
+        click.echo(f"Network or I/O error: {str(e)}")
+
+
+@click.command(name="tool-io-schema")
+@click.argument("tool_id")
+@click.option("--chain-config", default="gnosis", help="Chain configuration to use.")
+def tool_io_schema(tool_id: str, chain_config: str) -> None:
+    """Fetch and display the tool's name and description along with the input/output schema for a specific tool."""
+    try:
+        result = get_tool_io_schema(tool_id, chain_config)
+
+        name = result["name"]
+        description = result["description"]
+        # Prepare data for tabulation
+        input_schema = [(key, result["input"][key]) for key in result["input"]]
+
+        # Handling nested output schema
+        output_schema = []
+        if "properties" in result["output"]["schema"]:
+            for key, value in result["output"]["schema"]["properties"].items():
+                output_schema.append((key, value["type"], value.get("description", "")))
+
+        # Display tool details in tabulated format
+        click.echo("Tool Details:")
+        click.echo(
+            tabulate(
+                [
+                    [
+                        name,
+                        description,
+                    ]
+                ],
+                headers=["Tool Name", "Tool Description"],
+                tablefmt="grid",
+            )
+        )
+        # Display schemas in tabulated format
+        click.echo("Input Schema:")
+        click.echo(tabulate(input_schema, headers=["Field", "Value"], tablefmt="grid"))
+        click.echo("Output Schema:")
+        click.echo(
+            tabulate(
+                output_schema, headers=["Field", "Type", "Description"], tablefmt="grid"
+            )
+        )
+    except KeyError as e:
+        click.echo(f"Error accessing schema data: {str(e)}")
+    except json.JSONDecodeError as e:
+        click.echo(f"Error decoding JSON response: {str(e)}")
+    except IOError as e:
+        click.echo(f"Network or I/O error: {str(e)}")
+
+
+cli.add_command(interact)
+cli.add_command(prompt_to_ipfs)
+cli.add_command(push_to_ipfs)
+cli.add_command(to_png)
+cli.add_command(tools_for_agents)
+cli.add_command(tool_io_schema)
+cli.add_command(tool_description)
+
+
+if __name__ == "__main__":
+    cli()

{mech_client-0.2.15 → mech_client-0.2.17}/mech_client/interact.py

@@ -35,7 +35,7 @@ from dataclasses import asdict, dataclass
 from datetime import datetime
 from enum import Enum
 from pathlib import Path
-from typing import Any, Dict, List, Optional, Tuple
+from typing import Any, Dict, List, Optional, Tuple, Union
 
 import requests
 import websocket
@@ -160,18 +160,10 @@ def get_mech_config(chain_config: Optional[str] = None) -> MechConfig:
         if chain_config is None:
             chain_config = next(iter(data))
 
-        print("Chain configuration:")
         entry = data[chain_config].copy()
         ledger_config = LedgerConfig(**entry.pop("ledger_config"))
         mech_config = MechConfig(**entry, ledger_config=ledger_config)
 
-        print(f"  - Chain ID: {chain_config}")
-        print(f"  - Gas limit: {mech_config.gas_limit}")
-        print(f"  - Contract ABI URL: {mech_config.contract_abi_url}")
-        print(f"  - Transation URL: {mech_config.transaction_url}")
-        print(f"  - Subgraph URL: {mech_config.subgraph_url}")
-        print("")
-
         return mech_config
 
 
@@ -303,12 +295,16 @@ def verify_or_retrieve_tool(
     :return: The result of the verification or retrieval.
     :rtype: str
     """
-    available_tools = fetch_tools(
+    # Fetch tools, possibly including metadata
+    tools_data = fetch_tools(
         agent_id=agent_id,
         ledger_api=ledger_api,
         agent_registry_contract=agent_registry_contract,
         contract_abi_url=contract_abi_url,
+        include_metadata=False,  # Ensure this is False to only get the list of tools
     )
+    # Ensure only the list of tools is used
+    available_tools = tools_data if isinstance(tools_data, list) else tools_data[0]
     if tool is not None and tool not in available_tools:
         raise ValueError(
             f"Provided tool `{tool}` not in the list of available tools; Available tools={available_tools}"
@@ -323,8 +319,9 @@ def fetch_tools(
     ledger_api: EthereumApi,
     agent_registry_contract: str,
     contract_abi_url: str,
-) -> List[str]:
-    """Fetch tools for specified agent ID."""
+    include_metadata: bool = False,
+) -> Union[List[str], Tuple[List[str], Dict[str, Any]]]:
+    """Fetch tools for specified agent ID, optionally include metadata."""
     mech_registry = get_contract(
         contract_address=agent_registry_contract,
         abi=get_abi(agent_registry_contract, contract_abi_url),
@@ -332,7 +329,12 @@ def fetch_tools(
     )
     token_uri = mech_registry.functions.tokenURI(agent_id).call()
     response = requests.get(token_uri).json()
-    return response["tools"]
+    tools = response.get("tools", [])
+
+    if include_metadata:
+        tool_metadata = response.get("toolMetadata", {})
+        return tools, tool_metadata
+    return tools
 
 
 def send_request(  # pylint: disable=too-many-arguments,too-many-locals

mech_client-0.2.17/mech_client/mech_tool_management.py

@@ -0,0 +1,205 @@
+"""Module for managing mechanical tools and their interactions with blockchain."""
+
+import json
+from dataclasses import asdict
+from typing import Any, Dict, List, Optional, Tuple, Union
+
+import requests
+from aea_ledger_ethereum import EthereumApi
+
+from mech_client.interact import fetch_tools, get_abi, get_contract, get_mech_config
+
+
+def get_total_supply(chain_config: str = "gnosis") -> int:
+    """
+    Fetches the total supply of tokens from a contract using the chain configuration.
+
+    :param chain_config: The chain configuration to use.
+    :type chain_config: str
+    :return: The total supply of tokens.
+    :rtype: int
+    """
+    # Get the mech configuration
+    mech_config = get_mech_config(chain_config)
+    ledger_config = mech_config.ledger_config
+
+    # Setup Ethereum API
+    ledger_api = EthereumApi(**asdict(ledger_config))
+
+    # Fetch ABI and create contract instance
+    abi = get_abi(mech_config.agent_registry_contract, mech_config.contract_abi_url)
+    contract = get_contract(mech_config.agent_registry_contract, abi, ledger_api)
+
+    # Call the totalSupply function
+    return contract.functions.totalSupply().call()
+
+
+def get_agent_tools(
+    agent_id: int, chain_config: str = "gnosis", include_metadata: bool = False
+) -> Optional[Union[List[str], Tuple[List[str], Dict[str, Any]]]]:
+    """
+    Fetch tools for a given agent ID.
+
+    :param agent_id: The ID of the agent.
+    :param chain_config: The chain configuration to use (default is "gnosis").
+    :param include_metadata: To include tools metadata or not (default is False)
+    :return: A list of tools if successful, or a tuple of (list of tools, metadata) if metadata is included, or None if an error occurs.
+    """
+    try:
+        # Get the mech configuration
+        mech_config = get_mech_config(chain_config)
+        ledger_config = mech_config.ledger_config
+
+        # Setup Ethereum API
+        ledger_api = EthereumApi(**asdict(ledger_config))
+
+        # Fetch tools for the given agent ID
+        return fetch_tools(
+            agent_id=agent_id,
+            ledger_api=ledger_api,
+            agent_registry_contract=mech_config.agent_registry_contract,
+            contract_abi_url=mech_config.contract_abi_url,
+            include_metadata=include_metadata,
+        )
+    except (requests.exceptions.RequestException, json.JSONDecodeError, KeyError) as e:
+        print(f"An error occurred while fetching tools for agent {agent_id}: {e}")
+        return None
+
+
+def get_tools_for_agents(
+    agent_id: Optional[int] = None, chain_config: str = "gnosis"
+) -> Dict[str, Any]:
+    """
+    Retrieve tools for specified agents or all agents if no specific agent is provided.
+
+    :param agent_id: Optional; specific agent ID to fetch tools for.
+    :param chain_config: The chain configuration to use.
+    :return: Dictionary of tools with identifiers or a mapping of agent IDs to tools.
+    """
+    try:
+        total_supply = get_total_supply(chain_config)
+
+        if agent_id is not None:
+            result = get_agent_tools(agent_id, chain_config, True)
+
+            if result is not None:
+                (tools, tool_metadata) = result
+
+                if isinstance(tools, list) and isinstance(tool_metadata, dict):
+                    tools_with_ids = [
+                        {
+                            "tool_name": tool,
+                            "unique_identifier": f"{agent_id}-{tool}",
+                            "is_marketplace_supported": (
+                                tool_metadata.get(tool, {}).get(
+                                    "isMechMarketplaceSupported", None
+                                )
+                            ),
+                        }
+                        for tool in tools
+                    ]
+                else:
+                    tools_with_ids = []
+                return {"agent_id": agent_id, "tools": tools_with_ids}
+
+        all_tools_with_ids = []
+        agent_tools_map = {}
+
+        for current_agent_id in range(1, total_supply + 1):
+            result = get_agent_tools(current_agent_id, chain_config, True)
+            if result is not None:
+                (tools, tool_metadata) = result
+
+                if isinstance(tools, list) and isinstance(tool_metadata, dict):
+                    tools_with_ids = [
+                        {
+                            "tool_name": tool,
+                            "unique_identifier": f"{current_agent_id}-{tool}",
+                            "is_marketplace_supported": (
+                                tool_metadata.get(tool, {}).get(
+                                    "isMechMarketplaceSupported", None
+                                )
+                            ),
+                        }
+                        for tool in tools
+                    ]
+                    agent_tools_map[current_agent_id] = tools
+                    all_tools_with_ids.extend(tools_with_ids)
+
+        return {
+            "all_tools_with_identifiers": all_tools_with_ids,
+            "agent_tools_map": agent_tools_map,
+        }
+    except Exception as e:
+        print(f"Error in get_tools_for_agents: {str(e)}")
+        raise
+
+
+def get_tool_description(unique_identifier: str, chain_config: str = "gnosis") -> str:
+    """
+    Fetch the description of a specific tool based on a unique identifier.
+
+    :param unique_identifier: The unique identifier for the tool.
+    :param chain_config: The chain configuration to use.
+    :return: Description of the tool or a default message if not available.
+    """
+    parts = unique_identifier.split("-")
+    agent_id = int(parts[0])
+    tool_name = "-".join(parts[1:])
+
+    # Get the mech configuration
+    mech_config = get_mech_config(chain_config)
+    ledger_api = EthereumApi(**asdict(mech_config.ledger_config))
+
+    tools_result = fetch_tools(
+        agent_id=agent_id,
+        ledger_api=ledger_api,
+        agent_registry_contract=mech_config.agent_registry_contract,
+        contract_abi_url=mech_config.contract_abi_url,
+        include_metadata=True,
+    )
+    if isinstance(tools_result, tuple) and len(tools_result) == 2:
+        _, tool_metadata = tools_result
+        tool_info = tool_metadata.get(tool_name, {})
+        if isinstance(tool_info, dict):
+            return tool_info.get("description", "Description not available")
+    return "Description not available"
+
+
+def get_tool_io_schema(
+    unique_identifier: str, chain_config: str = "gnosis"
+) -> Dict[str, Any]:
+    """
+    Fetch the input and output schema along with tool name and description of a specific tool based on a unique identifier.
+
+    :param unique_identifier: The unique identifier for the tool.
+    :param chain_config: The chain configuration to use.
+    :return: Dictionary containing name, description, input and output schemas.
+    """
+    parts = unique_identifier.split("-")
+    agent_id = int(parts[0])
+    tool_name = "-".join(parts[1:])
+
+    # Get the mech configuration
+    mech_config = get_mech_config(chain_config)
+    ledger_api = EthereumApi(**asdict(mech_config.ledger_config))
+
+    tools_result = fetch_tools(
+        agent_id=agent_id,
+        ledger_api=ledger_api,
+        agent_registry_contract=mech_config.agent_registry_contract,
+        contract_abi_url=mech_config.contract_abi_url,
+        include_metadata=True,
+    )
+    if isinstance(tools_result, tuple) and len(tools_result) == 2:
+        _, tool_metadata = tools_result
+        tool_info = tool_metadata.get(tool_name, {})
+        if isinstance(tool_info, dict):
+            return {
+                "name": tool_info.get("name", {}),
+                "description": tool_info.get("description", {}),
+                "input": tool_info.get("input", {}),
+                "output": tool_info.get("output", {}),
+            }
+
+    return {"input": {}, "output": {}}

{mech_client-0.2.15 → mech_client-0.2.17}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mech-client"
-version = "0.2.15"
+version = "0.2.17"
 description = "Basic client to interact with a mech"
 authors = ["David Minarsch <david.minarsch@googlemail.com>"]
 readme = "README.md"
@@ -33,6 +33,7 @@ open-aea-ledger-cosmos = "^1.53.0"
 gql = ">=3.4.1"
 asn1crypto = ">=1.4.0,<1.5.0"
 websocket-client = ">=0.32.0,<1"
+tabulate = "^0.9.0"
 
 [tool.poetry.scripts]
 mechx = "mech_client.cli:cli"

mech_client-0.2.15/mech_client/__init__.py

@@ -1,3 +0,0 @@
-"""Mech client."""
-
-__version__ = "0.2.15"

mech_client-0.2.15/mech_client/cli.py

@@ -1,158 +0,0 @@
-# -*- coding: utf-8 -*-
-# ------------------------------------------------------------------------------
-#
-#   Copyright 2023 Valory AG
-#
-#   Licensed under the Apache License, Version 2.0 (the "License");
-#   you may not use this file except in compliance with the License.
-#   You may obtain a copy of the License at
-#
-#       http://www.apache.org/licenses/LICENSE-2.0
-#
-#   Unless required by applicable law or agreed to in writing, software
-#   distributed under the License is distributed on an "AS IS" BASIS,
-#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#   See the License for the specific language governing permissions and
-#   limitations under the License.
-#
-# ------------------------------------------------------------------------------
-
-"""Mech client CLI module."""
-
-from typing import Any, Dict, List, Optional
-
-import click
-
-from mech_client import __version__
-from mech_client.interact import ConfirmationType
-from mech_client.interact import interact as interact_
-from mech_client.prompt_to_ipfs import main as prompt_to_ipfs_main
-from mech_client.push_to_ipfs import main as push_to_ipfs_main
-from mech_client.to_png import main as to_png_main
-
-
-@click.group(name="mechx")  # type: ignore
-@click.version_option(__version__, prog_name="mechx")
-def cli() -> None:
-    """Command-line tool for interacting with mechs."""
-
-
-@click.command()
-@click.argument("prompt")
-@click.argument("agent_id", type=int)
-@click.option(
-    "--key",
-    type=click.Path(exists=True, file_okay=True, dir_okay=False),
-    help="Path to private key to use for request minting",
-)
-@click.option(
-    "--tool",
-    type=str,
-    help="Name of the tool to be used",
-)
-@click.option(
-    "--extra-attribute",
-    type=str,
-    multiple=True,
-    help="Extra attribute (key=value) to be included in the request metadata",
-    metavar="KEY=VALUE",
-)
-@click.option(
-    "--confirm",
-    type=click.Choice(
-        choices=(ConfirmationType.OFF_CHAIN.value, ConfirmationType.ON_CHAIN.value)
-    ),
-    help="Data verification method (on-chain/off-chain)",
-)
-@click.option(
-    "--retries",
-    type=int,
-    help="Number of retries for sending a transaction",
-)
-@click.option(
-    "--timeout",
-    type=float,
-    help="Timeout to wait for the transaction",
-)
-@click.option(
-    "--sleep",
-    type=float,
-    help="Amount of sleep before retrying the transaction",
-)
-@click.option(
-    "--chain-config",
-    type=str,
-    help="Id of the mech's chain configuration (stored configs/mechs.json)",
-)
-def interact(  # pylint: disable=too-many-arguments
-    prompt: str,
-    agent_id: int,
-    key: Optional[str],
-    tool: Optional[str],
-    extra_attribute: Optional[List[str]] = None,
-    confirm: Optional[str] = None,
-    retries: Optional[int] = None,
-    timeout: Optional[float] = None,
-    sleep: Optional[float] = None,
-    chain_config: Optional[str] = None,
-) -> None:
-    """Interact with a mech specifying a prompt and tool."""
-    try:
-        extra_attributes_dict: Dict[str, Any] = {}
-        if extra_attribute:
-            for pair in extra_attribute:
-                k, v = pair.split("=")
-                extra_attributes_dict[k] = v
-
-        interact_(
-            prompt=prompt,
-            agent_id=agent_id,
-            private_key_path=key,
-            tool=tool,
-            extra_attributes=extra_attributes_dict,
-            confirmation_type=(
-                ConfirmationType(confirm)
-                if confirm is not None
-                else ConfirmationType.WAIT_FOR_BOTH
-            ),
-            retries=retries,
-            timeout=timeout,
-            sleep=sleep,
-            chain_config=chain_config,
-        )
-    except (ValueError, FileNotFoundError) as e:
-        raise click.ClickException(str(e)) from e
-
-
-@click.command()
-@click.argument("prompt")
-@click.argument("tool")
-def prompt_to_ipfs(prompt: str, tool: str) -> None:
-    """Upload a prompt and tool to IPFS as metadata."""
-    prompt_to_ipfs_main(prompt=prompt, tool=tool)
-
-
-@click.command()
-@click.argument("file_path")
-def push_to_ipfs(file_path: str) -> None:
-    """Upload a file to IPFS."""
-    push_to_ipfs_main(file_path=file_path)
-
-
-@click.command()
-@click.argument("ipfs_hash")
-@click.argument("path")
-@click.argument("request_id")
-def to_png(ipfs_hash: str, path: str, request_id: str) -> None:
-    """Convert a stability AI API's diffusion model output into a PNG format."""
-    to_png_main(ipfs_hash, path, request_id)
-
-
-cli.add_command(interact)
-cli.add_command(prompt_to_ipfs)
-cli.add_command(push_to_ipfs)
-cli.add_command(to_png)
-
-
-if __name__ == "__main__":
-    cli()