Package Exports
- bitkub-mcp-server
- bitkub-mcp-server/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bitkub-mcp-server) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
🚀 Bitkub MCP Server
Get live cryptocurrency data from Bitkub exchange directly in Claude - zero setup required!
A Model Context Protocol (MCP) server that provides access to Bitkub cryptocurrency exchange public market data. No API keys needed, just real-time crypto data in your AI conversations.
⚠️ Important Disclaimer
🚨 THIS IS NOT AN OFFICIAL BITKUB PRODUCT 🚨
This is an unofficial, community-built tool that uses Bitkub's public API endpoints. It is NOT affiliated with, endorsed by, or supported by Bitkub in any way.
⚠️ IMPORTANT WARNINGS:
- Do Your Own Research (DYOR) - Never make trading decisions based solely on this data
- Not Financial Advice - This tool provides market data only, not investment recommendations
- Use at Your Own Risk - The creators are not responsible for any trading losses
- Verify All Data - Always cross-check with official Bitkub sources before trading
- API Limitations - This tool may break if Bitkub changes their public API
✅ Official Bitkub Resources:
- Website: bitkub.com
- Official API: github.com/bitkub/bitkub-official-api-docs
- Support: support.bitkub.com
🎯 Super Easy Setup (30 seconds)
Option 1: Zero Downloads (Recommended)
{
"mcpServers": {
"bitkub": {
"command": "npx",
"args": ["bitkub-mcp-server@latest"]
}
}
}Option 2: One-Line Install
curl -fsSL https://raw.githubusercontent.com/xbklairith/bitkub-mcp/main/scripts/install.sh | bashWhere to Add Config
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json - Linux:
~/.config/Claude/claude_desktop_config.json
👉 Interactive Config Generator - Visual guide with copy-paste
Paste config → Restart Claude → Ask: "What's the Bitcoin price?" → Done! 🎉
🛠️ Available Tools
| Tool | Description |
|---|---|
📊 bitkub_ticker |
Current prices for any trading pair |
📋 bitkub_market_symbols |
All 149+ available trading pairs |
🪙 bitkub_coins |
Cryptocurrency info with deposit/withdraw status |
📈 bitkub_orderbook |
Buy/sell order book depth |
💱 bitkub_trades |
Recent trade history |
🕐 bitkub_servertime |
Server timestamp |
⚡ bitkub_batch_ticker |
Multiple symbols with analysis |
📏 bitkub_spread_analysis |
Bid-ask spread analysis |
📤 bitkub_export |
Export data (CSV, JSON, table) |
💬 Example Questions for Claude
Basic Queries:
- "What's the current Bitcoin price on Bitkub?"
- "Show me all available trading pairs"
- "Which coins can I deposit or withdraw?"
- "Get the order book for Ethereum"
Market Analysis:
- "Which cryptocurrencies have the highest volume?"
- "Show me the bid-ask spreads for major coins"
- "Which trading pairs have the tightest spreads?"
Advanced Analytics:
- "Compare BTC, ETH, and ADA performance"
- "Export the top 10 cryptocurrencies to a table"
- "Show me low-volume trading pairs"
✨ Features
- ✅ No API Keys - Uses public Bitkub endpoints
- ✅ Real-time Data - Live market prices and updates
- ✅ Smart Caching - Efficient with built-in rate limiting
- ✅ Rich Analysis - Advanced market analytics
- ✅ Multiple Formats - CSV, JSON, table exports
- ✅ Zero Setup - Works instantly with npx
🔧 For Developers
Quick Development Setup
git clone https://github.com/xbklairith/bitkub-mcp.git
cd bitkub-mcp
npm install && npm run build
npm run setup:claude # Auto-configure ClaudeDevelopment Commands
npm run dev # Development mode
npm test # Run tests
npm run lint # Lint and format
npm run typecheck # Type checkingDirect API Usage
# List tools
echo '{"jsonrpc": "2.0", "id": 1, "method": "tools/list"}' | node dist/index.js
# Get BTC price
echo '{"jsonrpc": "2.0", "id": 2, "method": "tools/call", "params": {"name": "bitkub_ticker", "arguments": {"symbol": "THB_BTC"}}}' | node dist/index.jsProject Structure
src/
├── index.ts # MCP server entry point
├── bitkub/client.ts # Bitkub API client
├── tools/market/ # Market data tools
├── utils/ # Cache & rate limiting
└── types/ # TypeScript definitions📊 Examples
Run these after building:
node examples/basic-usage.js # Core functionality demo
node examples/market-monitor.js # Real-time BTC monitoring
node examples/advanced-analysis.js # Market analysis demo🆘 Troubleshooting
Claude doesn't respond to crypto questions?
- Restart Claude Desktop completely
- Check config file path for your OS
- Ensure config JSON is valid
Build/setup issues?
- Install Node.js 18+ from nodejs.org
- Try:
rm -rf node_modules && npm install
Config file doesn't exist?
- Create the file manually at the path shown above
- Use the interactive config generator
🏗️ Architecture
- TypeScript with strict mode
- MCP SDK for protocol compliance
- Axios for HTTP with smart caching
- Token bucket rate limiting
- Biome for linting/formatting
- Vitest for testing (18 tests, full coverage)
📄 License
MIT
🤝 Contributing
- Fork the repository
- Create feature branch
- Run
npm test && npm run lint - Submit pull request
Ready to explore crypto data with Claude! 🚀
Need help? Check the config generator or open an issue.