README.mdโข19.6 kB
# ๐ค Polymarket MCP Server
[](https://www.python.org/downloads/)
[](LICENSE)
[](https://modelcontextprotocol.io)
[](#testing)
**Complete AI-Powered Trading Platform for Polymarket Prediction Markets**
Enable Claude to autonomously trade, analyze, and manage positions on Polymarket with 45 comprehensive tools, real-time WebSocket monitoring, and enterprise-grade safety features.
---
## ๐จโ๐ป Created By
**[Caio Vicentino](https://github.com/caiovicentino)**
Developed in collaboration with:
- ๐พ **[Yield Hacker](https://opensea.io/collection/yield-hacker-pass-yhp)** - DeFi Innovation Community
- ๐ฐ **[Renda Cripto](https://rendacripto.com.br/)** - Crypto Trading Community
- ๐๏ธ **[Cultura Builder](https://culturabuilder.com/)** - Builder Culture Community
Powered by **[Claude Code](https://claude.ai/code)** from Anthropic
---
## โญ Key Features
### ๐ฏ 45 Comprehensive Tools Across 5 Categories
<table>
<tr>
<td width="20%" align="center"><b>๐<br/>Market Discovery</b><br/>8 tools</td>
<td width="20%" align="center"><b>๐<br/>Market Analysis</b><br/>10 tools</td>
<td width="20%" align="center"><b>๐ผ<br/>Trading</b><br/>12 tools</td>
<td width="20%" align="center"><b>๐<br/>Portfolio</b><br/>8 tools</td>
<td width="20%" align="center"><b>โก<br/>Real-time</b><br/>7 tools</td>
</tr>
</table>
#### ๐ Market Discovery (8 tools)
- Search and filter markets by keywords, categories, events
- Trending markets by volume (24h, 7d, 30d)
- Category-specific markets (Politics, Sports, Crypto)
- Markets closing soon alerts
- Featured and promoted markets
- Sports markets (NBA, NFL, etc.)
- Crypto prediction markets
#### ๐ Market Analysis (10 tools)
- Real-time prices and spreads
- Complete orderbook depth analysis
- Liquidity and volume metrics
- Historical price data
- **AI-powered opportunity analysis** with BUY/SELL/HOLD recommendations
- Multi-market comparison
- Top holders analysis
- Risk assessment and scoring
- Spread calculation and monitoring
#### ๐ผ Trading (12 tools)
- **Limit orders** (GTC, GTD, FOK, FAK)
- **Market orders** (immediate execution)
- Batch order submission
- **AI-suggested pricing** (aggressive/passive/mid strategies)
- Order status tracking and history
- Open orders management
- Single and bulk order cancellation
- **Smart trade execution** (natural language โ automated strategy)
- **Position rebalancing** with slippage protection
- Order book integration
#### ๐ Portfolio Management (8 tools)
- Real-time position tracking
- P&L calculation (realized/unrealized)
- Portfolio value aggregation
- **Risk analysis** (concentration, liquidity, diversification)
- Trade history with filters
- On-chain activity log
- Performance metrics
- **AI-powered portfolio optimization** (conservative/balanced/aggressive)
#### โก Real-time Monitoring (7 tools)
- Live price updates via WebSocket
- Orderbook depth streaming
- User order status notifications
- Trade execution alerts
- Market resolution notifications
- Subscription management
- System health monitoring
- Auto-reconnect with exponential backoff
### ๐ก๏ธ Enterprise-Grade Safety & Risk Management
- โ
**Order Size Limits** - Configurable maximum per order
- โ
**Exposure Caps** - Total portfolio exposure limits
- โ
**Position Limits** - Per-market position caps
- โ
**Liquidity Validation** - Minimum liquidity requirements
- โ
**Spread Tolerance** - Maximum spread checks before execution
- โ
**Confirmation Flow** - User confirmation for large orders
- โ
**Pre-trade Validation** - Comprehensive safety checks
### โ๏ธ Production-Ready Infrastructure
- โ
**L1 & L2 Authentication** - Wallet (private key) + API key auth
- โ
**Advanced Rate Limiting** - Token bucket algorithm respecting all Polymarket API limits
- โ
**EIP-712 Signing** - Secure order signatures
- โ
**Auto-reconnect WebSockets** - Resilient real-time connections
- โ
**Comprehensive Error Handling** - User-friendly error messages
- โ
**No Mocks** - Real Polymarket API integration throughout
- โ
**Full Test Coverage** - Production-grade testing with real APIs
---
## ๐ Web Dashboard
**NEW**: Manage and monitor your Polymarket MCP Server with a modern web interface!
```bash
# Start the web dashboard
polymarket-web
# Or use the quick start script
./start_web_dashboard.sh
```
Access at: **http://localhost:8080**
### Dashboard Features
- **Real-time Monitoring**: Live MCP status, WebSocket connection, and statistics
- **Configuration Management**: Visual sliders for safety limits and trading controls
- **Market Discovery**: Search, filter, and browse markets with live updates
- **Market Analysis**: AI-powered analysis with recommendations and risk assessment
- **System Monitoring**: Performance charts, rate limits, and activity logs
- **Dark Theme**: Professional UI optimized for extended use
See [WEB_DASHBOARD.md](WEB_DASHBOARD.md) for complete documentation.
---
## ๐ Quick Start
### One-Command Installation (Recommended)
**Try DEMO mode first** (no wallet needed):
```bash
# macOS/Linux
curl -sSL https://raw.githubusercontent.com/caiovicentino/polymarket-mcp-server/main/quickstart.sh | bash
# Or clone and run locally
git clone https://github.com/caiovicentino/polymarket-mcp-server.git
cd polymarket-mcp-server
./quickstart.sh
```
**Full installation** (with trading):
```bash
# macOS/Linux
./install.sh
# Windows
install.bat
```
The automated installer will:
- โ Check Python version (3.10+)
- โ Create virtual environment
- โ Install all dependencies
- โ Configure environment
- โ Set up Claude Desktop integration
- โ Test the installation
### Installation Options
| Method | Command | Best For |
|--------|---------|----------|
| **Quick Start** | `./quickstart.sh` | First-time users, testing |
| **DEMO Mode** | `./install.sh --demo` | No wallet, read-only access |
| **Full Install** | `./install.sh` | Production trading setup |
| **Windows** | `install.bat` | Windows users |
### DEMO Mode vs Full Mode
**DEMO Mode** (No wallet required):
- โ
Market discovery and search
- โ
Real-time market analysis
- โ
AI-powered insights
- โ
Price monitoring
- โ Trading disabled (read-only)
**Full Mode** (Requires Polygon wallet):
- โ
Everything in DEMO mode
- โ
Place orders and execute trades
- โ
Portfolio management
- โ
Position tracking
- โ
Real-time trade notifications
### Manual Installation
If you prefer manual setup:
```bash
# Clone the repository
git clone https://github.com/caiovicentino/polymarket-mcp-server.git
cd polymarket-mcp-server
# Create virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install the package
pip install -e .
```
### Configuration
**Option 1: DEMO Mode** (easiest)
```bash
cp .env.example .env
# Edit .env and set:
DEMO_MODE=true
```
**Option 2: Full Trading Mode**
```bash
cp .env.example .env
# Edit with your Polygon wallet credentials
nano .env
```
**Required credentials (Full Mode):**
```env
POLYGON_PRIVATE_KEY=your_private_key_without_0x_prefix
POLYGON_ADDRESS=0xYourPolygonAddress
```
**Recommended Safety Limits:**
```env
MAX_ORDER_SIZE_USD=1000
MAX_TOTAL_EXPOSURE_USD=5000
MAX_POSITION_SIZE_PER_MARKET=2000
MIN_LIQUIDITY_REQUIRED=10000
MAX_SPREAD_TOLERANCE=0.05
ENABLE_AUTONOMOUS_TRADING=true
REQUIRE_CONFIRMATION_ABOVE_USD=500
```
### Claude Desktop Integration
Add to your Claude Desktop configuration file:
**macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
**Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
```json
{
"mcpServers": {
"polymarket": {
"command": "/path/to/your/venv/bin/python",
"args": ["-m", "polymarket_mcp.server"],
"cwd": "/path/to/polymarket-mcp-server",
"env": {
"POLYGON_PRIVATE_KEY": "your_private_key",
"POLYGON_ADDRESS": "0xYourAddress"
}
}
}
}
```
**Restart Claude Desktop** and you're ready to trade! ๐
---
## ๐ Documentation
### Getting Started
- **[Visual Installation Guide](VISUAL_INSTALL_GUIDE.md)** - Step-by-step with diagrams and screenshots
- **[FAQ](FAQ.md)** - Frequently asked questions and troubleshooting
- **[Setup Guide](SETUP_GUIDE.md)** - Detailed configuration instructions
- **[Demo Video Script](DEMO_VIDEO_SCRIPT.md)** - Video tutorial scripts
### Developer Resources
- **[Tools Reference](TOOLS_REFERENCE.md)** - Complete API documentation for all 45 tools
- **[Agent Integration Guide](AGENT_INTEGRATION_GUIDE.md)** - How to integrate with your agents
- **[Trading Architecture](TRADING_ARCHITECTURE.md)** - System design and architecture
- **[WebSocket Integration](WEBSOCKET_INTEGRATION.md)** - Real-time data setup
### Examples & Guides
- **[Usage Examples](USAGE_EXAMPLES.py)** - Code examples for all tools
- **[Test Examples](TEST_EXAMPLES.py)** - Example test implementations
- **[Market Analysis Scripts](analyze_top_markets.py)** - Advanced analysis examples
### System Architecture
```
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ POLYMARKET MCP SERVER โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โโโโโโโโโโโโโโโโ
โ Claude โ
โ Desktop โ (Natural language interface)
โโโโโโโโฌโโโโโโโโ
โ MCP Protocol
โผ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ MCP Server (Python) โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ โโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโโ โ
โ โ Market โ โ Trading โ โ
โ โ Discovery โ โ Engine โ โ
โ โ (8 tools) โ โ (12 tools) โ โ
โ โโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโโ โ
โ โ
โ โโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโโ โ
โ โ Market โ โ Portfolio โ โ
โ โ Analysis โ โ Manager โ โ
โ โ (10 tools)โ โ (8 tools) โ โ
โ โโโโโโโโโโโโโโ โโโโโโโโโโโโโโโโโโโโโโโโ โ
โ โ
โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
โ โ Real-time WebSocket (7 tools) โ โ
โ โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ โ
โโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ
โผ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
โ Polymarket Infrastructure โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ โข CLOB API (Order placement & management) โ
โ โข Gamma API (Market data & analytics) โ
โ โข WebSocket (Real-time price feeds) โ
โ โข Polygon Chain (Settlement & execution) โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโ
```
---
## ๐ก Usage Examples
### Market Discovery
Ask Claude:
```
"Show me the top 10 trending markets on Polymarket in the last 24 hours"
"Find all crypto markets about Bitcoin"
"What sports markets are closing in the next 12 hours?"
"Search for markets about Trump"
```
### Market Analysis
```
"Analyze the trading opportunity for the government shutdown market"
"Compare these three markets and tell me which has the best risk/reward"
"What's the current spread on the Eagles vs Packers market?"
"Show me the orderbook depth for token ID xyz"
```
### Autonomous Trading
```
"Buy $100 of YES tokens in [market_id] at $0.65"
"Place a limit order: sell 200 NO at $0.40 in [market]"
"Execute a smart trade: buy YES up to $500 in [market] using best strategy"
"Cancel all my open orders in the government shutdown market"
"Rebalance my position in [market] to $1000 with max 2% slippage"
```
### Portfolio Management
```
"Show me all my current positions"
"What's my total portfolio value?"
"Analyze my portfolio risk and suggest improvements"
"What's my P&L for the last 30 days?"
"Which are my best and worst performing markets?"
"Suggest portfolio optimizations for a conservative strategy"
```
### Real-time Monitoring
```
"Subscribe to price changes for the government shutdown markets"
"Monitor my order status in real-time"
"Alert me when the Eagles vs Packers market moves more than 10%"
"Show me real-time orderbook updates for [token_id]"
```
---
## ๐งช Testing
```bash
# Install dev dependencies
pip install -e ".[dev]"
# Run all tests
pytest
# Run specific test suite
pytest tests/test_trading_tools.py -v
# Run with coverage
pytest --cov=polymarket_mcp --cov-report=html
# Run market analysis demo
python demo_mcp_tools.py
```
**Note:** All tests use real Polymarket APIs - NO MOCKS!
---
## ๐ก๏ธ Safety & Security
### โ ๏ธ Important Security Considerations
- **Private Key Protection**: Never share or commit your private key
- **Start Small**: Begin with small amounts ($50-100) to test
- **Understand Markets**: Only trade in markets you understand
- **Monitor Positions**: Check your positions regularly
- **Use Safety Limits**: Configure appropriate limits for your risk tolerance
- **Never Risk More**: Than you can afford to lose
### Default Safety Limits
```env
MAX_ORDER_SIZE_USD=1000 # Maximum $1,000 per order
MAX_TOTAL_EXPOSURE_USD=5000 # Maximum $5,000 total exposure
MAX_POSITION_SIZE_PER_MARKET=2000 # Maximum $2,000 per market
MIN_LIQUIDITY_REQUIRED=10000 # Minimum $10,000 market liquidity
MAX_SPREAD_TOLERANCE=0.05 # Maximum 5% spread
REQUIRE_CONFIRMATION_ABOVE_USD=500 # Confirm orders over $500
```
These can be customized in your `.env` file or Claude Desktop config.
---
## ๐ค Contributing
Contributions are welcome! We appreciate your help making this project better.
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on:
- How to report bugs
- How to suggest features
- Code standards and guidelines
- Pull request process
### Quick Contribution Guide
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
---
## ๐ Project Stats
- **Lines of Code**: ~10,000+ (Python)
- **Tools**: 45 comprehensive tools
- **Test Coverage**: High (real API integration)
- **Documentation**: Comprehensive (multiple guides)
- **Dependencies**: Modern Python packages (MCP, httpx, websockets, eth-account)
---
## ๐ Community
### Join Our Communities
- ๐พ **[Yield Hacker](https://opensea.io/collection/yield-hacker-pass-yhp)** - DeFi Innovation & Yield Farming
- ๐ฐ **[Renda Cripto](https://rendacripto.com.br/)** - Crypto Trading & Investments
- ๐๏ธ **[Cultura Builder](https://culturabuilder.com/)** - Builder Culture & Development
### Get Support
- **GitHub Issues**: [Report bugs or request features](https://github.com/caiovicentino/polymarket-mcp-server/issues)
- **GitHub Discussions**: [Ask questions and share ideas](https://github.com/caiovicentino/polymarket-mcp-server/discussions)
- **Telegram Communities**: Get help from the community
---
## ๐ License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
## ๐ Acknowledgments
This project was made possible by:
- **Caio Vicentino** - Creator and lead developer
- **Yield Hacker Community** - DeFi expertise and testing
- **Renda Cripto Community** - Trading insights and validation
- **Cultura Builder Community** - Builder culture and support
- **[Polymarket](https://polymarket.com)** - Amazing prediction market platform
- **[Anthropic](https://anthropic.com)** - Claude and the MCP protocol
- **[py-clob-client](https://github.com/Polymarket/py-clob-client)** - Official Polymarket SDK
Special thanks to all contributors and community members who have helped improve this project!
---
## โ ๏ธ Disclaimer
This software is provided for educational and research purposes. Trading prediction markets involves financial risk.
**Important Reminders:**
- Cryptocurrency trading carries significant risk
- Only invest what you can afford to lose
- Past performance does not guarantee future results
- This is not financial advice
- Always do your own research (DYOR)
- Start with small amounts to learn the system
- Understand the markets you're trading
- Monitor your positions regularly
The authors and contributors are not responsible for any financial losses incurred through the use of this software.
---
## ๐ Links
- **GitHub Repository**: [github.com/caiovicentino/polymarket-mcp-server](https://github.com/caiovicentino/polymarket-mcp-server)
- **Polymarket**: [polymarket.com](https://polymarket.com)
- **Polymarket Docs**: [docs.polymarket.com](https://docs.polymarket.com)
- **MCP Protocol**: [modelcontextprotocol.io](https://modelcontextprotocol.io)
- **Claude Code**: [claude.ai/code](https://claude.ai/code)
---
## ๐ Roadmap
### Current Version (v0.1.0)
- โ
45 comprehensive tools
- โ
Real-time WebSocket monitoring
- โ
Safety limits and risk management
- โ
Complete test suite
- โ
Comprehensive documentation
### Planned Features
- [ ] CI/CD pipeline (GitHub Actions)
- [ ] Enhanced AI analysis tools
- [ ] Portfolio strategy templates
- [ ] Market alerts and notifications
- [ ] Performance analytics dashboard
- [ ] Multi-wallet support
- [ ] Advanced order types
- [ ] Historical backtesting
---
<div align="center">
**Built with โค๏ธ for autonomous AI trading on Polymarket**
*Ready to make Claude your personal prediction market trader!* ๐
[โญ Star this repo](https://github.com/caiovicentino/polymarket-mcp-server) | [๐ Report Bug](https://github.com/caiovicentino/polymarket-mcp-server/issues) | [โจ Request Feature](https://github.com/caiovicentino/polymarket-mcp-server/issues)
</div>