该项目是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在连接大型语言模型 (LLM) 与 Zerodha 交易平台。它将 Zerodha API 的功能封装为一系列可供 LLM 调用的工具。
项目简介
Zerodha 交易 MCP 服务器允许 LLM 访问 Zerodha 账户信息并执行交易操作。通过遵循 MCP 标准,它提供了一个结构化的方式,让 AI 应用能够安全、有效地与真实的金融市场互动。
主要功能点
- 安全认证: 与 Zerodha API 进行安全连接。
- 查看持仓: 获取用户当前的股票持有明细。
- 检查仓位: 查看用户所有开放的交易头寸。
- 下单交易: 支持买入和卖出指定股票和数量。
- 访问用户信息: 获取用户账户的基本资料。
安装步骤
- 确保您已安装 Node.js (v14 或更高版本)。
- 从 GitHub 克隆项目仓库:
git clone https://github.com/shubhamprajapati7748/zerodha-trade-mcp.git cd zerodha-trade-mcp - 安装项目依赖:
npm install - 在项目根目录创建 '.env' 文件,并填入您的 Zerodha API 凭据和 Access Token:
KITE_API_KEY=您的API Key KITE_SECRET_KEY=您的Secret Key REQUEST_TOKEN=您的Request Token (用于生成Access Token) ACCESS_TOKEN=您的Access Token (通常通过一次性登录流程获取并在此配置)
服务器配置 (供 MCP 客户端使用)
该 MCP 服务器是为 MCP 客户端(如支持 MCP 的 LLM 应用)设计的。客户端需要配置如何启动并连接到此服务器。典型的配置信息通常以 JSON 格式提供,包含以下关键项:
- 'command': 用于启动 MCP 服务器进程的可执行命令路径。这通常是 Node.js 或 Bun 的路径。
- 'args': 传递给启动命令的参数列表。这通常包含服务器主入口文件(例如 'index.js' 或 'index.ts' 编译后的文件)的路径。
- 'env': 启动服务器进程时需要设置的环境变量,例如您的 Zerodha API 凭据。
具体的配置方式取决于您使用的 MCP 客户端。您需要根据您的系统环境替换命令路径和文件路径。
基本使用方法
一旦 MCP 服务器通过客户端配置并成功启动连接,LLM 客户端就可以通过调用服务器暴露的工具来执行操作。服务器提供了以下主要工具(供 LLM 通过 MCP 协议调用):
- 'get-profile': 获取 Zerodha 账户的用户资料。
- 'buy-stock': 下达买入指定股票和数量的订单。
- 'sell-stock': 下达卖出指定股票和数量的订单。
- 'show-portfolio': 显示用户的完整股票持仓详情。
- 'show-positions': 显示用户当前的开放交易仓位。
LLM 将根据用户指令,通过 MCP 协议向服务器发送相应的工具调用请求,服务器执行操作后返回结果。
信息
分类
商业系统