groww-mcp 1.0.0

data/lib/groww_mcp/tools/smart_order_tools.rb

@@ -0,0 +1,227 @@
+# frozen_string_literal: true
+
+module GrowwMcp
+  module Tools
+    class GetSmartOrders < GrowwMcp::BaseTool
+      description "Get list of all smart orders (GTT — Good Till Triggered, and OCO — One Cancels Other). " \
+                  "Smart orders are conditional orders that trigger automatically when a price condition is met."
+
+      input_schema(
+        properties: {
+          smart_order_type: {
+            type: "string",
+            enum: %w[GTT OCO],
+            description: "Filter by smart order type (optional)",
+          },
+          page: { type: "integer", description: "Page number (optional)" },
+          page_size: { type: "integer", description: "Results per page (optional)" },
+        },
+      )
+
+      class << self
+        def call(server_context:, smart_order_type: nil, page: nil, page_size: nil)
+          client = server_context[:client]
+          result = client.smart_order_list(smart_order_type: smart_order_type, page: page, page_size: page_size)
+          format_response(result)
+        rescue GrowwMcp::ApiError => e
+          error_response(e)
+        end
+      end
+    end
+
+    class CreateSmartOrder < GrowwMcp::BaseTool
+      description "Create a GTT (Good Till Triggered) or OCO (One Cancels Other) smart order. " \
+                  "GTT triggers a buy/sell when price crosses your trigger (requires: trigger_price, " \
+                  "trigger_direction, order_type). " \
+                  "OCO sets both a stop-loss AND target on an existing position — whichever hits first " \
+                  "executes, the other cancels (requires: target_trigger_price, target_order_type, " \
+                  "stop_loss_trigger_price, stop_loss_order_type). " \
+                  "⚠️ This creates a REAL conditional order. Always confirm with the user first."
+
+      input_schema(
+        properties: {
+          smart_order_type: { type: "string", enum: %w[GTT OCO], description: "GTT or OCO" },
+          trading_symbol: { type: "string", description: "Stock/option symbol (e.g., RELIANCE)" },
+          exchange: { type: "string", enum: %w[NSE BSE], description: "Exchange (default: NSE)" },
+          segment: { type: "string", enum: %w[CASH FNO], description: "Market segment (default: CASH)" },
+          transaction_type: { type: "string", enum: %w[BUY SELL], description: "Buy or sell" },
+          quantity: { type: "integer", description: "Number of shares/lots" },
+          product_type: { type: "string", enum: %w[CNC MIS NRML], description: "CNC=delivery, MIS=intraday, NRML=F&O" },
+          duration: { type: "string", enum: %w[DAY GTC], description: "Validity: DAY or GTC (default: GTC)" },
+          # GTT fields
+          trigger_price: { type: "number", description: "GTT: price at which the order triggers" },
+          trigger_direction: { type: "string", enum: %w[UP DOWN], description: "GTT: trigger when price crosses UP or DOWN through trigger_price" },
+          order_type: { type: "string", enum: %w[MARKET LIMIT], description: "GTT: order type after trigger" },
+          price: { type: "number", description: "GTT: limit price (for LIMIT orders)" },
+          # OCO fields
+          net_position_quantity: { type: "integer", description: "OCO: current net position quantity in this symbol" },
+          target_trigger_price: { type: "number", description: "OCO: target trigger price" },
+          target_order_type: { type: "string", enum: %w[MARKET LIMIT], description: "OCO: target leg order type" },
+          target_price: { type: "number", description: "OCO: target limit price (for LIMIT)" },
+          stop_loss_trigger_price: { type: "number", description: "OCO: stop-loss trigger price" },
+          stop_loss_order_type: { type: "string", enum: %w[MARKET LIMIT], description: "OCO: stop-loss leg order type" },
+          stop_loss_price: { type: "number", description: "OCO: stop-loss limit price (for LIMIT)" },
+        },
+        required: %w[smart_order_type trading_symbol transaction_type quantity product_type],
+      )
+
+      class << self
+        def call(server_context:, smart_order_type:, trading_symbol:, transaction_type:, quantity:,
+                 product_type:, exchange: "NSE", segment: "CASH", duration: "GTC",
+                 trigger_price: nil, trigger_direction: nil, order_type: nil, price: nil,
+                 net_position_quantity: nil, target_trigger_price: nil, target_order_type: nil,
+                 target_price: nil, stop_loss_trigger_price: nil, stop_loss_order_type: nil,
+                 stop_loss_price: nil)
+          client = server_context[:client]
+
+          order = {
+            smart_order_type: smart_order_type,
+            segment: segment,
+            trading_symbol: trading_symbol,
+            quantity: quantity,
+            product_type: product_type,
+            exchange: exchange,
+            duration: duration,
+          }
+
+          if smart_order_type == "GTT"
+            missing = { trigger_price: trigger_price, trigger_direction: trigger_direction,
+                        order_type: order_type }.select { |_, v| v.nil? }.keys
+            return validation_error("GTT order missing required fields: #{missing.join(', ')}") unless missing.empty?
+
+            order[:trigger_price] = trigger_price.to_s
+            order[:trigger_direction] = trigger_direction
+            leg = { order_type: order_type, transaction_type: transaction_type }
+            leg[:price] = price if price
+            order[:order] = leg
+          else # OCO
+            missing = { target_trigger_price: target_trigger_price, target_order_type: target_order_type,
+                        stop_loss_trigger_price: stop_loss_trigger_price,
+                        stop_loss_order_type: stop_loss_order_type }.select { |_, v| v.nil? }.keys
+            return validation_error("OCO order missing required fields: #{missing.join(', ')}") unless missing.empty?
+
+            order[:transaction_type] = transaction_type
+            order[:net_position_quantity] = net_position_quantity if net_position_quantity
+
+            target = { trigger_price: target_trigger_price, order_type: target_order_type }
+            target[:price] = target_price if target_price
+            order[:target] = target
+
+            stop_loss = { trigger_price: stop_loss_trigger_price, order_type: stop_loss_order_type }
+            stop_loss[:price] = stop_loss_price if stop_loss_price
+            order[:stop_loss] = stop_loss
+          end
+
+          result = client.create_smart_order(order)
+          format_response(result)
+        rescue GrowwMcp::ApiError => e
+          error_response(e)
+        end
+
+        private
+
+        def validation_error(message)
+          MCP::Tool::Response.new([{ type: "text", text: "❌ #{message}" }])
+        end
+      end
+    end
+
+    class ModifySmartOrder < GrowwMcp::BaseTool
+      description "Modify an existing GTT or OCO smart order. " \
+                  "GTT: change quantity, duration, trigger_price, trigger_direction, or the triggered order. " \
+                  "OCO: change quantity, duration, product_type, or the target/stop-loss legs " \
+                  "(a leg must be sent complete: trigger price + order type)."
+
+      input_schema(
+        properties: {
+          order_id: { type: "string", description: "Smart order ID (e.g., gtt_91a7f4, oco_a12bc3)" },
+          smart_order_type: { type: "string", enum: %w[GTT OCO], description: "GTT or OCO" },
+          segment: { type: "string", enum: %w[CASH FNO], description: "Market segment (default: CASH)" },
+          quantity: { type: "integer", description: "New quantity (optional)" },
+          duration: { type: "string", enum: %w[DAY GTC], description: "New validity (optional)" },
+          # GTT fields
+          trigger_price: { type: "number", description: "GTT: new trigger price (optional)" },
+          trigger_direction: { type: "string", enum: %w[UP DOWN], description: "GTT: new trigger direction (optional)" },
+          order_type: { type: "string", enum: %w[MARKET LIMIT], description: "GTT: new order type for the triggered order (optional)" },
+          price: { type: "number", description: "GTT: new limit price (optional)" },
+          transaction_type: { type: "string", enum: %w[BUY SELL], description: "GTT: transaction type for the triggered order (required when changing order_type/price)" },
+          # OCO fields
+          product_type: { type: "string", enum: %w[CNC MIS NRML], description: "OCO: new product type (optional)" },
+          target_trigger_price: { type: "number", description: "OCO: new target trigger price (optional)" },
+          target_order_type: { type: "string", enum: %w[MARKET LIMIT], description: "OCO: target leg order type (required with target_trigger_price)" },
+          target_price: { type: "number", description: "OCO: new target limit price (optional)" },
+          stop_loss_trigger_price: { type: "number", description: "OCO: new stop-loss trigger price (optional)" },
+          stop_loss_order_type: { type: "string", enum: %w[MARKET LIMIT], description: "OCO: stop-loss leg order type (required with stop_loss_trigger_price)" },
+          stop_loss_price: { type: "number", description: "OCO: new stop-loss limit price (optional)" },
+        },
+        required: %w[order_id smart_order_type],
+      )
+
+      class << self
+        def call(server_context:, order_id:, smart_order_type:, segment: "CASH",
+                 quantity: nil, duration: nil, trigger_price: nil, trigger_direction: nil,
+                 order_type: nil, price: nil, transaction_type: nil, product_type: nil,
+                 target_trigger_price: nil, target_order_type: nil, target_price: nil,
+                 stop_loss_trigger_price: nil, stop_loss_order_type: nil, stop_loss_price: nil)
+          client = server_context[:client]
+
+          mods = {}
+          mods[:quantity] = quantity if quantity
+          mods[:duration] = duration if duration
+          mods[:trigger_price] = trigger_price.to_s if trigger_price
+          mods[:trigger_direction] = trigger_direction if trigger_direction
+          mods[:product_type] = product_type if product_type
+
+          if order_type || price
+            leg = {}
+            leg[:order_type] = order_type if order_type
+            leg[:price] = price if price
+            leg[:transaction_type] = transaction_type if transaction_type
+            mods[:order] = leg
+          end
+
+          if target_trigger_price
+            target = { trigger_price: target_trigger_price, order_type: target_order_type }
+            target[:price] = target_price if target_price
+            mods[:target] = target
+          end
+
+          if stop_loss_trigger_price
+            stop_loss = { trigger_price: stop_loss_trigger_price, order_type: stop_loss_order_type }
+            stop_loss[:price] = stop_loss_price if stop_loss_price
+            mods[:stop_loss] = stop_loss
+          end
+
+          result = client.modify_smart_order(order_id, smart_order_type: smart_order_type,
+                                             segment: segment, modifications: mods)
+          format_response(result)
+        rescue GrowwMcp::ApiError => e
+          error_response(e)
+        end
+      end
+    end
+
+    class CancelSmartOrder < GrowwMcp::BaseTool
+      description "Cancel a pending GTT or OCO smart order."
+
+      input_schema(
+        properties: {
+          order_id: { type: "string", description: "Smart order ID to cancel (e.g., gtt_91a7f4, oco_a12bc3)" },
+          smart_order_type: { type: "string", enum: %w[GTT OCO], description: "GTT or OCO" },
+          segment: { type: "string", enum: %w[CASH FNO], description: "Market segment (default: CASH)" },
+        },
+        required: %w[order_id smart_order_type],
+      )
+
+      class << self
+        def call(server_context:, order_id:, smart_order_type:, segment: "CASH")
+          client = server_context[:client]
+          result = client.cancel_smart_order(order_id, smart_order_type: smart_order_type, segment: segment)
+          format_response(result)
+        rescue GrowwMcp::ApiError => e
+          error_response(e)
+        end
+      end
+    end
+  end
+end

