Mech Client

A client to interact with Mechs - AI agents providing services - on the Olas Marketplace. It allows users to post requests for AI tasks on-chain, and get their result delivered.

Requirements

Python >=3.10, <3.12 (Python 3.10 or 3.11)

Developing, running and deploying Mechs and Mech tools

The easiest way to create, run, deploy and test your own Mech and Mech tools is to follow the Mech and Mech tool docs here. The Mech tools dev repo used in those docs greatly simplifies the development flow and dev experience.

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. 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.

We recommend that you create a virtual Python environment using Poetry. Set up your virtual environment as follows:

poetry new my_project
cd my_project
poetry add mech-client

Alternatively, you can also install the Mech Client in your local Python installation:

pip install mech-client

If you require to use the Mech Client programmatically, please see this section below.

CLI Usage

Display the available options:

mechx --help

Usage: mechx [OPTIONS] COMMAND [ARGS]...

  Command-line tool for interacting with AI Mechs on-chain.

  Mech Client enables you to send AI task requests to on-chain AI agents
  (mechs) via the Olas (Mech) Marketplace. Supports multiple payment methods,
  tool discovery, and both agent mode (Safe multisig) and client mode (EOA).

Options:
  --version      Show the version and exit.
  --client-mode  Enables client mode (EOA-based). Default is agent mode (Safe-
                 based).
  --help         Show this message and exit.

Commands:
  deposit       Manage prepaid balance deposits.
  ipfs          IPFS utility operations.
  mech          Manage and query AI mechs on the marketplace.
  request       Send an AI task request to a mech on-chain.
  setup         Setup agent mode for on-chain interactions via Safe...
  subscription  Manage Nevermined (NVM) subscriptions.
  tool          Manage and query mech tools.

Mech Marketplace

Learn more about mech marketplace here

Supported Chains

Supported chains: gnosis, base, polygon, optimism

All commands require --chain-config with one of these four chain names.

Chain	Marketplace	Agent Mode	Native Payment	NVM Subscriptions	OLAS Payments	USDC Payments
Gnosis	✅	✅	✅	✅	✅	❌
Base	✅	✅	✅	✅	✅	✅
Polygon	✅	✅	✅	❌	✅	✅
Optimism	✅	✅	✅	❌	✅	✅

Notes:

Marketplace: Chains with marketplace contracts deployed. All supported chains have marketplace support.
Agent Mode: All supported chains support on-chain agent registration via setup.
Native Payment: Chains that support deposit native command for prepaid native token deposits.
NVM Subscriptions: Chains that support subscription purchase command for Nevermined subscription-based payments (Gnosis, Base only).
OLAS/USDC Payments: Chains that support deposit token command with OLAS or USDC tokens.
Subgraph: Default subgraph URLs are provided for all supported chains. The MECHX_SUBGRAPH_URL environment variable is optional and only needed to override defaults.

Set up agent mode for on-chain interactions

There are two modes you can use the mechx for on-chain interactions. Currently agent-mode is supported for all marketplace chains (Gnosis, Base, Polygon, and Optimism).

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

cp .example.env .env

📝 For better reliability, it is recommended to use a stable third-party RPC provider.

mechx setup --chain-config <chain_config>

⚠️ Note: Run setup for each chain you interact with, and ensure your .env file has the correct RPC endpoint.

Generate Mech requests

List marketplace mechs

To list the top marketplace mechs based on deliveries, use the mech list 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.

Note: Default subgraph URLs are provided for all supported chains. You can optionally override the default by setting:

export MECHX_SUBGRAPH_URL=<your-custom-subgraph-url>

Supported marketplace chains: gnosis, base, polygon, optimism

mechx mech list --chain-config gnosis

You can also find available Mechs here

Usage

The basic usage of the Mech Client is as follows.

mechx request --prompts <prompt> --priority-mech <priority mech address> --tools openai-gpt-3.5-turbo --chain-config <chain_config>

The Mech Client can also be used to send batch requests. There are couple of different ways to achieve this:

mechx request --prompts={<prompt-1>,<prompt-2>} --priority-mech <priority mech address> --tools={<tool-1>,<tool-2>} --chain-config <chain_config>

or

mechx request --prompts <prompt-1> --prompts <prompt-2> --priority-mech <priority mech address> --tools <tool-1> --tools <tool-2> --chain-config <chain_config>

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.
--use-offchain <bool>: use the off-chain method to send requests to a Mech via the Mech Marketplace. Defaults to False.

Understanding Payment Types

