MCP Server Upstox Api

🚀 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 請求時，檢查返回的狀態碼和錯誤信息，並相應地處理異常情況。