mech-client 0.14.1__tar.gz → 0.15.1__tar.gz

{mech_client-0.14.1 → mech_client-0.15.1}/PKG-INFO

@@ -1,21 +1,20 @@
 Metadata-Version: 2.1
 Name: mech-client
-Version: 0.14.1
+Version: 0.15.1
 Summary: Basic client to interact with a mech
 License: Apache-2.0
 Author: David Minarsch
 Author-email: david.minarsch@googlemail.com
-Requires-Python: >=3.10,<4.0
+Requires-Python: >=3.10,<3.12
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Dist: asn1crypto (>=1.4.0,<1.5.0)
+Requires-Dist: click (==8.1.8)
 Requires-Dist: gql (>=3.4.1)
-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: olas-operate-middleware (==0.14.7)
+Requires-Dist: safe-eth-py (>=7.18.0,<8.0.0)
 Requires-Dist: setuptools (>=77.0.3,<78.0.0)
 Requires-Dist: tabulate (>=0.9.0,<0.10.0)
 Requires-Dist: websocket-client (>=0.32.0,<1)
@@ -38,6 +37,10 @@ The easiest way to create, run, deploy and test your own Mech and Mech tools is
 
 Only continue reading this README if you know what you are doing and you are specifically interested in this repo.
 
+## Quickstart Guide
+For a fast and straightforward setup, follow the instructions provided on the website [here](https://build.olas.network/hire). 
+This guide will walk you through the essential steps to get up and running without requiring an in-depth understanding of the system.
+
 ## Installation
 
 Find the latest available release on [PyPi](https://pypi.org/project/mech-client/#description).
@@ -73,141 +76,109 @@ Usage: mechx [OPTIONS] COMMAND [ARGS]...
   Command-line tool for interacting with mechs.
 
 Options:
-  --version  Show the version and exit.
-  --help     Show this message and exit.
+  --version      Show the version and exit.
+  --client-mode  Enables client mode
+  --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.
-  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
-
-To use the Mech Client you need an EOA account and its associated private key stored in a text file `ethereum_private_key.txt`. You can set it up in two ways:
-
-- Use any software of your choice (e.g., [Metamask](https://metamask.io/)) and copy the private key:
+  deposit-native                           Deposits Native balance for prepaid marketplace requests
+  deposit-token                            Deposits Token balance for prepaid marketplace requests
+  fetch-mm-mechs-info                      Fetches info of marketplace mechs
+  interact                                 Interact with a mech specifying a prompt and tool
+  prompt-to-ipfs                           Upload a prompt and tool to IPFS as metadata
+  purchase-nvm-subscription                Allows to purchase Nevermined subscription
+  push-to-ipfs                             Upload a file to IPFS
+  setup-agent-mode                         Sets up the agent mode for users
+  to-png                                   Convert a stability AI API's diffusion model output
+  tool-description                         Get the description of a specific tool (legacy mechs)
+  tool-description-for-marketplace-mech    Get the description of a specific tool (marketplace mechs)
+  tool-io-schema                           Get the input/output schema of a specific tool (legacy mechs)
+  tool-io-schema-for-marketplace-mech      Get the input/output schema of a specific tool (marketplace mechs)
+  tools-for-agents                         List tools available for all agents or a specific agent (legacy mechs)
+  tools-for-marketplace-mech               List tools available for marketplace mechs
 
-  ```bash
-  echo -n YOUR_PRIVATE_KEY > ethereum_private_key.txt
-  ```
-
-  Do not include any leading or trailing spaces, tabs or newlines, or any other character in the file `ethereum_private_key.txt`.
+```
 
-- Alternatively, use the Open AEA command `generate-key` (you'll need to install [Open AEA](https://pypi.org/project/open-aea/) and its [Ethereum ledger plugin](https://pypi.org/project/open-aea-ledger-ethereum/)):
+## Mech Marketplace
 
-  ```bash
-  aea generate-key ethereum
-  ```
+Learn more about mech marketplace [here](https://olas.network/mech-marketplace)
 
-  and display the corresponding EOA:
+### Set up agent mode for on-chain interactions
 
-  ```bash
-  python -c "from web3 import Web3; print(Web3().eth.account.from_key(open('ethereum_private_key.txt').read()).address)"
-  ```
+There are two modes you can use the mechx for on-chain interactions. Currently `agent-mode` is only supported for gnosis and base network.
 
-The EOA you use must have enough funds to pay for the Mech requests, or alternatively, use a Nevermined subscription.
+-   _agent mode_ (Recommended): This allows to register your on-chain interactions as agent on the olas protocol and allows for A2A activity to be reflected on the client
+-   _client mode_: Simple on-chain interations using EOA
 
-> **:warning: Warning** <br />
-> * **If the generated EOA account is for development purposes, make sure it does not contain large amounts of funds.**
->
-> * **If you store the key file in a local Git repository, we recommend that you add it to `.gitignore` in order to avoid publishing it unintentionally:**
->
->    ```bash
->    echo ethereum_private_key.txt >> .gitignore
->    ```
-
-### API Keys
-
-In order to fetch on-chain data for Gnosis and Base, mech client requires an API key from a blockchain data provider. You can find them here for [GnosisScan](https://gnosisscan.io/) and [BaseScan](https://basescan.org/). Follow these steps to generate your API key if you are planning to use mech client for gnosis and base:
-
-1. Sign up or log in
-2. Go to API Dashboard on the left menu
-3. Add a new API key
-4. Once generated copy your API key
+```bash
+cp .example.env .env
+```
 
-Once you have your API key, you'll need to configure it in your environment. Use the following command to set it for your environment.
+📝 For better reliability, it is recommended to use a stable third-party RPC provider.
 
 ```bash
-export MECHX_API_KEY=<your api key>
+mechx setup-agent-mode --chain-config <chain_config>
 ```
 
-### Generate Mech requests
+⚠️ Note: Run `setup-agent-mode` for each chain you interact with, and ensure your `.env` file has the correct RPC endpoint.
 
-#### Select the mech you are going to send requests to
+### Generate Mech requests
 
-Mechs can receive requests via the [Mech Marketplace](https://github.com/valory-xyz/ai-registry-mech/) or directly. We call the last ones _Legacy Mechs_.
-Mechs are deployed on several networks. Find the list of supported networks and corresponding mech addresses [here](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs). Additionally, you can find more available Mechs [here](https://mech.olas.network/) (click on the tab "Legacy Mech" in order to see Legacy Mech (available only on Gnosis) and "Mech Marketplace" for the ones which receive requests via the Mech Marketplace).
+#### List marketplace mechs
 
-#### Legacy Mechs
-
-The basic usage of the Mech Client is as follows:
+To list the top marketplace mechs based on deliveries, use the `fetch-mm-mechs-info` command. You can specify the chain you want to query. Please note that only the first 20 mechs sorted by number of deliveries will be shown.
+Currently supported chains are gnosis and base
 
 ```bash
-mechx interact --prompts <prompt> --tools <tool> --agent_id <agent_id>
+mechx fetch-mm-mechs-info --chain-config gnosis
 ```
 
-where agent blueprint with `<agent_id>` will process `<prompt>` with the `<tool>` and default options. Each chain has its own set of Mech agents. You can find the agent blueprint IDs for each chain on the [Mech Hub](https://aimechs.autonolas.network/registry) or on the [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs).
+```bash
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|   AI agent Id | Mech Type          | Mech Address                               |   Total Deliveries | Metadata Link                                                                                                 |
++==============+====================+============================================+====================+===============================================================================================================+
+|         2182 | Fixed Price Native | 0xc05e7412439bd7e91730a6880e18d5d5873f632c |              41246 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|         2235 | Fixed Price Native | 0xb3c6319962484602b00d5587e965946890b82101 |              10127 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|         2198 | Fixed Price Native | 0x601024e27f1c67b28209e24272ced8a31fc8151f |               5714 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|         1722 | Fixed Price Token  | 0x13f36b1a516290b7563b1de574a02ebeb48926a1 |                399 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+|         2135 | Fixed Price Native | 0xbead38e4c4777341bb3fd44e8cd4d1ba1a7ad9d7 |                353 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
++--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+```
 
-⚠️ Batch requests and tools are not supported for legacy mechs
+You can also find more available Mechs [here](https://mech.olas.network/)
 
-Some useful options:
+#### Usage
 
-- `--key <private_key_path>`: Specifies the path of the private key. The default value is `./ethereum_private_key.txt`.
-- `--tools  <name>`: Name of the tool to process the prompt. If you are aware about the tools that are provided by an agent you can directly provide its name using this option. If not provided, it will show a list of available tools for the agent so that you can select which one you want to use:
-
-  ```text
-  Select prompting tool
-  |--------------------------------------------------|
-  | ID | Tool                                        |
-  |--------------------------------------------------|
-  | 0  | openai-text-davinci-002                     |
-  | ...| ...                                         |
-  |--------------------------------------------------|
-  Tool ID >
-  ```
-
-- `--chain-config <name>`: Use default chain configuration parameters (RPC, WSS, ...). [See below](#chain-configuration) for more details. Available values are
-  - `arbitrum`
-  - `base`
-  - `celo`
-  - `gnosis` (Default)
-  - `optimism`
-  - `polygon`
-
-- `--confirm <type>`: Specify how to wait for the result of your request:
-  - `off-chain`: Wait for the result using the ACN.
-  - `on-chain`: Wait for the result using the Subgraph and the Websocket subscription (whichever arrives first).
-  - `wait-for-both` (Default): Wait for the result using both `off-chain` and `on-chain` (whichever arrives first).
+The basic usage of the Mech Client is as follows.
 
-##### Example
+```bash
+mechx interact --prompts <prompt> --priority-mech <priority mech address> --tools openai-gpt-3.5-turbo --chain-config <chain_config>
+```
 
-Example of a request specifying a key file and tool:
+The Mech Client can also be used to send batch requests. There are couple of different ways to achieve this:
 
 ```bash
-mechx interact --prompts "write a short poem" --agent_id 6 --key ~/ethereum_private_key.txt --tools openai-gpt-3.5-turbo --chain-config gnosis --confirm on-chain
+mechx interact --prompts={<prompt-1>,<prompt-2>} --priority-mech <priority mech address> --tools={<tool-1>,<tool-2>} --chain-config <chain_config>
 ```
 
-You will see an output like this:
+or <br>
 
 ```bash
-Chain configuration: gnosis
-Prompt uploaded: https://gateway.autonolas.tech/ipfs/f01701220af9e4e8b4bd62d76394064f493081917bcc0b9c34a4aff60f82623b717617279
-Transaction sent: https://gnosisscan.io/tx/0x61359f9cc6a1debb07d34ce1038f6aa30d25257c17edeb2b161741805e43e8d0
-Waiting for transaction receipt...
-Created on-chain request with ID 100407405856633966395081711430940962809568685031934329025999216833965518452765
-Data arrived: https://gateway.autonolas.tech/ipfs/f01701220a462120d5bb03f406fa5ef3573df77184a20ab6343d7bade76bd321654aa7251
-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'}}
+mechx interact --prompts <prompt-1> --prompts <prompt-2> --priority-mech <priority mech address> --tools <tool-1> --tools <tool-2> --chain-config <chain_config>
 ```
 
-#### With the Mech Marketplace
+Additionally other options are available and their usage is listed below:
+
+`--use-prepaid <bool>`: use the prepaid method to send requests to a Mech via the Mech Marketplace. Defaults to False. <br>
+`--use-offchain <bool>`: use the off-chain method to send requests to a Mech via the Mech Marketplace. Defaults to False.
+
+##### Prepaid Requests
 
-With the Mech Marketplace, in order to pay for the Mech fees, you can make a deposit before sending requests. The deposit depends on the
+In order to pay for the Mech fees, you can make a deposit before sending requests. The deposit depends on the
 payment model of the Mech. For a fixed price Mech receiving payments in native token, use the following:
 
 ```bash
@@ -227,75 +198,232 @@ mechx purchase-nvm-subscription --chain-config <chain_config>
 ```
 
 ⚠️ To ensure optimal performance and reliability when using `purchase-nvm-subscription`, it is advisable to use a custom RPC provider as public RPC endpoints may be rate-limited or unreliable under high usage. You can configure your custom RPC URL in your environment variables using
+
 ```bash
 export MECHX_CHAIN_RPC=
 ```
 
-You can use the option `--key <private_key_file_path>` in order to customize the path to the private key file.
+##### Offchain Requests
 
-The basic usage of the Mech Client is then as follows.
+To use offchain requests using `--use-offchain` flag, export the `MECHX_MECH_OFFCHAIN_URL` env variable before sending requests. For example if you want to connect to a mech running locally, you can do the following
 
 ```bash
-mechx interact --prompts <prompt> --priority-mech <priority mech address> --tools openai-gpt-3.5-turbo --chain-config <chain_config>
+export MECHX_MECH_OFFCHAIN_URL="http://localhost:8000/"
 ```
 
-Additionally to other options which are the same as for legacy Mechs, this usage has the following option:
+If you want to use a Valory mech for offchain requests, below is the list of mechs and their address and offchain urls.
+
+| AI agent ID |           Priority Mech Address            |                     Offchain URL                      |
+| :---------: | :----------------------------------------: | :---------------------------------------------------: |
+|    2182     | 0xB3C6319962484602b00d5587e965946890b82101 | https://d19715222af5b940.agent.propel.autonolas.tech/ |
+
+### List tools available for a mech
+
+To list the tools available for a specific marketplace mech, use the `tools-for-marketplace-mech` command. You can specify an AI agent ID to get tools for a specific mech.
 
-`--use-prepaid <bool>`: use the prepaid method to send requests to a Mech via the Mech Marketplace. Defaults to False. <br>
-`--use-offchain <bool>`: use the off-chain method to send requests to a Mech via the Mech Marketplace. Defaults to False.
-> To use offchain requests using `--use-offchain` flag, export the `MECHX_MECH_OFFCHAIN_URL` env variable before sending requests. For example if you want to connect to a mech running locally, you can do the following
 ```bash
-export MECHX_MECH_OFFCHAIN_URL="http://localhost:8000/"
+mechx tools-for-marketplace-mech 1722 --chain-config gnosis
 ```
-If you want to use a Valory mech for offchain requests, below is the list of mechs and their address and offchain urls.
 
-| AI agent ID | Priority Mech Address                       | Offchain URL                                             |
-|    :---:   |                :---:                        |                        :---:                             |
-|       2182 | 0xB3C6319962484602b00d5587e965946890b82101  | https://d19715222af5b940.agent.propel.autonolas.tech/    |
+```bash
+You will see an output like this:
++---------------------------------------------+-----------------------------------------------+
+| Tool Name                                   | Unique Identifier                             |
++=============================================+===============================================+
+| claude-prediction-offline                   | 1722-claude-prediction-offline                |
++---------------------------------------------+-----------------------------------------------+
+| claude-prediction-online                    | 1722-claude-prediction-online                 |
++---------------------------------------------+-----------------------------------------------+
+| deepmind-optimization                       | 1722-deepmind-optimization                    |
++---------------------------------------------+-----------------------------------------------+
+```
 
+### Get Tool Description
 
-The Mech Client can also be used to send batch requests. There are couple of different ways to achieve this:
+To get the description of a specific tool, use the ` tool-description-for-marketplace-mech` command. You need to specify the unique identifier of the tool.
 
 ```bash
-mechx interact --prompts={<prompt-1>,<prompt-2>} --priority-mech <priority mech address> --tools={<tool-1>,<tool-2>} --chain-config <chain_config>
+mechx  tool-description-for-marketplace-mech <unique_identifier> --chain-config <chain_config>
 ```
 
-or <br>
+Example usage:
 
 ```bash
-mechx interact --prompts <prompt-1> --prompts <prompt-2> --priority-mech <priority mech address> --tools <tool-1> --tools <tool-2> --chain-config <chain_config>
+mechx  tool-description-for-marketplace-mech 1722-openai-gpt-4 --chain-config gnosis
 ```
 
-### List marketplace mechs
-To list the top marketplace mechs based on deliveries, use the `fetch-mm-mechs-info` command. You can specify the chain you want to query. Please note that only the first 20 mechs sorted by number of deliveries will be shown.
-Currently supported chains are gnosis and base
+You will see an output like this:
+
 ```bash
-mechx fetch-mm-mechs-info --chain-config gnosis
+Description for tool 1722-openai-gpt-4: Performs a request to OpenAI's GPT-4 model.
 ```
+
+### Get Tool Input/Output Schema
+
+To get the input/output schema of a specific tool, use the `tool-io-schema-for-marketplace-mech` command. You need to specify the unique identifier of the tool.
+
 ```bash
-+--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
-|   AI agent Id | Mech Type          | Mech Address                               |   Total Deliveries | Metadata Link                                                                                                 |
-+==============+====================+============================================+====================+===============================================================================================================+
-|         2182 | Fixed Price Native | 0xc05e7412439bd7e91730a6880e18d5d5873f632c |              41246 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
-+--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
-|         2235 | Fixed Price Native | 0xb3c6319962484602b00d5587e965946890b82101 |              10127 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
-+--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
-|         2198 | Fixed Price Native | 0x601024e27f1c67b28209e24272ced8a31fc8151f |               5714 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
-+--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
-|         1722 | Fixed Price Token  | 0x13f36b1a516290b7563b1de574a02ebeb48926a1 |                399 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
-+--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
-|         2135 | Fixed Price Native | 0xbead38e4c4777341bb3fd44e8cd4d1ba1a7ad9d7 |                353 | https://gateway.autonolas.tech/ipfs/f01701220157d3b106831e2713b86af1b52af76a3ef28c52ae0853e9638180902ebee41d4 |
-+--------------+--------------------+--------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------+
+mechx tool-io-schema-for-marketplace-mech <unique_identifier> --chain-config <chain_config>
+```
+
+Example usage:
+
+```bash
+mechx tool-io-schema-for-marketplace-mech 1722-openai-gpt-4 --chain-config gnosis
+```
+
+You will see an output like this:
+
+```bash
+Tool Details:
+Tool Details:
++------------------------+---------------------------------------------+
+| Tool Name              | Tool Description                            |
++========================+=============================================+
+| OpenAI Request (GPT-4) | Performs a request to OpenAI's GPT-4 model. |
++------------------------+---------------------------------------------+
+Input Schema:
++-------------+-----------------------------------------------+
+| Field       | Value                                         |
++=============+===============================================+
+| type        | text                                          |
++-------------+-----------------------------------------------+
+| description | The request to relay to OpenAI's GPT-4 model. |
++-------------+-----------------------------------------------+
+Output Schema:
++-----------+---------+-----------------------------------+
+| Field     | Type    | Description                       |
++===========+=========+===================================+
+| requestId | integer | Unique identifier for the request |
++-----------+---------+-----------------------------------+
+| result    | string  | Response from OpenAI              |
++-----------+---------+-----------------------------------+
+| prompt    | string  | User prompt to send to OpenAI     |
++-----------+---------+-----------------------------------+
+```
+
+### Set up the EOA and private key
+
+To use the Mech Client using client mode, you need an EOA account and its associated private key stored in a text file `ethereum_private_key.txt`. You can set it up in two ways:
+
+-   Use any software of your choice (e.g., [Metamask](https://metamask.io/)) and copy the private key:
+
+    ```bash
+    echo -n YOUR_PRIVATE_KEY > ethereum_private_key.txt
+    ```
+
+    Do not include any leading or trailing spaces, tabs or newlines, or any other character in the file `ethereum_private_key.txt`.
+
+-   Alternatively, use the Open AEA command `generate-key` (you'll need to install [Open AEA](https://pypi.org/project/open-aea/) and its [Ethereum ledger plugin](https://pypi.org/project/open-aea-ledger-ethereum/)):
+
+    ```bash
+    aea generate-key ethereum
+    ```
+
+    and display the corresponding EOA:
+
+    ```bash
+    python -c "from web3 import Web3; print(Web3().eth.account.from_key(open('ethereum_private_key.txt').read()).address)"
+    ```
+
+The EOA you use must have enough funds to pay for the Mech requests, or alternatively, use a Nevermined subscription.
+
+> **:warning: Warning** <br />
+>
+> -   **If the generated EOA account is for development purposes, make sure it does not contain large amounts of funds.**
+>
+> -   **If you store the key file in a local Git repository, we recommend that you add it to `.gitignore` in order to avoid publishing it unintentionally:**
+>
+>     ```bash
+>     echo ethereum_private_key.txt >> .gitignore
+>     ```
+
+To use client-mode for cli commands, simply supply `--client-mode` flag before the cli commands.
+
+```bash
+mechx --client-mode <rest of the cli command>
+```
+
+## Legacy Mechs
+
+#### Select the mech you are going to send requests to
+
+Legacy Mechs are deployed on several networks. Find the list of supported networks and corresponding mech addresses, you can find more available Mechs [here](https://marketplace.olas.network/gnosis/ai-agents?legacy=true) (click on the tab "Legacy Mech" in order to see Legacy Mech (available only on Gnosis) and "Mech Marketplace" for the ones which receive requests via the Mech Marketplace).
+
+#### Legacy Mechs
+
+The basic usage of the Mech Client is as follows:
+
+```bash
+mechx interact --prompts <prompt> --tools <tool> --agent_id <agent_id>
 ```
 
+where agent blueprint with `<agent_id>` will process `<prompt>` with the `<tool>` and default options. Each chain has its own set of Mech agents. You can find the agent blueprint IDs for each chain on the [Mech Hub](https://aimechs.autonolas.network/registry) or on the [Mech repository](https://github.com/valory-xyz/mech?tab=readme-ov-file#examples-of-deployed-mechs).
+
+⚠️ Batch requests and tools are not supported for legacy mechs
+
+Some useful options:
+
+-   `--key <private_key_path>`: Specifies the path of the private key. The default value is `./ethereum_private_key.txt`.
+-   `--tools  <name>`: Name of the tool to process the prompt. If you are aware about the tools that are provided by an agent you can directly provide its name using this option. If not provided, it will show a list of available tools for the agent so that you can select which one you want to use:
+
+    ```text
+    Select prompting tool
+    |--------------------------------------------------|
+    | ID | Tool                                        |
+    |--------------------------------------------------|
+    | 0  | openai-text-davinci-002                     |
+    | ...| ...                                         |
+    |--------------------------------------------------|
+    Tool ID >
+    ```
+
+-   `--chain-config <name>`: Use default chain configuration parameters (RPC, WSS, ...). [See below](#chain-configuration) for more details. Available values are
+
+    -   `arbitrum`
+    -   `base`
+    -   `celo`
+    -   `gnosis` (Default)
+    -   `optimism`
+    -   `polygon`
+
+-   `--confirm <type>`: Specify how to wait for the result of your request:
+    -   `off-chain`: Wait for the result using the ACN.
+    -   `on-chain`: Wait for the result using the Subgraph and the Websocket subscription (whichever arrives first).
+    -   `wait-for-both` (Default): Wait for the result using both `off-chain` and `on-chain` (whichever arrives first).
+
+##### Example
+
+Example of a request specifying a key file and tool:
+
+```bash
+mechx interact --prompts "write a short poem" --agent_id 6 --key ~/ethereum_private_key.txt --tools openai-gpt-3.5-turbo --chain-config gnosis --confirm on-chain
+```
+
+You will see an output like this:
+
+```bash
+Chain configuration: gnosis
+Prompt uploaded: https://gateway.autonolas.tech/ipfs/f01701220af9e4e8b4bd62d76394064f493081917bcc0b9c34a4aff60f82623b717617279
+Transaction sent: https://gnosisscan.io/tx/0x61359f9cc6a1debb07d34ce1038f6aa30d25257c17edeb2b161741805e43e8d0
+Waiting for transaction receipt...
+Created on-chain request with ID 100407405856633966395081711430940962809568685031934329025999216833965518452765
+Data arrived: https://gateway.autonolas.tech/ipfs/f01701220a462120d5bb03f406fa5ef3573df77184a20ab6343d7bade76bd321654aa7251
+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'}}
+```
+
+You can use the option `--key <private_key_file_path>` in order to customize the path to the private key file.
+
 ### List tools available for legacy mechs and marketplace mechs
 
 #### For legacy mechs
+
 To list the tools available for a specific agent or for all agents, use the `tools-for-agents` command. You can specify an agent blueprint 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:
 +------------+---------------------------------------------+-----------------------------------------------+
@@ -314,10 +442,13 @@ You will see an output like this:
 ```bash
 mechx tools-for-agents --agent-id "agent_id"
 ```
-Eaxmple usage
+
+Example usage
+
 ```bash
 mechx tools-for-agents --agent-id 6
 ```
+
 ```bash
 You will see an output like this:
 +---------------------------------------------+-----------------------------------------------+
@@ -331,64 +462,29 @@ You will see an output like this:
 +---------------------------------------------+-----------------------------------------------+
 ```
 
-#### For marketplace mechs
-To list the tools available for a specific marketplace mech, use the `tools-for-marketplace-mech` command. You can specify an AI agent ID to get tools for a specific mech.
-
-```bash
-mechx tools-for-marketplace-mech 1722 --chain-config gnosis
-```
-```bash
-You will see an output like this:
-+---------------------------------------------+-----------------------------------------------+
-| Tool Name                                   | Unique Identifier                             |
-+=============================================+===============================================+
-| claude-prediction-offline                   | 1722-claude-prediction-offline                |
-+---------------------------------------------+-----------------------------------------------+
-| claude-prediction-online                    | 1722-claude-prediction-online                 |
-+---------------------------------------------+-----------------------------------------------+
-| deepmind-optimization                       | 1722-deepmind-optimization                    |
-+---------------------------------------------+-----------------------------------------------+
-```
-
 ### Get Tool Description
 
-#### For legacy mechs
 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
-```
-
-#### For marketplace mechs
-To get the description of a specific tool, use the ` tool-description-for-marketplace-mech` command. You need to specify the unique identifier of the tool.
-
-```bash
-mechx  tool-description-for-marketplace-mech <unique_identifier> --chain-config <chain_config>
-```
-Example usage:
 
-```bash
-mechx  tool-description-for-marketplace-mech 1722-openai-gpt-4 --chain-config gnosis
-```
 You will see an output like this:
+
 ```bash
-Description for tool 1722-openai-gpt-4: Performs a request to OpenAI's GPT-4 model.
+Description for tool 6-claude-prediction-offline: Makes a prediction using Claude
 ```
 
-
 ### Get Tool Input/Output Schema
 
-#### For legacy mechs
-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.
+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>
@@ -399,7 +495,9 @@ Example usage:
 ```bash
 mechx tool-io-schema "6-prediction-offline" --chain-config gnosis
 ```
+
 You will see an output like this:
+
 ```bash
 Tool Details:
 +---------------------------+-----------------------------------------------+
@@ -427,49 +525,7 @@ Output Schema:
 +-----------+---------+-----------------------------------------------+
 ```
 
-#### For marketplace mechs
-To get the input/output schema of a specific tool, use the `tool-io-schema-for-marketplace-mech` command. You need to specify the unique identifier of the tool.
-
-```bash
-mechx tool-io-schema-for-marketplace-mech <unique_identifier> --chain-config <chain_config>
-```
-
-Example usage:
-
-```bash
-mechx tool-io-schema-for-marketplace-mech 1722-openai-gpt-4 --chain-config gnosis
-```
-You will see an output like this:
-```bash
-Tool Details:
-Tool Details:
-+------------------------+---------------------------------------------+
-| Tool Name              | Tool Description                            |
-+========================+=============================================+
-| OpenAI Request (GPT-4) | Performs a request to OpenAI's GPT-4 model. |
-+------------------------+---------------------------------------------+
-Input Schema:
-+-------------+-----------------------------------------------+
-| Field       | Value                                         |
-+=============+===============================================+
-| type        | text                                          |
-+-------------+-----------------------------------------------+
-| description | The request to relay to OpenAI's GPT-4 model. |
-+-------------+-----------------------------------------------+
-Output Schema:
-+-----------+---------+-----------------------------------+
-| Field     | Type    | Description                       |
-+===========+=========+===================================+
-| requestId | integer | Unique identifier for the request |
-+-----------+---------+-----------------------------------+
-| result    | string  | Response from OpenAI              |
-+-----------+---------+-----------------------------------+
-| prompt    | string  | User prompt to send to OpenAI     |
-+-----------+---------+-----------------------------------+
-```
-
-> **: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.,**
+> **: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.,**
 >
 > ```bash
 > export MECHX_GAS_LIMIT=200000
@@ -477,8 +533,6 @@ Output Schema:
 
 ### Chain configuration
 
-#### For legacy Mechs
-
 Default configurations for different chains are stored in the file [configs/mechs.json](./mech_client/configs/mechs.json). If `--chain-config` parameter is not specified, the Mech Client will choose the first configuration on the JSON.
 
 Additionally, you can override any configuration parameter by exporting any of the following environment variables: