🚀 Upstox API MCP 服务器

这是一个用于与 Upstox 交易 API 集成的 MCP 服务器，能帮助用户便捷地与 Upstox API 进行交互，实现各类交易相关操作。

🚀 快速开始

🛠️ 设置

1. 克隆仓库：

git clone https://github.com/yourusername/mcp-server-upstox-api.git
cd mcp-server-upstox-api

2. 安装依赖项：

npm install

🚀 运行服务器

启动 MCP 服务器：

npm run start

你的 MCP 服务器将在 http://localhost:8787 上运行。

✨ 主要特性

本 MCP 服务器支持与 Claude Desktop 和 Cursor 集成，允许用户通过自然语言提示与 Upstox API 交互，涵盖资料信息、资金与保证金、持股情况等多方面的查询。

📦 安装指南

🛠️ 设置

1. 克隆仓库：

git clone https://github.com/yourusername/mcp-server-upstox-api.git
cd mcp-server-upstox-api

2. 安装依赖项：

npm install

🚀 运行服务器

启动 MCP 服务器：

npm run start

你的 MCP 服务器将在 http://localhost:8787 上运行。

💻 使用示例

🤝 MCP 配置

Claude Desktop 配置

要将此 MCP 服务器与 Claude Desktop 配合使用，请在 Claude Desktop 设置中添加以下配置：

{
  "mcpServers": {
    "mcp-server-upstox-api": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "http://localhost:8787/sse"
      ]
    }
  }
}

Cursor MCP 配置

要将此 MCP 服务器与 Cursor 配合使用，请在 Cursor 的 MCP 设置中添加以下配置（通常位于 ~/.cursor/mcp.json）：

{
  "mcpServers": {
    "mcp-server-upstox-api": {
      "url": "http://localhost:8787/sse"
    }
  }
}

这些配置允许 Claude Desktop 和 Cursor 连接到你的本地 MCP 服务器并使用 Upstox API 端点。

🗣️ 使用 Claude 和 Cursor

你可以通过自然语言提示与 Upstox API 交互。以下是一些每个命令的示例提示：

资料信息

• "我的 Upstox 资料信息是什么？"
• "显示我当前的活动段和产品"
• "我的用户 ID 和电子邮件是什么？"

资金与保证金

• "我的可用保证金是多少？"
• "显示我的股权段资金和保证金细节"
• "我的大宗商品段保证金可用性是多少？"

持股情况

• "我目前持有哪些股票？"
• "显示我的长期持股及其当前价值"
• "我持有的总持仓价值是多少？"

操作单

• "我有哪些当前的未平仓操作单？"
• "显示我日内操作单及其损益（P&L）"
• "我未平仓操作单的总未实现损益是多少？"

MTF 操作单

• "我的 Margin Trade Funding 操作单是什么？"
• "显示我的 MTF 操作单及其当前价值"
• "我的账户总 MTF 暴露是多少？"

订单簿

• "显示我今天在 Upstox 的订单"
• "我的待处理订单有哪些？"
• "显示我今天的订单历史"
• "我的订单状态是什么？"
• "列出我今天完成的订单"

订单详情

• "显示订单 ID xxxxxxxxxxxxxxx 的详细信息"
• "订单 ID xxxxxxxxxxxxxxx 的状态是什么？"
• "获取订单 xxxxxxxxxxxxxxx 的完整信息"
• "检查订单 xxxxxxxxxxxxxxx 的执行状态"
• "查看最近订单 xxxxxxxxxxxxxxx 的细节"

订单历史

• "显示订单 ID xxxxxxxxxxxxxxx 的历史"
• "获取订单 xxxxxxxxxxxxxxx 所有状态更新"
• "订单 xxxxxxxxxxxxxxx 的进展是什么？"
• "显示订单 xxxxxxxxxxxxxxx 的所有阶段"
• "获取带有标签 xxxxxxxxxxxxxxx 的订单历史"

交易操作单

• "显示订单 ID xxxxxxxxxxxxxxx 对应的交易"
• "订单 ID xxxxxxxxxxxxxxx 执行了哪些交易？"
• "获取订单 xxxxxxxxxxxxxxx 的交易细节"
• "列出与订单 xxxxxxxxxxxxxxx 相关联的所有交易"
• "显示订单 xxxxxxxxxxxxxxx 的执行细节"

交易

• "显示我今天的交易"
• "今天有哪些交易被执行了？"
• "获取我的每日交易历史"
• "列出我完成的当日交易"
• "显示我的交易细节及其成交价格"

📚 详细文档

🛣️ 可用端点

📝 请求示例

提交一个买单

{
  "type": "submit_order",
  "order": {
    "exchange": "SSE",
    "symbol": "600028",
    "side": "buy",
    "order_type": "limit",
    "price": 10.5,
    "quantity": 100
  }
}

查询订单状态

{
  "type": "get_order_status",
  "order_id": "123456"
}

📤 返回格式

所有 API 请求返回统一的 JSON 格式：

{
  "success": boolean, // 是否成功
  "data": any,       // 数据部分
  "error": {
    "code": string,
    "message": string
  } // 错误信息（仅在失败时返回）
}

⚠️ 错误处理

常见的错误代码和消息：

• invalid_params：无效的参数
• order_not_found：订单未找到
• insufficient_balance：余额不足
• symbol_not_found：品种不存在
• invalid_order_type：无效委托类型
• network_error：网络错误

请确保在处理 API 请求时，检查返回的状态码和错误信息，并相应地处理异常情况。