使用说明
项目简介
Zerodha MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,它允许您将您的 Zerodha 投资账户连接到支持 MCP 协议的 LLM 客户端,例如 Claude。通过此服务器,您可以利用 LLM 的能力,以自然语言的方式查询和分析您的投资数据,例如股票持仓、市场行情、账户信息等。
主要功能点
- 投资组合数据访问: 提供工具以获取股票、共同基金的持仓信息。
- 市场数据查询: 支持查询股票的实时行情 (LTP)、报价 (Quote)、开盘价-最高价-最低价-收盘价 (OHLC) 等市场数据。
- 订单和保证金信息: 可以查询订单保证金信息,以及共同基金订单和 SIP 信息。
- 用户账户信息: 提供获取用户基本信息和完整信息的工具。
- 灵活的工具集成: 通过标准化的 MCP 协议,方便 LLM 客户端调用各种投资数据查询工具。
安装步骤
- 安装 Go 环境: 确保您的计算机上已安装 Go 语言环境。您可以从 Go 官网 下载并安装。
- 获取源代码: 从 GitHub 仓库 zerodha-mcp-go 克隆或下载源代码。
- 安装 Zerodha MCP Server: 在源代码根目录下,打开终端并执行命令 'go install'。 这将在您的 Go 可执行文件路径下生成 'zerodha-mcp' 可执行文件。 请记录下此可执行文件的完整路径。
- 获取 Zerodha API 密钥: 访问 Kite Connect 开发者平台 (Zerodha 官方开发者平台) 并创建一个应用。您将获得 'ZERODHA_API_KEY' (API 密钥) 和 'ZERODHA_API_SECRET' (API 密钥Secret)。 这是免费的。
- 设置重定向 URL: 在 Kite Connect 开发者平台应用设置中,将重定向 URL 设置为 'http://127.0.0.1:8080/auth'。
服务器配置
要将 Zerodha MCP Server 与 MCP 客户端(例如 Claude 桌面应用)连接,您需要配置客户端的 MCP 服务器设置。 以 Claude 桌面应用为例,您需要编辑其配置文件 'claude_desktop_config.json'。
在 Claude 桌面应用中,打开设置 -> 开发者 -> 编辑配置,将以下 JSON 配置添加到 'mcpServers' 字段中。
{ "mcpServers": { "zerodha": { "command": "<zerodha-mcp 可执行文件的完整路径>", "env": { "ZERODHA_API_KEY": "<您在 Zerodha 开发者平台获取的 API 密钥>", "ZERODHA_API_SECRET": "<您在 Zerodha 开发者平台获取的 API 密钥Secret>" } } } }
- 'server name': 'zerodha' (服务器名称,可以自定义,用于在客户端中引用)
- 'command': '<zerodha-mcp 可执行文件的完整路径>' (Zerodha MCP Server 可执行文件的绝对路径,例如 '/Users/yourname/go/bin/zerodha-mcp' 或 'C:\Users\YourName\go\bin\zerodha-mcp.exe')
- 'env': 环境变量配置
- 'ZERODHA_API_KEY': '<您在 Zerodha 开发者平台获取的 API 密钥>' (您的 Zerodha API 密钥)
- 'ZERODHA_API_SECRET': '<您在 Zerodha 开发者平台获取的 API 密钥Secret>' (您的 Zerodha API 密钥 Secret)
基本使用方法
- 重启 Claude 桌面应用: 配置完成后,重启 Claude 桌面应用。
- Zerodha 账户认证: Claude 启动后,会提示您进行 Zerodha 账户认证。按照提示在浏览器中登录您的 Zerodha Kite 账户并完成授权。
- 与 Claude 交互: 认证成功后,您就可以在 Claude 中使用 Zerodha MCP Server 提供的工具了。 您可以指示 Claude 使用特定的工具来查询您的投资数据。 例如,您可以提问:
- "我的股票持仓有哪些?" (Claude 可能会调用 'fetch_holdings' 工具)
- "获取 Reliance Industries 的实时价格。" (Claude 可能会调用 'get_ltp' 工具,并需要您提供 instrument 参数,例如 "nse:RELIANCE")
- "我的账户保证金是多少?" (Claude 可能会调用 'get_user_margins' 工具)
请参考仓库代码中的工具定义和描述,以便更好地了解每个工具的功能和使用方法。
信息
分类
商业系统