Skip to content

Commit 6959d53

Browse files
committed
script for MM
1 parent 2943524 commit 6959d53

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,9 @@ With the Mech Marketplace, the basic usage of the Mech Client is as follows.
166166
mechx interact <prompt> --chain-config <chain_config>
167167
```
168168

169-
The Mech agent which corresponds to the `priority_mech_address` in `<chain_config>` will process `<prompt>` with the default options.
169+
The Mech agent which corresponds to the `priority_mech_address` in `<chain_config>` will process `<prompt>` with the default options. Additionally to other options which are the same as for legacy Mechs, this usage has the following option:
170+
171+
`--use-offchain <bool>`: use the off-chain method to send requests to a Mech via the Mech Marketplace. Set to False in order to use the on-chain method.
170172

171173
### List tools available for agents
172174

@@ -278,6 +280,8 @@ Output Schema:
278280

279281
### Chain configuration
280282

283+
#### For legacy Mechs
284+
281285
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.
282286

283287
Additionally, you can override any configuration parameter by exporting any of the following environment variables:
@@ -370,6 +374,8 @@ This script will:
370374
- Retrieve and display the description of a specific tool using its unique identifier.
371375
- Retrieve and display the input and output schema of a specific tool using its unique identifier.
372376

377+
#### For Mechs receiving requests via the Mech Marketplace
378+
373379
## Developer installation
374380

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

0 commit comments

Comments
 (0)