trading-platform-mcp-predic.../README.md
2026-01-16 08:33:15 -06:00

101 lines
2.8 KiB
Markdown

# MCP Predictions Server
ML Predictions Marketplace MCP Server for the Trading Platform. Manages prediction packages, purchases, delivery, and outcome validation.
## Prediction Types
| Type | Description | VIP Required |
|------|-------------|--------------|
| **AMD** | Accumulation/Manipulation/Distribution | - |
| **RANGE** | Range detection and breakout | - |
| **TPSL** | Take Profit/Stop Loss optimization | Platinum+ |
| **ICT_SMC** | ICT/SMC Smart Money Concepts | Platinum+ |
| **STRATEGY_ENSEMBLE** | Multi-model ensemble | Diamond |
## Asset Classes
- FOREX (e.g., EURUSD, GBPJPY)
- CRYPTO (e.g., BTCUSD, ETHUSD)
- INDICES (e.g., SPX500, NAS100)
- COMMODITIES (e.g., XAUUSD, XTIUSD)
## Quick Start
```bash
npm install
cp .env.example .env
npm run dev
```
## API Endpoints
### Packages
- `POST /api/v1/packages` - Create package (admin)
- `GET /api/v1/packages` - List packages
- `GET /api/v1/packages/:id` - Get package
- `PATCH /api/v1/packages/:id/status` - Update status
### Purchases
- `POST /api/v1/purchases` - Purchase package
- `GET /api/v1/purchases/:id` - Get purchase
- `GET /api/v1/users/:userId/purchases` - User purchases
### Predictions
- `POST /api/v1/predictions` - Request prediction
- `GET /api/v1/predictions` - List predictions
- `GET /api/v1/predictions/:id` - Get prediction
### Outcomes
- `POST /api/v1/predictions/:id/outcome` - Record outcome
- `GET /api/v1/predictions/:id/outcome` - Get outcome
### Stats
- `GET /api/v1/users/:userId/prediction-stats` - User stats
## MCP Tools (13)
| Tool | Description |
|------|-------------|
| `prediction_create_package` | Create package |
| `prediction_get_package` | Get package |
| `prediction_list_packages` | List packages |
| `prediction_update_package_status` | Update status |
| `prediction_purchase_package` | Purchase package |
| `prediction_get_purchase` | Get purchase |
| `prediction_get_user_purchases` | User purchases |
| `prediction_request` | Request prediction |
| `prediction_get` | Get prediction |
| `prediction_list` | List predictions |
| `prediction_record_outcome` | Record outcome |
| `prediction_get_outcome` | Get outcome |
| `prediction_get_user_stats` | User stats |
## Prediction Status
- `PENDING` - Awaiting delivery
- `DELIVERED` - Prediction delivered
- `EXPIRED` - Prediction expired
- `VALIDATED` - Outcome verified (win/partial)
- `INVALIDATED` - Outcome verified (loss/expired)
## Outcome Results
- `WIN` - Prediction was correct
- `LOSS` - Prediction was incorrect
- `PARTIAL` - Partially correct
- `EXPIRED` - Price not reached before expiry
- `CANCELLED` - Trade cancelled
## Features
- Package-based prediction credits
- VIP tier requirements for premium models
- 24-hour prediction validity
- Outcome tracking and validation
- Win rate statistics
- Integration with Wallet and VIP services
## License
UNLICENSED - Private