@conquest-eth/tools 0.0.4 → 0.0.6

package/README.md

@@ -1,13 +1,13 @@
-# MCP for Conquest.eth v0
+# Conquest.eth CLI
 
-A dual-mode CLI tool for interacting with the Conquest.eth blockchain game. It can run as an **MCP server** for AI assistant integration or execute **tools directly** from the command line.
+A command-line tool for interacting with the Conquest.eth blockchain game. Execute game commands directly from your terminal to acquire planets, send fleets, resolve battles, and manage your empire.
 
 ## Features
 
-- **MCP Server Mode**: Integrate with AI assistants via the Model Context Protocol
 - **CLI Mode**: Execute game commands directly from your terminal
-- **Dynamic Command Generation**: CLI commands are auto-generated from tool definitions
 - **Comprehensive Game Tools**: Acquire planets, send fleets, resolve fleets, manage exits, and more
+- **Dynamic Command Generation**: CLI commands are auto-generated from tool definitions
+- **MCP Server Mode**: the cli provide an mcp command if you prefers to integrate your agent via Model Context Protocol
 
 ## Installation
 
@@ -17,15 +17,13 @@ npm i -g @conquest-eth/tools
 
 ## Usage
 
-### CLI Mode (Direct Command Execution)
-
 Show help and available commands:
 
 ```bash
-ecli --help
+conquest --help
 ```
 
-#### Global Options
+### Global Options
 
 | Option                      | Environment Variable | Description                      | Default    |
 | --------------------------- | -------------------- | -------------------------------- | ---------- |
@@ -34,13 +32,7 @@ ecli --help
 | `--storage <type>`          | `STORAGE_TYPE`       | Storage backend: json or sqlite  | json       |
 | `--storage-path <path>`     | `STORAGE_PATH`       | Storage directory path           | ./data     |
 
-#### MCP Server Options
-
-| Option       | Environment Variable | Description                  | Default |
-| ------------ | -------------------- | ---------------------------- | ------- |
-| `--ethereum` | `ETHEREUM_TOOLS`     | Include tools-ethereum tools | false   |
-
-#### Using Environment Variables
+### Using Environment Variables
 
 Set up your environment:
 
@@ -53,10 +45,10 @@ export PRIVATE_KEY=0x...
 Then run commands without repeating options:
 
 ```bash
-ecli get_my_planets --radius 10
+conquest get_my_planets --radius 10
 ```
 
-#### Available Commands
+### Available Commands
 
 | Command              | Description                             |
 | -------------------- | --------------------------------------- |
@@ -70,50 +62,30 @@ ecli get_my_planets --radius 10
 | `get_pending_fleets` | Get pending fleets                      |
 | `verify_exit_status` | Check a planet's exit status            |
 
-#### Examples
+### Examples
 
 ```bash
 # Get your planets
-ecli get_my_planets --radius 10
+conquest get_my_planets --radius 10
 
 # Find planets near a location
-ecli get_planets_around --center-x 0 --center-y 0 --radius 20
+conquest get_planets_around --center-x 0 --center-y 0 --radius 20
 
 # Acquire planets
-ecli acquire_planets --planet-ids 1,2,3,4,5
+conquest acquire_planets --planet-ids 1,2,3,4,5
 
 # Send a fleet (coordinates use x,y format)
-ecli send_fleet --from 10,20 --to 15,25 --quantity 100
+conquest send_fleet --from 10,20 --to 15,25 --quantity 100
 
 # Resolve a fleet
-ecli resolve_fleet --fleet-id "your-fleet-id"
+conquest resolve_fleet --fleet-id "your-fleet-id"
 
 # Exit planets
-ecli exit_planets --planet-ids 1,2,3
+conquest exit_planets --planet-ids 1,2,3
 ```
 
 See [`EXAMPLES.md`](./EXAMPLES.md) for more detailed usage examples.
 
-### MCP Server Mode
-
-Start the MCP server for AI assistant integration:
-
-```bash
-ecli mcp --rpc-url https://rpc.gnosischain.com --game-contract 0x322813fd9a801c5507c9de605d63cea4f2ce6c44
-```
-
-Or use the MCP Inspector for testing:
-
-```bash
-pnpm mcp:inspector ecli --game-contract 0xD833d4dBBb0C19aF1EEf76540d66E2076a5e9D72 --rpc-url https://rpc.gnosis.gateway.fm
-```
-
-For Conquest 2025-1 edition, use:
-
-```bash
-pnpm mcp:inspector ecli --game-contract 0xD833d4dBBb0C19aF1EEf76540d66E2076a5e9D72 --rpc-url https://rpc.gnosis.gateway.fm
-```
-
 ## Architecture
 
 The CLI follows a dual-mode architecture:
@@ -213,6 +185,28 @@ pnpm format
 pnpm start
 ```
 
+## MCP Server Mode (Alternative)
+
+As an alternative to direct CLI usage, `conquest` can also run as an MCP (Model Context Protocol) server for.
+
+Start the MCP server:
+
+```bash
+conquest --rpc-url https://rpc.gnosischain.com --game-contract 0x322813fd9a801c5507c9de605d63cea4f2ce6c44 mcp
+```
+
+MCP-specific options:
+
+| Option       | Environment Variable | Description                  | Default |
+| ------------ | -------------------- | ---------------------------- | ------- |
+| `--ethereum` | `ETHEREUM_TOOLS`     | Include tools-ethereum tools | false   |
+
+For testing with the MCP Inspector:
+
+```bash
+pnpm mcp:inspector conquest --game-contract 0xD833d4dBBb0C19aF1EEf76540d66E2076a5e9D72 --rpc-url https://rpc.gnosis.gateway.fm mcp
+```
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@conquest-eth/tools",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Tools for Conquest.eth, including mcp server",
   "author": "Ronan Sandford",
   "license": "MIT",
@@ -13,11 +13,12 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/wighawag/tools-conquest-eth-v0.git"
+    "url": "git+https://github.com/wighawag/conquest-eth-for-lobsters",
+    "directory": "lobsters/tools"
   },
-  "homepage": "https://github.com/wighawag/tools-conquest-eth-v0#readme",
+  "homepage": "https://github.com/wighawag/conquest-eth-for-lobsters/blob/main/lobsters/tools/README.md",
   "bugs": {
-    "url": "https://github.com/wighawag/tools-conquest-eth-v0/issues"
+    "url": "https://github.com/wighawag/conquest-eth-for-lobsters/issues"
   },
   "publishConfig": {
     "access": "public"