@dimcool/mcp 0.1.1 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +49 -7
  2. package/dist/index.js +3855 -3587
  3. package/package.json +3 -2
package/README.md CHANGED
@@ -21,7 +21,7 @@ Add to your MCP config (`claude_desktop_config.json` or `.cursor/mcp.json`):
21
21
  "command": "npx",
22
22
  "args": ["@dimcool/mcp"],
23
23
  "env": {
24
- "DIM_WALLET_PRIVATE_KEY": "your-base58-solana-private-key",
24
+ "DIM_WALLET_STORE_PATH": "/absolute/path/to/mcp-wallet.json",
25
25
  "DIM_API_URL": "https://api.dim.cool"
26
26
  }
27
27
  }
@@ -29,20 +29,62 @@ Add to your MCP config (`claude_desktop_config.json` or `.cursor/mcp.json`):
29
29
  }
30
30
  ```
31
31
 
32
+ ### Bootstrap a wallet locally (recommended)
33
+
34
+ Create a local non-custodial wallet file (private key never leaves your machine):
35
+
36
+ ```bash
37
+ npx @dimcool/mcp init-wallet
38
+ ```
39
+
40
+ This prints:
41
+
42
+ - your public Solana address
43
+ - the local wallet store path
44
+ - the env snippet to add to your MCP config
45
+
46
+ ### Bring your own key (advanced)
47
+
48
+ If you already have a wallet:
49
+
50
+ ```bash
51
+ DIM_WALLET_PRIVATE_KEY=<base58-key> npx @dimcool/mcp
52
+ ```
53
+
32
54
  ### Environment Variables
33
55
 
34
- | Variable | Required | Description |
35
- | ------------------------ | -------- | ---------------------------------------------- |
36
- | `DIM_WALLET_PRIVATE_KEY` | Yes | Base58-encoded Solana private key |
37
- | `DIM_API_URL` | No | API base URL (default: `https://api.dim.cool`) |
38
- | `DIM_REFERRAL_CODE` | No | Referral code to use on first signup |
56
+ | Variable | Required | Description |
57
+ | ------------------------ | -------- | ------------------------------------------------------------------- |
58
+ | `DIM_WALLET_PRIVATE_KEY` | No\* | Base58-encoded Solana private key |
59
+ | `DIM_WALLET_STORE_PATH` | No | Local path to wallet store file (default: `~/.dim/mcp-wallet.json`) |
60
+ | `DIM_WALLET_AUTO_CREATE` | No | If `true`, auto-creates/stores a wallet when key/store is missing |
61
+ | `DIM_API_URL` | No | API base URL (default: `https://api.dim.cool`) |
62
+ | `DIM_REFERRAL_CODE` | No | Referral code to use on first signup |
63
+
64
+ \*Required if you do not use wallet store or auto-create.
39
65
 
40
66
  ### Wallet Auth Configuration
41
67
 
42
- - `@dimcool/mcp` uses `DIM_WALLET_PRIVATE_KEY` directly for wallet-based login and signing.
68
+ - `@dimcool/mcp` supports three wallet startup modes:
69
+ 1. direct key (`DIM_WALLET_PRIVATE_KEY`)
70
+ 2. local wallet store (`DIM_WALLET_STORE_PATH`)
71
+ 3. auto-create (`DIM_WALLET_AUTO_CREATE=true`)
43
72
  - Call `dim_login` before any wallet, games, chat, social, referrals, support, or market tools.
73
+ - Call `dim_get_balance` after login and before paid actions.
44
74
  - To generate/export a Base58 key programmatically, use [@dimcool/wallet](https://docs.dim.cool/guides/wallet-package).
45
75
 
76
+ ### Funding your wallet
77
+
78
+ - Send **USDC on Solana** to the wallet public address shown during bootstrap/import.
79
+ - Most paid actions (transfers, game bets, market buys) require USDC balance.
80
+ - If balance is low, agents should ask users to fund first, then retry.
81
+ - You can still start referral growth without pre-funding: onboarding referred users who play can earn rewards.
82
+
83
+ ### Skill templates for agent platforms
84
+
85
+ - OpenClaw starter skill: `skills/openclaw-dim/SKILL.md`
86
+ - Hermes starter skill: `skills/hermes-dim/SKILL.md`
87
+
46
88
  ## Available Tools
47
89
 
48
90
  ### Authentication