stock-scanner-mcp 0.1.0
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/LICENSE +21 -0
- package/README.md +169 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1610 -0
- package/package.json +56 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Yordan Yordanov
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# stock-scanner-mcp
|
|
2
|
+
|
|
3
|
+
A modular MCP (Model Context Protocol) server that gives Claude Code real-time access to stock and crypto market data. Scan markets, check technicals, monitor insider trades, and track earnings — all from your terminal.
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx stock-scanner-mcp
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Or install globally:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install -g stock-scanner-mcp
|
|
15
|
+
stock-scanner-mcp
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Setup with Claude Code
|
|
19
|
+
|
|
20
|
+
Add to your Claude Code MCP config (`~/.claude.json` or project `.mcp.json`):
|
|
21
|
+
|
|
22
|
+
```json
|
|
23
|
+
{
|
|
24
|
+
"mcpServers": {
|
|
25
|
+
"stock-scanner": {
|
|
26
|
+
"command": "npx",
|
|
27
|
+
"args": ["-y", "stock-scanner-mcp"]
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### With API keys (optional, enables more tools):
|
|
34
|
+
|
|
35
|
+
```json
|
|
36
|
+
{
|
|
37
|
+
"mcpServers": {
|
|
38
|
+
"stock-scanner": {
|
|
39
|
+
"command": "npx",
|
|
40
|
+
"args": ["-y", "stock-scanner-mcp"],
|
|
41
|
+
"env": {
|
|
42
|
+
"FINNHUB_API_KEY": "your-key-here",
|
|
43
|
+
"ALPHA_VANTAGE_API_KEY": "your-key-here"
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
## Modules
|
|
51
|
+
|
|
52
|
+
| Module | Tools | API Key | Description |
|
|
53
|
+
|--------|-------|---------|-------------|
|
|
54
|
+
| tradingview | 6 | None | US stock scanner with real-time quotes, technicals, and screening |
|
|
55
|
+
| tradingview-crypto | 4 | None | Crypto pair scanner with technicals and screening |
|
|
56
|
+
| sec-edgar | 6 | None | SEC EDGAR filings, insider trades, institutional holdings, ownership |
|
|
57
|
+
| coingecko | 3 | None | Crypto market data, trending coins, global stats |
|
|
58
|
+
| finnhub | 3 | `FINNHUB_API_KEY` | Market news, company news, earnings calendar |
|
|
59
|
+
| alpha-vantage | 3 | `ALPHA_VANTAGE_API_KEY` | Stock quotes, daily prices, company fundamentals |
|
|
60
|
+
|
|
61
|
+
Modules auto-enable when their required environment variables are set. Modules with no required key are always enabled.
|
|
62
|
+
|
|
63
|
+
## Available Tools (25 total)
|
|
64
|
+
|
|
65
|
+
### TradingView — Stock Scanning (no API key)
|
|
66
|
+
|
|
67
|
+
| Tool | Description |
|
|
68
|
+
|------|-------------|
|
|
69
|
+
| `tradingview_scan` | Scan US stocks with custom filters (price, RSI, volume, etc.) |
|
|
70
|
+
| `tradingview_quote` | Real-time quotes for stock tickers |
|
|
71
|
+
| `tradingview_technicals` | Technical indicators (RSI, MACD, moving averages, pivots) |
|
|
72
|
+
| `tradingview_top_gainers` | Today's top gaining stocks |
|
|
73
|
+
| `tradingview_top_volume` | Highest volume stocks today |
|
|
74
|
+
| `tradingview_volume_breakout` | Stocks with unusual volume spikes |
|
|
75
|
+
|
|
76
|
+
### TradingView — Crypto (no API key)
|
|
77
|
+
|
|
78
|
+
| Tool | Description |
|
|
79
|
+
|------|-------------|
|
|
80
|
+
| `crypto_scan` | Scan crypto pairs with custom filters |
|
|
81
|
+
| `crypto_quote` | Real-time crypto pair quotes |
|
|
82
|
+
| `crypto_technicals` | Technical analysis for crypto pairs |
|
|
83
|
+
| `crypto_top_gainers` | Top gaining crypto pairs |
|
|
84
|
+
|
|
85
|
+
### SEC EDGAR — Filings & Ownership (no API key)
|
|
86
|
+
|
|
87
|
+
| Tool | Description |
|
|
88
|
+
|------|-------------|
|
|
89
|
+
| `edgar_search` | Full-text search across all SEC filings |
|
|
90
|
+
| `edgar_company_filings` | Recent official filings (10-K, 10-Q, 8-K) |
|
|
91
|
+
| `edgar_company_facts` | Financial metrics from XBRL data |
|
|
92
|
+
| `edgar_insider_trades` | Insider buy/sell activity (Form 4) |
|
|
93
|
+
| `edgar_institutional_holdings` | Institutional holdings (13F) |
|
|
94
|
+
| `edgar_ownership_filings` | Major ownership changes (13D/13G) |
|
|
95
|
+
|
|
96
|
+
### CoinGecko — Crypto Intelligence (no API key)
|
|
97
|
+
|
|
98
|
+
| Tool | Description |
|
|
99
|
+
|------|-------------|
|
|
100
|
+
| `coingecko_coin` | Detailed crypto info by CoinGecko ID |
|
|
101
|
+
| `coingecko_trending` | Top 7 trending cryptos by search volume |
|
|
102
|
+
| `coingecko_global` | Global crypto market statistics |
|
|
103
|
+
|
|
104
|
+
### Finnhub — News & Earnings (requires `FINNHUB_API_KEY`)
|
|
105
|
+
|
|
106
|
+
| Tool | Description |
|
|
107
|
+
|------|-------------|
|
|
108
|
+
| `finnhub_market_news` | Latest market news articles |
|
|
109
|
+
| `finnhub_company_news` | Company-specific news |
|
|
110
|
+
| `finnhub_earnings_calendar` | Upcoming/historical earnings dates |
|
|
111
|
+
|
|
112
|
+
### Alpha Vantage — Fundamentals (requires `ALPHA_VANTAGE_API_KEY`)
|
|
113
|
+
|
|
114
|
+
| Tool | Description |
|
|
115
|
+
|------|-------------|
|
|
116
|
+
| `alphavantage_quote` | Real-time stock quote |
|
|
117
|
+
| `alphavantage_daily` | Daily OHLCV price history |
|
|
118
|
+
| `alphavantage_overview` | Company fundamentals (PE, market cap, sector) |
|
|
119
|
+
|
|
120
|
+
## Configuration
|
|
121
|
+
|
|
122
|
+
### Environment Variables
|
|
123
|
+
|
|
124
|
+
| Variable | Required | Description |
|
|
125
|
+
|----------|----------|-------------|
|
|
126
|
+
| `FINNHUB_API_KEY` | No | Enables Finnhub module ([get free key](https://finnhub.io/)) |
|
|
127
|
+
| `ALPHA_VANTAGE_API_KEY` | No | Enables Alpha Vantage module ([get free key](https://www.alphavantage.co/support/#api-key)) |
|
|
128
|
+
|
|
129
|
+
### CLI Options
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
stock-scanner-mcp --modules tradingview,sec-edgar # Enable specific modules only
|
|
133
|
+
stock-scanner-mcp --default-exchange NYSE # Set default exchange
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
## Example Usage in Claude Code
|
|
137
|
+
|
|
138
|
+
Once configured, just ask Claude naturally:
|
|
139
|
+
|
|
140
|
+
- "What are the top gaining stocks today?"
|
|
141
|
+
- "Show me technicals for AAPL"
|
|
142
|
+
- "Any insider trades for TSLA in the last 30 days?"
|
|
143
|
+
- "What's trending in crypto right now?"
|
|
144
|
+
- "Find stocks with unusual volume today"
|
|
145
|
+
|
|
146
|
+
## Development
|
|
147
|
+
|
|
148
|
+
```bash
|
|
149
|
+
npm install
|
|
150
|
+
npm run build
|
|
151
|
+
npm test
|
|
152
|
+
node dist/index.js
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
## Rate Limits
|
|
156
|
+
|
|
157
|
+
| API | Free Tier Limit |
|
|
158
|
+
|-----|-----------------|
|
|
159
|
+
| TradingView | No documented limit (be reasonable) |
|
|
160
|
+
| SEC EDGAR | 10 requests/second |
|
|
161
|
+
| CoinGecko | ~30 calls/minute |
|
|
162
|
+
| Finnhub | 30 calls/second |
|
|
163
|
+
| Alpha Vantage | 5 calls/minute, 25 calls/day |
|
|
164
|
+
|
|
165
|
+
All modules use in-memory TTL caching to minimize API calls.
|
|
166
|
+
|
|
167
|
+
## License
|
|
168
|
+
|
|
169
|
+
MIT
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env node
|