angel-one-mcp 1.0.2 → 1.0.3
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 +42 -27
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# Angel One MCP Server
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/angel-one-mcp)
|
|
4
|
+
|
|
3
5
|
A [Model Context Protocol](https://modelcontextprotocol.io) server that exposes [Angel One SmartAPI](https://smartapi.angelone.in/) as tools for LLM clients like Claude Desktop, Claude Code, and other MCP-compatible apps.
|
|
4
6
|
|
|
5
7
|
Trade stocks, track portfolios, analyze markets, and manage orders — all through natural language.
|
|
@@ -34,14 +36,42 @@ https://raw.githubusercontent.com/ameernoufil/angel-one-mcp/main/docs/llm-setup.
|
|
|
34
36
|
- SmartAPI key from [smartapi.angelone.in](https://smartapi.angelone.in/)
|
|
35
37
|
- TOTP authenticator set up on your Angel One account
|
|
36
38
|
|
|
37
|
-
###
|
|
39
|
+
### Option A: Install via npm (Recommended)
|
|
38
40
|
|
|
39
|
-
|
|
40
|
-
2. Create an app to get your **API Key**
|
|
41
|
-
3. Note your **Client ID** (trading account code)
|
|
42
|
-
4. Set up TOTP and save the **Base32 secret** (shown during TOTP setup, not the QR code)
|
|
41
|
+
Install globally and create a config directory:
|
|
43
42
|
|
|
44
|
-
|
|
43
|
+
```bash
|
|
44
|
+
npm install -g angel-one-mcp
|
|
45
|
+
mkdir -p ~/.config/angel-one-mcp
|
|
46
|
+
cat > ~/.config/angel-one-mcp/.env << 'EOF'
|
|
47
|
+
ANGEL_API_KEY=your_smartapi_key
|
|
48
|
+
ANGEL_CLIENT_ID=your_client_id
|
|
49
|
+
ANGEL_PASSWORD=your_mpin
|
|
50
|
+
ANGEL_TOTP_SECRET=your_base32_totp_secret
|
|
51
|
+
EOF
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Then add to your MCP client config:
|
|
55
|
+
|
|
56
|
+
```json
|
|
57
|
+
{
|
|
58
|
+
"mcpServers": {
|
|
59
|
+
"angel-one": {
|
|
60
|
+
"type": "stdio",
|
|
61
|
+
"command": "npx",
|
|
62
|
+
"args": ["-y", "angel-one-mcp"],
|
|
63
|
+
"env": {
|
|
64
|
+
"ANGEL_API_KEY": "your_smartapi_key",
|
|
65
|
+
"ANGEL_CLIENT_ID": "your_client_id",
|
|
66
|
+
"ANGEL_PASSWORD": "your_mpin",
|
|
67
|
+
"ANGEL_TOTP_SECRET": "your_base32_totp_secret"
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Option B: Clone from source
|
|
45
75
|
|
|
46
76
|
```bash
|
|
47
77
|
git clone https://github.com/ameernoufil/angel-one-mcp.git
|
|
@@ -50,25 +80,14 @@ npm install
|
|
|
50
80
|
cp .env.example .env
|
|
51
81
|
```
|
|
52
82
|
|
|
53
|
-
Edit `.env` with your credentials:
|
|
54
|
-
|
|
55
|
-
```env
|
|
56
|
-
ANGEL_API_KEY=your_smartapi_key
|
|
57
|
-
ANGEL_CLIENT_ID=your_client_id
|
|
58
|
-
ANGEL_PASSWORD=your_mpin
|
|
59
|
-
ANGEL_TOTP_SECRET=your_base32_totp_secret
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
### 3. Build and run
|
|
83
|
+
Edit `.env` with your credentials, then build and run:
|
|
63
84
|
|
|
64
85
|
```bash
|
|
65
86
|
npm run build
|
|
66
87
|
npm start
|
|
67
88
|
```
|
|
68
89
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
Add to your MCP client config (e.g. Claude Desktop, Claude Code, Cursor):
|
|
90
|
+
Add to MCP client config (use absolute path to `build/index.js`):
|
|
72
91
|
|
|
73
92
|
```json
|
|
74
93
|
{
|
|
@@ -94,17 +113,13 @@ Or if using `.env`, omit the `env` block — the server loads `.env` automatical
|
|
|
94
113
|
|
|
95
114
|
**Soft limits** (bypassable with `force: true`):
|
|
96
115
|
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
| Max order quantity | 25 | `SOFT_MAX_ORDER_QTY` |
|
|
100
|
-
| Max order value | ₹10,000 | `SOFT_MAX_ORDER_VALUE` |
|
|
116
|
+
- Max order quantity: 25 (`SOFT_MAX_ORDER_QTY`)
|
|
117
|
+
- Max order value: ₹10,000 (`SOFT_MAX_ORDER_VALUE`)
|
|
101
118
|
|
|
102
119
|
**Hard limits** (env var change + restart):
|
|
103
120
|
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
| Max order quantity | 100 | `HARD_MAX_ORDER_QTY` |
|
|
107
|
-
| Max order value | ₹1,00,000 | `HARD_MAX_ORDER_VALUE` |
|
|
121
|
+
- Max order quantity: 100 (`HARD_MAX_ORDER_QTY`)
|
|
122
|
+
- Max order value: ₹1,00,000 (`HARD_MAX_ORDER_VALUE`)
|
|
108
123
|
|
|
109
124
|
### Development
|
|
110
125
|
|