zerodha-mcp

🚀 Zerodha MCP 集成

此项目借助多云插件（MCP）框架，将 Zerodha 的交易平台与 Claude AI 进行集成。通过该集成，用户能够直接通过 Claude 与自己的 Zerodha 交易账户进行交互。

🚀 快速开始

📦 安装指南

使用 Smithery 安装

要通过 Smithery 自动为 Claude Desktop 安装 zerodha-mcp，可使用以下命令：

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

⚙️ 设置说明

创建开发者账户

1. 访问 Kite Portal 并注册一个开发者账户。
2. 登录后转到“API 账户”部分，创建一个新的 API 账户。
3. 记录生成的 API Key 和 Secret Key。

生成 API 凭证

1. 在项目的根目录中，创建两个文件：

   • appsettings.json
   • zerodha_credentials.json

2. 将以下内容添加到 appsettings.json：

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

3. 将以下内容添加到 zerodha_credentials.json：

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

💻 使用示例

基础用法

认证

1. 在您的项目中，导入必要的命名空间：

using ZerodhaMCP;
using Microsoft.Extensions.Configuration;

2. 初始化配置和 MCP 实例：

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

IMCP zerodhaMcp = new ZerodhaMCP.ZerodhaMCPClient(configuration);

3. 使用 MCP 工具：

// 获取请求令牌
var requestToken = await zerodhaMcp.GetRequestTokenAsync();

// 初始化登录流程
await zerodhaMcp.InitiateLogin(requestToken.token, "http://localhost:8080");

✨ 主要特性

可用的 MCP 工具

认证

• CheckAndAuthenticate - 验证认证状态并按需发起登录
• InitiateLogin - 启动 Zerodha 登录流程
• GetRequestToken - 获取请求令牌

股票/通用交易

• PlaceOrder - 下单
• ModifyOrder - 修改订单
• CancelOrder - 撤销订单
• GetPosition - 获取头寸
• GetHoldings - 获取持仓
• GetQuotes - 获取报价
• GetHistoricalData - 获取历史数据

现金管理

• PlaceMFOrder - 下基金单
• ModifyMFOrder - 修改基金订单
• CancelMFOrder - 撤销基金订单
• GetMFHoldings - 获取基金持仓
• GetMFSips - 获取 SIP
• PlaceMFSip - 创建 SIP
• ModifyMFSip - 修改 SIP
• CancelMFSip - 取消 SIP

🛠️ 故障排除

• 如果出现认证问题，请尝试删除 .tokens 文件并重新启动登录流程。
• 确保 appsettings.json 和 zerodha_credentials.json 中的凭证正确无误。
• 确保端口 8080 未被其他应用程序占用。
• 如需帮助，请访问 Zerodha 开发者论坛。

🔒 安全注意事项

• 您的 Zerodha API 凭证仅存储在本地 appsettings.json 文件中。
• 访问令牌存储在项目目录中的 .tokens 文件中。
• 无凭证会传输到 Claude 或任何第三方。
• 所有认证直接发生在您和 Zerodha 的服务器之间。