mech-server 0.5.0

No project description provided

Mech Server

A CLI to create, deploy and manage Mechs — AI agents that execute tasks on-chain for payment — on the Olas Marketplace.

Note: The codebase uses the term service (from the underlying Open Autonomy framework) interchangeably with AI agent.

Quick Start

poetry install
poetry run mech setup -c <chain>      # first-time setup; prompts for RPC URL and wallet funding
# edit ~/.operate-mech/.env and set your API keys
poetry run mech run -c <chain>        # run via Docker
poetry run mech stop -c <chain>       # stop when done

Supported Chains

Chain	Native	OLAS Token	USDC Token	Nevermined
Gnosis	✅	✅	❌	✅
Base	✅	✅	❌	✅
Polygon	✅	✅	✅	✅
Optimism	✅	✅	❌	✅

The mech payment type is selected at deployment time via the MECH_TYPE env variable.

Requirements

• Python >=3.10, <3.12
• Poetry
• Docker Engine + Docker Compose
• Tendermint ==0.34.19 (only for --dev mode)

Commands

Command	Description
mech setup -c <chain>	Full first-time setup: agent build, mech deployment, env config, key setup, metadata generation, IPFS publish, and on-chain update
mech run -c <chain>	Run the mech AI agent via Docker
mech run -c <chain> --dev	Dev mode: push local packages to IPFS, then run on host (no Docker)
mech stop -c <chain>	Stop a running mech AI agent
mech deploy-mech -c <chain>	Deploy a mech on the marketplace (runs automatically during setup)
mech push-metadata	Generate metadata.json from packages and publish to IPFS
mech update-metadata	Update the metadata hash on-chain via Safe transaction
mech add-tool <author> <name>	Scaffold a new mech tool

What mech setup does

mech setup runs the following steps in order:

1. Agent build — creates the AI agent via olas-operate-middleware (skipped if already set up)
2. Mech deployment — deploys a mech on the marketplace (skipped if already deployed)
3. Env configuration — writes ~/.operate-mech/.env with required variables
4. Private key setup — configures operator and agent keys
5. Metadata generation — generates metadata.json from package definitions
6. IPFS publish — pushes metadata to IPFS
7. On-chain update — updates the metadata hash on-chain via Safe transaction

Adding a tool

poetry run mech add-tool <author> <tool_name> -d "My tool description"

Implement the tool in ~/.operate-mech/packages/<author>/customs/<tool_name>/<tool_name>.py, then publish and register on-chain:

poetry run mech push-metadata
poetry run mech update-metadata

See the documentation for the full tool creation, publishing, and on-chain registration workflow.

Documentation

Find the full tutorial (Hello World, creating and publishing tools, sending requests) at stack.olas.network.