JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 28
  • Score
    100M100P100Q70369F
  • License ISC

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (groww-mcp) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Groww MCP Server

    This project provides an MCP (Multi-Channel Platform) server for interacting with the Groww trading API. It allows you to fetch portfolio data, get live quotes, place/cancel/modify orders, and more, all via a unified API interface.

    Features

    • Fetch your current portfolio
    • Get live stock quotes and OHLC data
    • Place, modify, and cancel stock orders
    • Fully typed and validated with Zod schemas
    • Docker support for easy deployment

    Available Tools

    • get-portfolio: Get the current portfolio of the user
    • get-live-quote: Get live quote data for a specific stock
    • get-last-traded-price: Get the last traded price for one or more stocks
    • get-ohlc: Get OHLC (Open, High, Low, Close) data for stocks
    • place-order: Place a new stock order (buy/sell)
    • modify-order: Modify an existing stock order
    • cancel-order: Cancel an existing stock order
    • get-order-status: Get the status of an order

    Requirements

    • Node.js v18 or later (or Docker)
    • A valid Groww API key

    Setup (Local)

    1. Clone the repository:
      git clone https://github.com/venkatakaushikvemani/groww-mcp
      cd groww-mcp
    2. Install dependencies:
      npm install
      # or
      pnpm install
    3. Set environment variables: Create a .env file in the root directory and add:
      GROWW_API_KEY=your_groww_api_key_here
      PORT=3000 # or your preferred port
    4. Start the server:
      npm start
      # or
      pnpm start

    Setup (Docker)

    1. Build the Docker image:
      docker build -t mcp-server .
    2. Run the container:
      docker run -p 3000:3000 -e GROWW_API_KEY=your_groww_api_key_here mcp-server
      Adjust the port and environment variables as needed.

    Environment Variables

    • GROWW_API_KEY: Your Groww API key (required)
    • PORT: Port for the server to listen on (default: 3000)

    Sample mcp.json

    For local development with Cursor MCP, add a .cursor/mcp.json file in your project root:

    {
      "mcpServers": {
        "groww-mcp": {
          "command": "pnpm",
          "args": ["--dir", "/path/to/your/groww-mcp", "start"],
          "env": {
            "GROWW_API_KEY": "your_groww_api_key_here"
          }
        }
      }
    }

    Replace /path/to/your/groww-mcp and your_groww_api_key_here with your actual project path and API key.

    Usage

    • The server exposes endpoints/tools for portfolio, quotes, and order management.
    • See the code in src/groww/tools.ts for available tools and their parameters.

    Sample Prompts

    Here are some example prompts you can use to interact with the tools:

    • Get your portfolio:

      Fetch my portfolio

    • Get a live quote:

      Get the live quote for TATAMOTORS

    • Get last traded price:

      What is the last traded price of BPL and HFCL?

    • Get OHLC data:

      Show me the OHLC data for TATAMOTORS

    • Place a buy order:

      Buy 10 shares of SADHNANIQ

    • Place a sell order:

      Sell 5 shares of TATAMOTORS

    • Modify an order:

      Modify my order for BPL to 20 shares

    • Cancel an order:

      Cancel my latest order for BPL

    • Get order status:

      What is the status of my last order?

    Contributing

    Pull requests and issues are welcome! Please open an issue to discuss your ideas or report bugs.

    License

    MIT