NSE Ticker MCP Server

Fornece acesso aos dados da National Stock Exchange (NSE) usando a API Upstox.

Documentação

Servidor MCP de Ticker NSE

Um servidor Model Context Protocol (MCP) que fornece acesso a dados da National Stock Exchange (NSE) por meio da API Upstox.

Ferramentas

O servidor expõe as seguintes ferramentas por meio do Model Context Protocol:

Dados Históricos

FerramentaDescrição
get_historical_candleObter dados históricos OHLCV (Abertura, Máxima, Mínima, Fechamento, Volume) para ações da NSE

Recursos

  • Acesso a dados de ações da NSE em tempo real
  • Suporte a múltiplos intervalos de tempo (minuto, 30minutos, dia, semana, mês)
  • Tratamento de erros e validação de dados
  • Dados históricos de preços com intervalos de datas personalizáveis

Requisitos

  • Python 3.11 ou superior
  • Dependências (especificadas em pyproject.toml):
    • mcp
    • pandas
    • httpx
    • pydantic

Configuração

  1. Clone este repositório:
git clone https://github.com/sougatabh/nse-ticker-mcp.git
cd nse-ticker-mcp
  1. Crie e ative um ambiente virtual:
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
  1. Instale as dependências:
pip install -e .

Uso

Modo de Desenvolvimento

Teste o servidor com o MCP Inspector:

python ticker.py

Integração com Claude para Desktop

  1. Instale o Claude para Desktop

  2. Edite o arquivo de configuração do Claude:

MacOS:

code ~/Library/Application\ Support/Claude/claude_desktop_config.json

Adicione a seguinte configuração:

{
  "mcpServers": {
    "nse-ticker": {
      "command": "python",
      "args": [
        "--directory",
        "/ABSOLUTE/PATH/TO/nse-ticker-mcp",
        "ticker.py"
      ]
    }
  }
}

Exemplo de Uso

# Get historical data for HDFC Bank
response = await get_historical_candle(
    symbol="HDFCBANK",
    from_date="2024-01-01",
    to_date="2024-03-31",
    interval="day"
)

Intervalos Disponíveis

  • minute - Velas de 1 minuto
  • 30minute - Velas de 30 minutos
  • day - Velas diárias
  • week - Velas semanais
  • month - Velas mensais

Tratamento de Erros

O servidor fornece mensagens de erro detalhadas para:

  • Símbolos inválidos
  • Problemas de conexão
  • Erros de API
  • Falhas de validação de dados
  • Problemas de formato de data

Configuração

Símbolos de ações e chaves de instrumentos são configurados em:

  • configs/NSE.csv

Licença

Licença MIT

Contribuição

  1. Faça um fork do repositório
  2. Crie sua branch de recurso
  3. Envie um pull request