Zerodha MCP

🚀 Zerodha MCP Integration

This project integrates Zerodha's trading platform with Claude AI using the Multi-Cloud Plugin (MCP) framework, allowing you to interact with your Zerodha trading account directly through Claude.

🚀 Quick Start

📦 Installation

Install via Smithery

To automatically install zerodha-mcp for Claude Desktop via Smithery:

npx -y @smithery/cli install @aptro/zerodha-mcp --platform windows

⚙️ Setup

Create a Developer Account

1. Visit Kite Portal and register a developer account.
2. After logging in, go to the "API Accounts" section and create a new API account.
3. Record the generated API Key and Secret Key.

Generate API Credentials

1. In the root directory of the project, create two files:

   • appsettings.json
   • zerodha_credentials.json

2. Add the following content to appsettings.json:

{
  "Zerodha": {
    "KiteApiKey": "your_api_key_here",
    "KiteSecretKey": "your_secret_key_here"
  }
}

3. Add the following content to zerodha_credentials.json:

{
  ".consumer_key": "your_api_key_here",
  "consumer_secret": "your_secret_key_here",
  "access_token": null,
  "access_token_secret": null
}

💻 Usage Examples

🔑 Authentication

1. In your project, import the necessary namespaces:

using ZerodhaMCP;
using Microsoft.Extensions.Configuration;

2. Initialize the configuration and MCP instance:

var configuration = new ConfigurationBuilder()
    .SetBasePath(Directory.GetCurrentDirectory())
    .AddJsonFile("appsettings.json")
    .Build();

IMCP zerodhaMcp = new ZerodhaMCP.ZerodhaMCPClient(configuration);

3. Use the MCP tools:

// Get the request token
var requestToken = await zerodhaMcp.GetRequestTokenAsync();

// Initiate the login process
await zerodhaMcp.InitiateLogin(requestToken.token, "http://localhost:8080");

✨ Features

Available MCP Tools

Authentication

• CheckAndAuthenticate - Verify the authentication status and initiate login if necessary.
• InitiateLogin - Start the Zerodha login process.
• GetRequestToken - Get the request token.

Stock/General Trading

• PlaceOrder - Place an order.
• ModifyOrder - Modify an order.
• CancelOrder - Cancel an order.
• GetPosition - Get the position.
• GetHoldings - Get the holdings.
• GetQuotes - Get the quotes.
• GetHistoricalData - Get historical data.

Cash Management

• PlaceMFOrder - Place a mutual fund order.
• ModifyMFOrder - Modify a mutual fund order.
• CancelMFOrder - Cancel a mutual fund order.
• GetMFHoldings - Get mutual fund holdings.
• GetMFSips - Get SIPs.
• PlaceMFSip - Create a SIP.
• ModifyMFSip - Modify a SIP.
• CancelMFSip - Cancel a SIP.

🛠️ Troubleshooting

• If you encounter authentication issues, try deleting the .tokens file and restarting the login process.
• Ensure that the credentials in appsettings.json and zerodha_credentials.json are correct.
• Make sure that port 8080 is not occupied by other applications.
• For help, visit the Zerodha Developer Forum.

🔒 Security Notes

• Your Zerodha API credentials are only stored in the local appsettings.json file.
• Access tokens are stored in the .tokens file in the project directory.
• No credentials are transmitted to Claude or any third parties.
• All authentication occurs directly between you and Zerodha's servers.