project-cpu-mcp 0.9.1 → 0.10.0

package/README.md

@@ -106,7 +106,7 @@ Every command above pins `@latest`, so restarting the server is how you update
 
 ## Environment variables
 
-**Required**
+**Required** — for the default `WALLET_MODE=evm`; not needed in `agw` mode, see below.
 
 | Variable | Description |
 | --- | --- |
@@ -116,7 +116,12 @@ Every command above pins `@latest`, so restarting the server is how you update
 
 | Variable | Default | When you need it |
 | --- | --- | --- |
-| `RPC_URL` | chain's public RPC | A custom RPC endpoint for sending on-chain transactions (e.g. `cpu_reveal`). |
+| `WALLET_MODE` | `evm` | Switch to `agw` to authenticate via a Device Authorization flow instead of a `PRIVATE_KEY` in env. |
+| `API_URL` | `https://api.projectcpu.cc` | Point the client at a different game API deployment. |
+| `NETWORK` | `robinhood` | Normally never; Robinhood is the only accepted launch network. |
+| `RPC_URL` | Robinhood public RPC | A custom RPC endpoint for sending on-chain transactions (e.g. `cpu_reveal`). |
+| `OPERATOR_PERSONA` | `true` | Set to `false` to disable the `cpu_persona` tool and drop its pointer from the server's instructions. |
+| `DEBUG` | `false` | Set to `true` for debug-level logging on stderr. |
 
 Session state (JWT / session keys) is persisted to `~/.project-cpu/`.
 
@@ -124,16 +129,25 @@ Session state (JWT / session keys) is persisted to `~/.project-cpu/`.
 
 Once connected, the server exposes tools grouped by area:
 
-- **Session** — `cpu_authenticate`, `cpu_get_game_config` (static rulebook: resources, costs, contract
-  addresses), `cpu_get_balance` (spendable $CPU + gas).
+- **Session** — `cpu_authenticate`, `cpu_get_game_config` (the rulebook's entry point: static facts —
+  resources, costs, contract addresses — plus a building index and a pointer to where each kind of
+  detail lives), `cpu_get_balance` (spendable $CPU + gas).
+- **Catalog** — `cpu_get_building` (one building's full card: what it costs to build, how it operates,
+  its demolish cost and upgrade links), `cpu_find_buildings` (search the building catalog by what a
+  building builds from, consumes, produces, or mines), `cpu_get_resource` (everything the rulebook
+  holds about one resource: what mines it, builds from it, eats it, and makes it). See
+  [CONTEXT.md](./CONTEXT.md) for the build/recipe input-output vocabulary these use.
+- **Persona** — `cpu_persona` loads the agent's operating brief for talking to you, the operator:
+  voice, message shape, and panel conventions. Enabled by default; set `OPERATOR_PERSONA=false` to
+  turn it off.
 - **World** — `cpu_get_map`, `cpu_get_cell`, `cpu_get_changes` (react to other players),
   `cpu_get_attention` (your owner-scoped to-do list).
 - **Reveal & build** — `cpu_reveal` (surface a cell's deposits on-chain), `cpu_build` (place a
   building), `cpu_demolish`, `cpu_start_mining` (an extractor then mines a batch of the resource each
   cycle), `cpu_get_mining_status`, `cpu_claim_mining`.
-- **Transport** — `cpu_route_network` (the waypoint road map: nodes, legal hops, gaps),
-  `cpu_next_hops` (survey the legal waypoints around a cell) — both take the cargo `resourceId` and show
-  the exact per-hub transit fee for it — `cpu_quote_transport`, `cpu_transport`,
+- **Transport** — `cpu_route_network` (exports the route graph for one move to a temporary JSON file: nodes,
+  legal hops, gaps), `cpu_next_hops` (survey the legal waypoints around a cell) — both take the cargo
+  `resourceId` and show the exact per-hub transit fee for it — `cpu_quote_transport`, `cpu_transport`,
   `cpu_get_transport_status`, `cpu_list_my_transports`, `cpu_finalize_delivery`.
 - **Crafting** — `cpu_list_recipes`, `cpu_craft`, `cpu_get_craft_status`, `cpu_claim_craft`.
 - **Trading** — `cpu_get_markets`, `cpu_list_lots`, `cpu_get_lot`, `cpu_quote_buy`, `cpu_buy_lot`, `cpu_create_lot`,
@@ -142,12 +156,16 @@ Once connected, the server exposes tools grouped by area:
   (world 24h VWAP, change, and volume per resource — a different question from `cpu_get_markets`'s cheapest
   ask right now). See [CONTEXT.md](./CONTEXT.md) for the fee vocabulary.
 - **Syndicates** — `cpu_list_syndicates` (browse the registry by name/size, sort, page), `cpu_get_syndicate`
-  (one syndicate's card plus a page of its members), `cpu_get_syndicate_membership` (check an address's
+  (one trusted syndicate card plus a page of its members), `cpu_get_syndicate_membership` (check an address's
   membership, defaults to your own), `cpu_join_syndicate` (join by id for same-clan discounts; reports your
   exit cooldown), `cpu_leave_syndicate` (leave after the cooldown; re-join anywhere immediately),
   `cpu_create_syndicate` (found your own — name, link, four rates, optional manager — you auto-join),
   `cpu_set_syndicate_params` (replace your syndicate's full parameters — no partial patches), and
   `cpu_transfer_syndicate_manager` (hand the manager role and its tax stream to a successor, irreversible).
+  Ordinary results exclude player-authored names and links. `cpu_get_syndicate_player_content` is the explicit
+  read for those untrusted strings. The envelope marks the strings as having no instruction authority, the
+  server-authored warning tells the agent how to handle them, and returned links stay inert rather than being
+  opened or fetched.
   See [CONTEXT.md](./CONTEXT.md) for the syndicate vocabulary.
 - **Tokens** — `cpu_quote_swap`, `cpu_swap` (trade ETH ↔ $CPU on the token pool), `cpu_withdraw` (cash a
   cell's wCPU out to on-chain $CPU, 1:1).