Important: The payment type is determined by the mech's smart contract, not by the user. When you send a request, the client automatically detects the mech's payment type and handles the appropriate payment flow.

There are 5 payment types supported:

Payment Type	Description	Payment Method
NATIVE	Per-request native token payment	Sends native tokens (xDAI, ETH, MATIC) with transaction
OLAS_TOKEN	Per-request OLAS token payment	Approves & transfers OLAS tokens
USDC_TOKEN	Per-request USDC token payment	Approves & transfers USDC tokens
NATIVE_NVM	NVM subscription with native token	Validates subscription NFT (no per-request payment)
TOKEN_NVM_USDC	NVM subscription with USDC token	Validates subscription NFT (no per-request payment)

How it works:

Request command detects mech's payment type - The client queries the mech's contract to determine how it accepts payment
Client handles payment automatically - Based on the payment type, the client either:
- Sends native tokens with the transaction (NATIVE)
- Approves and transfers ERC20 tokens (OLAS_TOKEN, USDC_TOKEN)
- Validates your subscription NFT (NATIVE_NVM, TOKEN_NVM_USDC)
You can use prepaid balance - With --use-prepaid flag, the marketplace deducts from your prepaid balance instead of per-request payment (works for non-subscription mechs)

Payment flow examples:

# NATIVE payment mech (detected automatically)
mechx request --prompts "test" --tools openai-gpt-4 --chain-config gnosis
# → Sends xDAI with transaction

# OLAS_TOKEN payment mech (detected automatically)
mechx request --prompts "test" --tools openai-gpt-4 --chain-config gnosis
# → Approves OLAS → Sends request

# Using prepaid balance (any non-subscription mech)
mechx request --prompts "test" --tools openai-gpt-4 --use-prepaid --chain-config gnosis
# → Deducts from prepaid balance

# NVM subscription mech (detected automatically)
# First purchase subscription:
mechx subscription purchase --chain-config gnosis
# Then make unlimited requests:
mechx request --prompts "test" --tools openai-gpt-4 --chain-config gnosis
# → Validates subscription NFT

Prepaid Requests

You can deposit funds to your prepaid balance on the marketplace, then use --use-prepaid flag to pay from this balance instead of per-request payments. This works for non-subscription mechs only.

Deposit native tokens (for NATIVE payment mechs):

mechx deposit native <amount> --chain-config <chain_config>

Deposit ERC20 tokens (for OLAS_TOKEN or USDC_TOKEN payment mechs):

# Deposit OLAS tokens (amount in wei, 18 decimals)
mechx deposit token <amount> --chain-config <chain_config> --token-type olas

# Deposit USDC tokens (amount in smallest unit, 6 decimals)
mechx deposit token <amount> --chain-config <chain_config> --token-type usdc

Note: The --token-type parameter is required and must be explicitly specified.

NVM Subscriptions (for NATIVE_NVM or TOKEN_NVM_USDC payment mechs):

For mechs using NVM subscriptions, purchase a subscription upfront to enable unlimited requests during the subscription period:

mechx subscription purchase --chain-config <chain_config>

After purchasing, you can make requests without per-request payments. The marketplace validates your subscription NFT automatically.

⚠️ To ensure optimal performance and reliability when using subscription purchase, 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

export MECHX_CHAIN_RPC=

Offchain Requests

The offchain URL is automatically discovered from the mech's on-chain metadata. No additional configuration is required — simply use the --use-offchain flag:

mechx request --prompts "test" --tools openai-gpt-4 --use-offchain true --chain-config gnosis

The client queries the mech's ComplementaryServiceMetadata contract to find the url field published by the mech operator, then sends requests to that endpoint.

List tools available for a mech

To list the tools available for a specific marketplace mech, use the tool list command. You can specify an AI Agent ID to get tools for a specific mech.

mechx tool list 1722 --chain-config gnosis

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

To get the description of a specific tool, use the tool describe command. You need to specify the unique identifier of the tool.

mechx  tool describe <unique_identifier> --chain-config <chain_config>

Example usage:

mechx  tool describe 1722-openai-gpt-4 --chain-config gnosis

You will see an output like this:

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 schema command. You need to specify the unique identifier of the tool.

mechx tool schema <unique_identifier> --chain-config <chain_config>

Example usage:

mechx tool schema 1722-openai-gpt-4 --chain-config gnosis

You will see an output like this:

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) and copy the private key:
```
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 and its Ethereum ledger plugin):
```
aea generate-key ethereum
```
and display the corresponding EOA:
```
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
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:
echo ethereum_private_key.txt >> .gitignore

