gatepay-local-mcp 1.0.2 → 1.0.3

package/Readme.md

@@ -14,11 +14,11 @@
 
 The server currently registers these signing modes:
 
-| `sign_mode`         | Status                              | Description                                                              |
-| ------------------- | ----------------------------------- | ------------------------------------------------------------------------ |
-| `local_private_key` | Ready when `EVM_PRIVATE_KEY` is set | Signs locally with your EVM private key                                  |
-| `quick_wallet`      | Ready after login                   | Uses the remote MCP wallet and can trigger device-flow login when needed |
-| `plugin_wallet`     | Placeholder                         | Reserved for future extension, not implemented yet                       |
+| `sign_mode`         | Status                                           | Description                                                              |
+| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------ |
+| `local_private_key` | Ready when `EVM_PRIVATE_KEY` is set              | Signs locally with your EVM private key                                  |
+| `quick_wallet`      | Ready after login                                | Uses the remote MCP wallet and can trigger device-flow login when needed |
+| `plugin_wallet`     | Ready when `PLUGIN_WALLET_TOKEN` is set          | Signs via browser extension wallet (e.g., Gate Wallet)                   |
 
 If `sign_mode` is omitted, the server auto-selects the highest-priority ready mode.
 
@@ -46,7 +46,24 @@ Put this into your MCP config such as `~/.cursor/mcp.json`, then restart the cli
 
 ### Cursor / Claude Desktop with quick wallet
 
-If you prefer remote wallet signing, you can omit `EVM_PRIVATE_KEY` and let the tool use `quick_wallet`:
+If you prefer remote wallet signing, you can omit `EVM_PRIVATE_KEY` and let the tool use `quick_wallet`. Note that you need to obtain API credentials from the wallet service provider.
+
+```json
+{
+  "mcpServers": {
+    "gatepay-mcp": {
+      "command": "npx",
+      "args": ["-y", "gatepay-local-mcp"]
+    }
+  }
+}
+```
+
+When `quick_wallet` has no saved token, the server can start a device-flow login and persist the token at `~/.gate-pay/auth.json`.
+
+### Cursor / Claude Desktop with plugin wallet
+
+If you want to use a browser extension wallet (like Gate Wallet) for signing, configure the plugin wallet mode:
 
 ```json
 {
@@ -55,15 +72,19 @@ If you prefer remote wallet signing, you can omit `EVM_PRIVATE_KEY` and let the
       "command": "npx",
       "args": ["-y", "gatepay-local-mcp"],
       "env": {
-        "MCP_WALLET_API_KEY": "your-api-key",
-        "MCP_WALLET_URL": "https://api.gatemcp.ai/mcp/dex"
+        "PLUGIN_WALLET_SERVER_URL": "https://your-plugin-wallet-server.com",
+        "PLUGIN_WALLET_TOKEN": "your-token-from-browser-wallet"
       }
     }
   }
 }
 ```
 
-When `quick_wallet` has no saved token, the server can start a device-flow login and persist the token at `~/.gate-pay/auth.json`.
+Before using plugin wallet mode:
+1. Install a compatible browser extension wallet (e.g., [Gate Wallet](https://www.gate.io/web3))
+2. Open the wallet extension in your browser and obtain the connection token
+3. Configure `PLUGIN_WALLET_SERVER_URL` and `PLUGIN_WALLET_TOKEN` in your MCP config
+4. The wallet extension must be active in your browser when making x402 requests
 
 ## Environment Variables
 
@@ -71,11 +92,11 @@ The server loads `.env` from the repository or package root at startup.
 
 ### Runtime variables
 
-| Variable             | Required | Default                          | Description                                                                 |
-| -------------------- | -------- | -------------------------------- | --------------------------------------------------------------------------- |
-| `EVM_PRIVATE_KEY`    | No       | —                                | Local EVM private key used by `local_private_key`; hex with or without `0x` |
-| `MCP_WALLET_API_KEY` | No       | —                                | API key used when connecting to the remote MCP wallet                       |
-| `MCP_WALLET_URL`     | No       | `https://api.gatemcp.ai/mcp/dex` | Remote MCP wallet server URL used by `quick_wallet`                         |
+| Variable                    | Required | Default | Description                                                                 |
+| --------------------------- | -------- | ------- | --------------------------------------------------------------------------- |
+| `EVM_PRIVATE_KEY`           | No       | —       | Local EVM private key used by `local_private_key`; hex with or without `0x` |
+| `PLUGIN_WALLET_SERVER_URL`  | No       | —       | Base URL for the plugin wallet MCP server (required for `plugin_wallet`)   |
+| `PLUGIN_WALLET_TOKEN`       | No       | —       | Authentication token for plugin wallet (required for `plugin_wallet`)      |
 
 ### Test and script variables
 
@@ -161,11 +182,11 @@ npm run test:mcp-tool
 
 ### Integration test notes
 
-`npm run test:mcp-tool` starts `dist/src/index.js` and calls `x402_request` against the configured remote wallet flow. In practice you usually want:
+`npm run test:mcp-tool` starts `dist/src/index.js` and calls `x402_request` against the configured remote wallet flow. The test requires proper wallet credentials to be configured.
 
 ```bash
 npm run build
-MCP_WALLET_API_KEY=your-key npm run test:mcp-tool
+npm run test:mcp-tool
 ```
 
 If you already logged in before, the saved token in `~/.gate-pay/auth.json` will be reused. Otherwise the quick wallet flow may require interactive device login. You can increase the timeout with `GATEPAY_MCP_TEST_TIMEOUT_MS`.