Implements environment variable configuration through .env files to securely store API credentials and server settings.
Uses Node.js as the runtime environment for the MCP server, requiring Node.js 18+ for operation.
Utilizes npm for package management and running scripts, including installation of dependencies and server execution.
Integrates with Zerodha's trading APIs to enable automated trading, including market data retrieval, order placement (buy/sell), portfolio management (holdings, positions, margins), and user authentication via OAuth.
Zerodha Trading Bot - MCP Server
A Model Context Protocol (MCP) server that integrates with Zerodha APIs for automated trading. This server provides tools for authentication, market data retrieval, order placement, and portfolio management.
Features
- OAuth Authentication: Secure authentication with Zerodha APIs
- Market Data: Real-time quotes and instrument information
- Trading Operations: Place, modify, and cancel orders
- Portfolio Management: View holdings, positions, and margins
- MCP Integration: Full Model Context Protocol compliance
Prerequisites
- Node.js 18+
- Zerodha API credentials (API Key and Secret)
- Zerodha trading account
Setup
1. Install Dependencies
2. Configure Environment Variables
Copy the example environment file and configure your Zerodha credentials:
Edit .env
with your Zerodha API credentials:
3. Get Zerodha API Credentials
- Log in to your Zerodha account
- Go to API Console
- Create a new application
- Note down your API Key and Secret
- Set the redirect URI to
http://localhost:3000/callback
4. Authentication
Start the authentication server:
Visit http://localhost:3000
and follow the OAuth flow. After successful authentication, you'll receive an access token. Add it to your .env
file:
Usage
Start the MCP Server
Test the Setup
Available Tools
The MCP server provides the following tools:
Authentication
get_login_url
: Get OAuth login URLauthenticate
: Authenticate with request tokenvalidate_token
: Check if access token is valid
Market Data
get_quote
: Get live quotes for symbolsget_instruments
: Get instrument information
Portfolio
get_user_profile
: Get user profileget_holdings
: Get current holdingsget_positions
: Get current positionsget_margins
: Get margin information
Trading
place_order
: Place trading ordersget_order_history
: Get order historycancel_order
: Cancel existing orders
Example Usage
Place a Market Order
Get Live Quotes
File Structure
Security Considerations
- Never commit your
.env
file to version control - Keep your API credentials secure
- Use environment variables for sensitive data
- Regularly rotate your access tokens
Error Handling
The server includes comprehensive error handling for:
- Network connectivity issues
- Invalid API credentials
- Expired access tokens
- Invalid order parameters
- Rate limiting
Development
Running in Development Mode
Adding New Tools
To add new trading tools:
- Add the method to
ZerodhaClient
class insrc/zerodha-client.js
- Add the tool handler in
src/mcp-server.js
- Update the tool definitions in the
tools/list
handler
Troubleshooting
Common Issues
- Authentication Failed: Check your API credentials and redirect URI
- Token Expired: Re-authenticate using the auth server
- Order Rejected: Verify order parameters and account balance
- Network Errors: Check internet connectivity and API endpoints
Debug Mode
Enable debug logging by setting:
License
MIT License - see LICENSE file for details.
Support
For issues and questions:
- Check the troubleshooting section
- Review Zerodha API documentation
- Open an issue on the repository
Disclaimer
This software is for educational and development purposes. Use at your own risk. Always test thoroughly in a paper trading environment before using with real money.
This server cannot be installed
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
A Model Context Protocol server that integrates with Zerodha APIs for automated trading, providing tools for authentication, market data retrieval, order placement, and portfolio management.
Related MCP Servers
- -securityAlicense-qualityA Model Context Protocol server that enables interaction with the Tradovate API for managing trading contracts, positions, orders, and accounts.Last updated -1JavaScriptMIT License
- -securityFlicense-qualityA Model Context Protocol server that enables interactions with the Hedera network, providing tools for wallet creation, balance checking, transaction building, and sending signed transactions.Last updated -1JavaScript
- -securityAlicense-qualityA Model Context Protocol server that enables price lookup and trading across multiple cryptocurrency exchanges including Upbit, Gate.io, and Binance.Last updated -6PythonMIT License
- -securityAlicense-qualityA Model Context Protocol server that enables AI models to interact with the Zerodha trading platform, allowing users to execute trades, view portfolio holdings, and manage positions through a standardized interface.Last updated -2TypeScriptMIT License