To use client-mode for cli commands, simply supply --client-mode flag before the cli commands.

mechx --client-mode <rest of the cli command>

✏️ Note
> If you encounter an "Out of gas" error when executing the Mech Client, you will need to increase the gas limit, e.g.,
export MECHX_GAS_LIMIT=200000

Chain configuration

Default configurations for different chains are stored in the file 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:

MECHX_CHAIN_RPC
MECHX_SUBGRAPH_URL
MECHX_GAS_LIMIT
MECHX_TRANSACTION_URL

MECHX_LEDGER_CHAIN_ID
MECHX_LEDGER_POA_CHAIN
MECHX_LEDGER_DEFAULT_GAS_PRICE_STRATEGY
MECHX_LEDGER_IS_GAS_ESTIMATION_ENABLED

Programmatic usage

You can also use the Mech Client as a library on your Python project.

Set up the private key as specified above. Store the resulting key file (e.g., ethereum_private_key.txt) in a convenient and secure location.
Create Python script my_script.py:
```
touch my_script.py
```

Edit my_script.py as follows:

from mech_client.services import MarketplaceService
from mech_client.domain.payment import PaymentType
from mech_client.infrastructure.config import get_mech_config
from aea_ledger_ethereum import EthereumApi, EthereumCrypto

# Configuration
PRIORITY_MECH_ADDRESS = "0x77af31De935740567Cf4fF1986D04B2c964A786a"
PROMPT_TEXT = "Will Gnosis pay reach 100k cards in 2024?"
TOOL_NAME = "openai-gpt-4o-2024-05-13"
CHAIN_CONFIG = "gnosis"
MODE = "client"  # Use "agent" for agent mode (Safe multisig)
SAFE_ADDRESS = ""  # Required if MODE is "agent"

# Setup ledger and crypto
config = get_mech_config(CHAIN_CONFIG)
crypto = EthereumCrypto("ethereum_private_key.txt")
ledger_api = EthereumApi(**config.ledger_config.__dict__)

# Create service
service = MarketplaceService(
    chain_config=CHAIN_CONFIG,
    ledger_api=ledger_api,
    payer_address=crypto.address,
    mode=MODE,
    safe_address=SAFE_ADDRESS if MODE == "agent" else None,
)

# Send request
result = service.send_request(
    priority_mech=PRIORITY_MECH_ADDRESS,
    tools=[TOOL_NAME],
    prompts=[PROMPT_TEXT],
    payment_type=PaymentType.NATIVE,  # or PaymentType.TOKEN, PaymentType.NATIVE_NVM
)

print(f"Transaction hash: {result['tx_hash']}")
print(f"Request ID: {result['request_ids'][0]}")
print(f"Result: {result.get('result')}")

Note: See docs/ARCHITECTURE.md for architecture details and more examples.

You can also use the Mech Client to programmatically fetch tools for marketplace mechs in your Python project, as well as retrieve descriptions and input/output schemas for specific tools given their unique identifier.

Set up the private key as specified above. Store the resulting key file (e.g., ethereum_private_key.txt) in a convenient and secure location.
Create a Python script fetch_tools_script.py:
```
touch fetch_tools_script.py
```

Edit fetch_tools_script.py as follows:

from mech_client.services import ToolService
from mech_client.infrastructure.config import get_mech_config
from aea_ledger_ethereum import EthereumApi

# Configuration
service_id = 1722  # Specify the service ID
chain_config = "gnosis"  # Specify the chain configuration

# Setup ledger API
config = get_mech_config(chain_config)
ledger_api = EthereumApi(**config.ledger_config.__dict__)

# Create tool service
tool_service = ToolService(
    chain_config=chain_config,
    ledger_api=ledger_api,
)

# Fetch tools for a specific marketplace mech
tools = tool_service.list_tools(service_id=service_id)
print(f"Tools for marketplace mech {service_id}:")
for tool_name, tool_id in tools:
    print(f"  {tool_name}: {tool_id}")

# Get description for a specific tool
tool_name = "openai-gpt-4o-2024-05-13"  # Example tool name
unique_identifier = f"{service_id}-{tool_name}"  # Format: serviceId-toolName

description = tool_service.get_description(unique_identifier)
print(f"\nDescription for {unique_identifier}:")
print(f"  {description}")

# Get input/output schema for a specific tool
tools_info = tool_service.get_tools_info(service_id)
input_schema = tool_service.format_input_schema(tools_info["input"])
output_schema = tool_service.format_output_schema(tools_info["output"])

print(f"\nInput schema: {input_schema}")
print(f"Output schema: {output_schema}")

