@battlegrid/mcp-server 1.0.1 → 1.0.2

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 (2) hide show
  1. package/README.md +59 -83
  2. package/package.json +3 -4
package/README.md CHANGED
@@ -1,27 +1,38 @@
1
1
  # @battlegrid/mcp-server
2
2
 
3
- Play crypto prediction games on [BattleGrid](https://battlegrid.trade) directly from AI agents. This MCP server connects your agent to BattleGrid's platform — analyze markets, make predictions, and compete on leaderboards.
3
+ [![npm version](https://img.shields.io/npm/v/@battlegrid/mcp-server)](https://www.npmjs.com/package/@battlegrid/mcp-server)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
+
6
+ MCP server for [BattleGrid](https://battlegrid.trade) — play crypto prediction games from AI agents.
4
7
 
5
8
  ## Quick Start
6
9
 
7
- 1. **Get an API key** at [battlegrid.trade](https://battlegrid.trade) → Profile → MCP tab
8
- 2. **Add to your MCP client** (see below)
9
- 3. **Ask your agent**: *"Play a Market Grid game for me"*
10
+ ### npm (stdio transport)
10
11
 
11
- ## Setup
12
+ ```bash
13
+ BATTLEGRID_API_KEY=bg_live_xxx npx @battlegrid/mcp-server
14
+ ```
12
15
 
13
- ### Claude Desktop
16
+ ### Remote server (streamable-http transport)
14
17
 
15
- Add to your Claude Desktop MCP settings:
18
+ ```
19
+ https://mcp.battlegrid.trade
20
+ ```
21
+
22
+ No npm install required — connect directly from any MCP client that supports streamable-http.
23
+
24
+ ## Configuration
25
+
26
+ ### Claude Desktop
16
27
 
17
28
  ```json
18
29
  {
19
30
  "mcpServers": {
20
31
  "battlegrid": {
21
32
  "command": "npx",
22
- "args": ["-y", "@battlegrid/mcp-server"],
33
+ "args": ["@battlegrid/mcp-server"],
23
34
  "env": {
24
- "BATTLEGRID_API_KEY": "bg_live_your_key_here"
35
+ "BATTLEGRID_API_KEY": "bg_live_xxx"
25
36
  }
26
37
  }
27
38
  }
@@ -31,120 +42,85 @@ Add to your Claude Desktop MCP settings:
31
42
  ### Claude Code
32
43
 
33
44
  ```bash
34
- claude mcp add battlegrid \
35
- --transport stdio \
36
- -- npx -y @battlegrid/mcp-server \
37
- --env BATTLEGRID_API_KEY=bg_live_your_key_here
45
+ claude mcp add battlegrid -- npx @battlegrid/mcp-server
38
46
  ```
39
47
 
40
- ### Cursor
48
+ Set your API key:
49
+
50
+ ```bash
51
+ export BATTLEGRID_API_KEY=bg_live_xxx
52
+ ```
41
53
 
42
- In **Settings > MCP**, click **Add new MCP server**:
54
+ ### Cursor
43
55
 
44
56
  ```json
45
57
  {
46
58
  "mcpServers": {
47
59
  "battlegrid": {
48
60
  "command": "npx",
49
- "args": ["-y", "@battlegrid/mcp-server"],
61
+ "args": ["@battlegrid/mcp-server"],
50
62
  "env": {
51
- "BATTLEGRID_API_KEY": "bg_live_your_key_here"
63
+ "BATTLEGRID_API_KEY": "bg_live_xxx"
52
64
  }
53
65
  }
54
66
  }
55
67
  }
56
68
  ```
57
69
 
58
- ### Windsurf / Other MCP Clients
59
-
60
- Any client supporting stdio transport:
61
-
62
- | Setting | Value |
63
- |---------|-------|
64
- | **Command** | `npx` |
65
- | **Args** | `-y @battlegrid/mcp-server` |
66
- | **Env** | `BATTLEGRID_API_KEY=bg_live_your_key_here` |
70
+ ## Skills
67
71
 
68
- ## Alternative: Direct Remote Connection
72
+ Install the BattleGrid skill for AI agent instructions:
69
73
 
70
- If you prefer connecting directly without npm (no Node.js required):
71
-
72
- | Setting | Value |
73
- |---------|-------|
74
- | **URL** | `https://mcp.battlegrid.trade` |
75
- | **Transport** | `streamable-http` |
76
- | **Auth Header** | `Authorization: Bearer bg_live_your_key_here` |
77
-
78
- ## Environment Variables
79
-
80
- | Variable | Required | Description |
81
- |----------|----------|-------------|
82
- | `BATTLEGRID_API_KEY` | Yes | Your API key (starts with `bg_live_`) |
83
- | `BATTLEGRID_API_URL` | No | Override server URL (default: `https://mcp.battlegrid.trade`) |
74
+ ```bash
75
+ npx skills add playbattlegrid/battlegrid-mcp
76
+ ```
84
77
 
85
- ## What You Get
78
+ ## Capabilities
86
79
 
87
- ### 23 Tools
80
+ ### Tools (28)
88
81
 
89
82
  | Category | Tools |
90
83
  |----------|-------|
91
- | **Market Grid** (7) | `list_market_grid_sessions`, `get_market_grid_session`, `check_market_grid_submission`, `submit_market_grid`, `update_market_grid`, `get_market_grid_results`, `get_market_grid_player_grid` |
84
+ | **Market Grid** (7) | `list_market_grid_sessions`, `get_market_grid_session`, `check_market_grid_submission`, `submit_market_grid`, `get_market_grid_results`, `get_market_grid_player_grid`, `update_market_grid` |
92
85
  | **Coin Grid** (6) | `list_coin_grid_sessions`, `get_coin_grid_session`, `check_coin_grid_submission`, `submit_coin_grid`, `get_coin_grid_results`, `get_coin_grid_player_grid` |
93
- | **Account** (3) | `get_account_balance`, `get_user_profile`, `get_user_stats` |
86
+ | **Account** (6) | `get_account_balance`, `get_user_profile`, `get_user_stats`, `list_user_favorites`, `add_user_favorite_preset`, `remove_user_favorite_preset` |
94
87
  | **Leaderboard** (3) | `get_leaderboard`, `get_market_grid_leaderboard`, `get_hall_of_fame` |
95
88
  | **Market Data** (4) | `get_coin_overview`, `get_recent_candles`, `get_top_ranked_coins`, `list_game_presets` |
89
+ | **Intelligence Agent** (2) | `list_intelligence_agents`, `get_intelligence_agent` |
96
90
 
97
- ### 5 Prompts
91
+ ### Prompts (5)
98
92
 
99
93
  | Prompt | Description |
100
94
  |--------|-------------|
101
- | `play-market-grid` | Full game workflow: find session, research coins, submit predictions |
102
- | `play-coin-grid` | Coin Grid game workflow |
103
- | `analyze-market` | Deep market analysis for a coin or broad overview |
104
- | `check-performance` | Review stats, rankings, recent results |
105
- | `strategy-guide` | Learn game rules and strategies |
95
+ | `play-market-grid` | End-to-end workflow for playing a Market Grid prediction game |
96
+ | `play-coin-grid` | End-to-end workflow for playing a Coin Grid prediction game |
97
+ | `analyze-market` | Deep market analysis for informed predictions |
98
+ | `check-performance` | Review your game results, stats, and leaderboard standing |
99
+ | `strategy-guide` | Learn BattleGrid game mechanics, rules, and strategies |
106
100
 
107
- ### 3 Resources
101
+ ### Resources (3)
108
102
 
109
103
  | Resource | URI |
110
104
  |----------|-----|
111
105
  | Game Rules | `battlegrid://rules/overview` |
112
- | Grid Format | `battlegrid://reference/grid-format` |
113
- | Quick Start | `battlegrid://guide/quick-start` |
106
+ | Grid Format Reference | `battlegrid://reference/grid-format` |
107
+ | Quick Start Guide | `battlegrid://guide/quick-start` |
114
108
 
115
- ## How It Works
109
+ ## Authentication
116
110
 
117
- ```
118
- Your MCP Client (Claude, Cursor, etc.)
119
- |
120
- | stdio (local process)
121
- v
122
- @battlegrid/mcp-server (this package)
123
- |
124
- | streamable-http (authenticated)
125
- v
126
- https://mcp.battlegrid.trade
127
- (23 tools + 5 prompts + 3 resources)
128
- ```
129
-
130
- This package is a thin proxy — it connects to BattleGrid's remote server and re-exposes all capabilities over stdio. Tools, prompts, and resources auto-sync with the server. No package updates needed when new features launch.
131
-
132
- ## How to Deposit
111
+ 1. Go to [battlegrid.trade](https://battlegrid.trade) → **Profile** → **MCP** tab
112
+ 2. Generate an API key (format: `bg_live_*`)
113
+ 3. Set `BATTLEGRID_API_KEY` in your environment
133
114
 
134
- 1. Go to [battlegrid.trade](https://battlegrid.trade) and deposit funds into your account
135
- 2. Enable vault account at **Profile > MCP** tab to allow your agent to enter competitions remotely
136
- 3. Daily limits: 50 operations, $500 USD per day
115
+ For paid games, enable **Server-Signed Wagers** in the MCP tab to allow the agent to submit entries on your behalf.
137
116
 
138
- ## Troubleshooting
117
+ ## Environment Variables
139
118
 
140
- | Problem | Solution |
141
- |---------|----------|
142
- | `BATTLEGRID_API_KEY is required` | Set the environment variable in your MCP config |
143
- | `API key must start with "bg_live_"` | Create a new key at Profile > MCP tab |
144
- | `Cannot connect to BattleGrid server` | Check internet connection; verify `https://mcp.battlegrid.trade/health` |
145
- | `Invalid or revoked API key` | Create a new key at Profile > MCP tab |
146
- | Agent doesn't know game rules | Game instructions are auto-delivered on connect |
119
+ | Variable | Required | Description |
120
+ |----------|----------|-------------|
121
+ | `BATTLEGRID_API_KEY` | Yes | Your BattleGrid API key (`bg_live_*`) |
122
+ | `BATTLEGRID_API_URL` | No | Override server URL (default: `https://mcp.battlegrid.trade`) |
147
123
 
148
124
  ## License
149
125
 
150
- MIT
126
+ [MIT](LICENSE)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@battlegrid/mcp-server",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "BattleGrid MCP server — play crypto prediction games from AI agents",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -44,11 +44,10 @@
44
44
  "license": "MIT",
45
45
  "repository": {
46
46
  "type": "git",
47
- "url": "https://github.com/blockfer-rp/battlegrid-app",
48
- "directory": "packages/mcp-server"
47
+ "url": "https://github.com/playbattlegrid/battlegrid-mcp"
49
48
  },
50
49
  "homepage": "https://battlegrid.trade",
51
50
  "bugs": {
52
- "url": "https://github.com/blockfer-rp/battlegrid-app/issues"
51
+ "url": "https://github.com/playbattlegrid/battlegrid-mcp/issues"
53
52
  }
54
53
  }