data/lib/groww_mcp/tools/user_tools.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "mcp"
+
+module GrowwMcp
+  module Tools
+    class GetProfile < GrowwMcp::BaseTool
+      description "Get your Groww trading account profile. " \
+                  "Shows UCC, enabled exchanges (NSE/BSE), DDPI status, and active segments (CASH/FNO)."
+
+      input_schema(properties: {})
+
+      class << self
+        def call(server_context:)
+          client = server_context[:client]
+          result = client.profile
+          format_response(result)
+        rescue GrowwMcp::ApiError => e
+          error_response(e)
+        end
+      end
+    end
+  end
+end

data/lib/groww_mcp/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GrowwMcp
+  VERSION = "1.0.0"
+end

data/lib/groww_mcp.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative "groww_mcp/version"
+require_relative "groww_mcp/auth"
+require_relative "groww_mcp/client"
+require_relative "groww_mcp/base_tool"
+require_relative "groww_mcp/tools/auth_tools"
+require_relative "groww_mcp/tools/portfolio_tools"
+require_relative "groww_mcp/tools/order_tools"
+require_relative "groww_mcp/tools/smart_order_tools"
+require_relative "groww_mcp/tools/market_tools"
+require_relative "groww_mcp/tools/option_chain_tools"
+require_relative "groww_mcp/tools/instrument_tools"
+require_relative "groww_mcp/tools/user_tools"
+
+module GrowwMcp
+  ALL_TOOLS = [
+    # Auth
+    Tools::Authenticate,
+    # Portfolio
+    Tools::GetHoldings,
+    Tools::GetPositions,
+    Tools::GetMargins,
+    Tools::CalculateMargin,
+    # Orders
+    Tools::GetOrders,
+    Tools::GetOrderDetail,
+    Tools::GetOrderTrades,
+    Tools::PlaceOrder,
+    Tools::ModifyOrder,
+    Tools::CancelOrder,
+    # Smart Orders (GTT/OCO)
+    Tools::GetSmartOrders,
+    Tools::CreateSmartOrder,
+    Tools::ModifySmartOrder,
+    Tools::CancelSmartOrder,
+    # Market Data
+    Tools::GetQuote,
+    Tools::GetLTP,
+    Tools::GetOHLC,
+    Tools::GetOptionChain,
+    Tools::GetGreeks,
+    Tools::GetHistoricalData,
+    # Instruments
+    Tools::SearchInstruments,
+    Tools::GetInstrumentDetail,
+    Tools::DownloadInstruments,
+    # User
+    Tools::GetProfile,
+  ].freeze
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: groww-mcp
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jai Rajput
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mcp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: rotp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.3'
+description: A Model Context Protocol (MCP) server that connects AI assistants to
+  the Groww trading platform. Supports automated TOTP authentication, portfolio management,
+  order execution, and live market data.
+email:
+- jai@tecorb.co
+executables:
+- groww-mcp
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/groww-mcp
+- lib/groww_mcp.rb
+- lib/groww_mcp/auth.rb
+- lib/groww_mcp/base_tool.rb
+- lib/groww_mcp/client.rb
+- lib/groww_mcp/tools/auth_tools.rb
+- lib/groww_mcp/tools/instrument_tools.rb
+- lib/groww_mcp/tools/market_tools.rb
+- lib/groww_mcp/tools/option_chain_tools.rb
+- lib/groww_mcp/tools/order_tools.rb
+- lib/groww_mcp/tools/portfolio_tools.rb
+- lib/groww_mcp/tools/smart_order_tools.rb
+- lib/groww_mcp/tools/user_tools.rb
+- lib/groww_mcp/version.rb
+homepage: https://github.com/developerjai/groww-mcp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/developerjai/groww-mcp
+  source_code_uri: https://github.com/developerjai/groww-mcp
+  changelog_uri: https://github.com/developerjai/groww-mcp/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: MCP server for Groww Trading API
+test_files: []