Note: This example demonstrates the service-based API introduced in v0.17.0.

Architecture & Documentation

Architecture Overview

Version 0.17.0 introduced a comprehensive architectural refactoring that separates concerns into distinct layers:

┌──────────────────────────────────────┐
│         CLI Layer                    │  User interface & command routing
├──────────────────────────────────────┤
│         Service Layer                │  Business workflow orchestration
├──────────────────────────────────────┤
│         Domain Layer                 │  Core business logic & strategies
├──────────────────────────────────────┤
│      Infrastructure Layer            │  External system adapters
└──────────────────────────────────────┘

Key improvements:

✅ Separation of concerns: Each layer has a specific responsibility
✅ Strategy pattern: Flexible payment, execution, and delivery strategies
✅ Dependency injection: Better testability and modularity
✅ Type safety: Comprehensive type hints throughout
✅ Comprehensive tests: 288 unit tests with ~50% coverage

Documentation

For detailed information about the architecture and development:

docs/ARCHITECTURE.md - Comprehensive architecture guide
- Layer descriptions and responsibilities
- Data flow diagrams
- Key patterns (Factory, Strategy, Repository)
- Component reference
- Best practices
docs/TESTING.md - Testing guide for contributors
- Test structure and organization
- Running tests and coverage reports
- Writing tests (patterns, fixtures, mocking)
- Testing async components
- Best practices
CLAUDE.md - Development guidelines for Claude Code
- Command dependency diagrams
- Common issues and solutions
- Environment variables reference
- Development commands

For Library Users

If you use mech-client as a library (not just the CLI), see:

Programmatic usage - Basic usage examples
docs/ARCHITECTURE.md - Understanding the architecture

For Contributors

If you want to contribute to mech-client development:

Read docs/ARCHITECTURE.md to understand the structure
Follow docs/TESTING.md for writing tests
Review CLAUDE.md for development guidelines
See Developer installation below

Developer installation

To setup the development environment for this project, clone the repository and run the following commands:

poetry install
poetry shell

Release guide

Bump versions in pyproject.toml.mech_client/__init__.py and SECURITY.md
poetry lock
rm -rf dist
autonomy packages sync --update-packages
make dist
Then, create a release PR and tag the release.

FAQ

On which chains are AI Mechs deployed?

The Mech repository contains the latest information on deployed Mechs.

Are AI Mechs deployed on testnets?

No. AI Mechs are currently deployed only on mainnets.

Where can I find the agent blueprint ID?

You can find the agent blueprint IDs for each chain on the Marketplace or on the Mech repository.

How do I access an AI Mech on a different chain?

Use the --chain-config <name> parameter together with a valid --priority-mech address, for example:

mechx request --prompts "write a short poem" --priority-mech 0x77af31De935740567Cf4fF1986D04B2c964A786a --key ./ethereum_private_key.txt --tools openai-gpt-4o-2024-05-13 --chain-config gnosis

Name		Name	Last commit message	Last commit date
Latest commit History 1,062 Commits
.github/workflows		.github/workflows
docs		docs
mech_client		mech_client
packages		packages
scripts		scripts
stress_tests		stress_tests
tests		tests
.example.env		.example.env
.gitignore		.gitignore
.spelling		.spelling
CHANGELOG.md		CHANGELOG.md
CLAUDE.md		CLAUDE.md
CONTRIBUTING.md		CONTRIBUTING.md
LICENSE		LICENSE
MANIFEST.in		MANIFEST.in
Makefile		Makefile
README.md		README.md
SECURITY.md		SECURITY.md
mkdocs.yml		mkdocs.yml
poetry.lock		poetry.lock
pyproject.toml		pyproject.toml
pytest.ini		pytest.ini
tox.ini		tox.ini

Folders and files

Latest commit

History

Repository files navigation

Mech Client

Requirements

Developing, running and deploying Mechs and Mech tools

Quickstart Guide

Installation

CLI Usage

Mech Marketplace

Supported Chains

Set up agent mode for on-chain interactions

Generate Mech requests

List marketplace mechs

Usage

Understanding Payment Types

Prepaid Requests

Offchain Requests

List tools available for a mech

Get Tool Description

Get Tool Input/Output Schema

Set up the EOA and private key

Chain configuration

Programmatic usage

Architecture & Documentation

Architecture Overview

Documentation

For Library Users

For Contributors

Developer installation

Release guide

FAQ

About

Topics

Resources

License

Contributing

Security policy

Uh oh!

Stars

Watchers

Forks

Releases 68

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

Packages