bitget-mcp-server 1.0.2 → 1.0.4
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.
- package/README.md +93 -7
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +9 -1
package/README.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<img src="https://
|
|
2
|
+
<img src="https://raw.githubusercontent.com/anjieyang/bitget-mcp-server/main/assets/logo.png" alt="Bitget" width="80" />
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
5
|
<h1 align="center">Bitget MCP Server</h1>
|
|
@@ -57,7 +57,12 @@ A [Model Context Protocol (MCP)](https://modelcontextprotocol.io) server that gi
|
|
|
57
57
|
- **Node.js** >= 18
|
|
58
58
|
- A [**Bitget API key**](https://www.bitget.com/account/newapi) with appropriate permissions
|
|
59
59
|
|
|
60
|
-
###
|
|
60
|
+
### Installation
|
|
61
|
+
|
|
62
|
+
Choose your AI client and copy the configuration:
|
|
63
|
+
|
|
64
|
+
<details>
|
|
65
|
+
<summary><strong>Cursor</strong></summary>
|
|
61
66
|
|
|
62
67
|
Add to `.cursor/mcp.json` in your project root:
|
|
63
68
|
|
|
@@ -77,9 +82,14 @@ Add to `.cursor/mcp.json` in your project root:
|
|
|
77
82
|
}
|
|
78
83
|
```
|
|
79
84
|
|
|
80
|
-
|
|
85
|
+
</details>
|
|
86
|
+
|
|
87
|
+
<details>
|
|
88
|
+
<summary><strong>Claude Desktop</strong></summary>
|
|
81
89
|
|
|
82
|
-
Add to your
|
|
90
|
+
Add to your config file:
|
|
91
|
+
- **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
92
|
+
- **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
|
|
83
93
|
|
|
84
94
|
```json
|
|
85
95
|
{
|
|
@@ -97,16 +107,65 @@ Add to your Claude Desktop config (`~/Library/Application Support/Claude/claude_
|
|
|
97
107
|
}
|
|
98
108
|
```
|
|
99
109
|
|
|
100
|
-
|
|
110
|
+
</details>
|
|
111
|
+
|
|
112
|
+
<details>
|
|
113
|
+
<summary><strong>Claude Code</strong></summary>
|
|
114
|
+
|
|
115
|
+
Run in your terminal:
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
claude mcp add-json bitget '{
|
|
119
|
+
"command": "npx",
|
|
120
|
+
"args": ["-y", "bitget-mcp-server", "--modules", "all"],
|
|
121
|
+
"env": {
|
|
122
|
+
"BITGET_API_KEY": "your-api-key",
|
|
123
|
+
"BITGET_SECRET_KEY": "your-secret-key",
|
|
124
|
+
"BITGET_PASSPHRASE": "your-passphrase"
|
|
125
|
+
}
|
|
126
|
+
}'
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Verify with `claude mcp list`.
|
|
130
|
+
|
|
131
|
+
</details>
|
|
132
|
+
|
|
133
|
+
<details>
|
|
134
|
+
<summary><strong>VS Code (Copilot)</strong></summary>
|
|
135
|
+
|
|
136
|
+
Add to `.vscode/settings.json` in your project root:
|
|
137
|
+
|
|
138
|
+
```json
|
|
139
|
+
{
|
|
140
|
+
"mcp": {
|
|
141
|
+
"servers": {
|
|
142
|
+
"bitget": {
|
|
143
|
+
"command": "npx",
|
|
144
|
+
"args": ["-y", "bitget-mcp-server", "--modules", "all"],
|
|
145
|
+
"env": {
|
|
146
|
+
"BITGET_API_KEY": "your-api-key",
|
|
147
|
+
"BITGET_SECRET_KEY": "your-secret-key",
|
|
148
|
+
"BITGET_PASSPHRASE": "your-passphrase"
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
</details>
|
|
157
|
+
|
|
158
|
+
<details>
|
|
159
|
+
<summary><strong>Windsurf</strong></summary>
|
|
101
160
|
|
|
102
|
-
|
|
161
|
+
Add to `~/.codeium/windsurf/mcp_config.json`:
|
|
103
162
|
|
|
104
163
|
```json
|
|
105
164
|
{
|
|
106
165
|
"mcpServers": {
|
|
107
166
|
"bitget": {
|
|
108
167
|
"command": "npx",
|
|
109
|
-
"args": ["-y", "bitget-mcp-server", "--modules", "all"
|
|
168
|
+
"args": ["-y", "bitget-mcp-server", "--modules", "all"],
|
|
110
169
|
"env": {
|
|
111
170
|
"BITGET_API_KEY": "your-api-key",
|
|
112
171
|
"BITGET_SECRET_KEY": "your-secret-key",
|
|
@@ -117,6 +176,33 @@ For safe exploration without trading risk:
|
|
|
117
176
|
}
|
|
118
177
|
```
|
|
119
178
|
|
|
179
|
+
</details>
|
|
180
|
+
|
|
181
|
+
<details>
|
|
182
|
+
<summary><strong>Other MCP Clients</strong></summary>
|
|
183
|
+
|
|
184
|
+
For any MCP-compatible client, the server can be started with:
|
|
185
|
+
|
|
186
|
+
```bash
|
|
187
|
+
BITGET_API_KEY=your-api-key \
|
|
188
|
+
BITGET_SECRET_KEY=your-secret-key \
|
|
189
|
+
BITGET_PASSPHRASE=your-passphrase \
|
|
190
|
+
npx -y bitget-mcp-server --modules all
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
The server communicates over **stdio** — pipe stdin/stdout to your MCP client.
|
|
194
|
+
|
|
195
|
+
</details>
|
|
196
|
+
|
|
197
|
+
### Read-Only Mode
|
|
198
|
+
|
|
199
|
+
Append `--read-only` to disable all write/trade operations:
|
|
200
|
+
|
|
201
|
+
```diff
|
|
202
|
+
- "args": ["-y", "bitget-mcp-server", "--modules", "all"],
|
|
203
|
+
+ "args": ["-y", "bitget-mcp-server", "--modules", "all", "--read-only"],
|
|
204
|
+
```
|
|
205
|
+
|
|
120
206
|
---
|
|
121
207
|
|
|
122
208
|
## Available Modules
|
package/dist/index.js
CHANGED