stock-scanner-mcp 1.16.2 → 1.16.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 CHANGED
@@ -208,6 +208,14 @@ Data is stored locally in `workspace.json` — no cloud sync, no external calls.
208
208
 
209
209
  For the full list of workspace tools, see the [tool reference](#workspace--personalized-context-optional-no-api-key) below.
210
210
 
211
+ ## Documentation
212
+
213
+ - **[Installation & Setup](https://github.com/yyordanov-tradu/stock-scanner-mcp/wiki/Installation-&-Setup)** — Getting the MCP server running in Claude Code or Cursor
214
+ - **[Trading Skills](https://github.com/yyordanov-tradu/stock-scanner-mcp/wiki/Trading-Skills)** — Ready-made workflows for professional analysis
215
+ - **[Sidecar HTTP API](https://github.com/yyordanov-tradu/stock-scanner-mcp/wiki/Sidecar-HTTP-API)** — REST endpoints for non-MCP clients
216
+ - **[Docker Deployment](docs/DOCKER.md)** — Running in containers with workspace persistence
217
+ - **[FAQ & Troubleshooting](https://github.com/yyordanov-tradu/stock-scanner-mcp/wiki/FAQ-&-Troubleshooting)** — Common issues and solutions
218
+
211
219
  ## Modules
212
220
 
213
221
  | Module | Tools | API Key | Description |
@@ -399,14 +407,16 @@ An optional HTTP server exposing all tools as REST endpoints for non-MCP integra
399
407
  npx stock-scanner-sidecar # Start on port 3200
400
408
  npx stock-scanner-sidecar --port 8080 # Custom port
401
409
 
410
+ # Optional: Enable the stateful Market Workspace via HTTP
411
+ npx stock-scanner-sidecar --enable-workspace --data-dir ./my-data
412
+
402
413
  # Access the OpenAPI spec
403
414
  curl http://localhost:3200/openapi.json
404
415
  ```
405
416
 
406
- See [Sidecar HTTP API](wiki-repo/Sidecar-HTTP-API.md) for endpoint details.
407
- ```
417
+ See [Sidecar HTTP API](https://github.com/yyordanov-tradu/stock-scanner-mcp/wiki/Sidecar-HTTP-API) for endpoint details.
408
418
 
409
- 55 endpoints including `/tradingview/quote`, `/options/chain`, `/frankfurter/convert`, and more. See [wiki](https://github.com/yyordanov-tradu/stock-scanner-mcp/wiki/Sidecar-HTTP-API) for the full route table.
419
+ **64 tools** exposed as REST routes, including `/tradingview/quote`, `/options/chain`, `/workspace/profile`, and more.
410
420
 
411
421
  ## Rate Limits
412
422
 
@@ -462,7 +472,8 @@ src/
462
472
  │ └── reddit/ # 3 tools — trending tickers, mentions, sentiment from Reddit
463
473
  ├── sidecar/
464
474
  │ ├── index.ts # HTTP sidecar entry point (port 3200)
465
- └── server.ts # HTTP request handler (55 endpoints)
475
+ ├── routes.ts # Declarative URL routing table
476
+ │ └── server.ts # Dynamic HTTP request handler
466
477
  └── shared/
467
478
  ├── http.ts # HTTP client with timeouts and key sanitization
468
479
  ├── cache.ts # In-memory TTL cache