Skip to main content

ws-claro-gerencial-mcp

PyPI version License: MIT Python versions

Servidor MCP (Model Context Protocol) para integração com os WebServices SOAP do Claro Gerencial (plataforma da Claro gerenciada pela Redeinova Tecnologia).

Este servidor permite que agentes de IA (como o opencode, Claude Code, etc.) interajam diretamente com o Claro Gerencial, realizando consultas e envios de dados de forma autônoma.

Funcionalidades

O servidor expõe 6 ferramentas via MCP:

  • listar_entidades — Lista todas as entidades disponíveis e suas direções (input/output)
  • obter_registros — Consulta registros de qualquer entidade (completa ou incremental)
  • gerar_arquivo — Solicita geração de arquivo FTP a partir de um ticket de consulta
  • enviar_registros — Envia XML para importação de registros
  • obter_status — Consulta status de processamento de um envio
  • obter_schema_xml — Obtém schema XSD para validação antes do envio

Entidades disponíveis

  • Cidades, Bairros, Clientes (PDVs), ClientesVisitas, Empresas, Gerentes, Supervisores
  • Vendedores, Setores, Grupos de Produtos, MotivosVisitas, Produtos, Segmentos
  • TiposClientes, TiposSinalizações, ClientesSinalizações, Visitas
  • Integradores, Pedidos, ChipsVendedor, MotivosICCIDS, ICCID, RedesPDV
  • VendasBandaLarga, ReleiturasICCID

Instalação

pip install ws-claro-gerencial-mcp

Ou, sem instalar nada (executa direto do PyPI com cache):

uvx --from ws-claro-gerencial-mcp ws-claro-gerencial-mcp

Ou para desenvolvimento:

git clone https://github.com/hlgurgel/ws-claro-gerencial-mcp.git
cd ws-claro-gerencial-mcp
pip install -e .

Configuração

Crie um arquivo .env na raiz do projeto ou defina as variáveis de ambiente:

CLARO_USUARIO=seu_usuario
CLARO_SENHA=sua_senha
CLARO_AMBIENTE=homologacao

Variáveis de ambiente

Variável Obrigatória Padrão Descrição
CLARO_USUARIO Sim Usuário de acesso ao webservice
CLARO_SENHA Sim Senha de acesso ao webservice
CLARO_AMBIENTE Não homologacao Ambiente: homologacao ou producao
CLARO_URL_BASE_OUTPUT Não https://clarogerencial.redeinova.com.br/wsoutput URL base do WS de Output
CLARO_URL_BASE_INPUT Não https://clarogerencial.redeinova.com.br/wsinput URL base do WS de Input

Uso com clientes MCP

Claude Desktop

Adicione ao claude_desktop_config.json:

{
  "mcpServers": {
    "claro-gerencial": {
      "command": "uvx",
      "args": ["--from", "ws-claro-gerencial-mcp", "ws-claro-gerencial-mcp"],
      "env": {
        "CLARO_USUARIO": "seu_usuario",
        "CLARO_SENHA": "sua_senha",
        "CLARO_AMBIENTE": "homologacao"
      }
    }
  }
}

OpenCode

Adicione ao opencode.json do seu projeto:

{
  "mcp": {
    "claro-gerencial": {
      "type": "local",
      "command": ["ws-claro-gerencial-mcp"],
      "environment": {
        "CLARO_USUARIO": "seu_usuario",
        "CLARO_SENHA": "sua_senha",
        "CLARO_AMBIENTE": "homologacao"
      }
    }
  }
}

Exemplos de uso

> Liste as entidades disponíveis no Claro Gerencial.

> Consulte os clientes ativos (entidade: 'clientes') de forma completa.

> Envie um novo cliente:
<Clientes>
  <Cliente>
    <Empresa>1</Empresa>
    <Sequencial>999</Sequencial>
    <Nome>NOVO PDV</Nome>
    <DbAcao>I</DbAcao>
  </Cliente>
</Clientes>

Requisitos de segurança

  • IP fixo: O distribuidor precisa ter um IP fixo cadastrado na Redeinova.
  • SSL: Toda comunicação usa HTTPS com TLS.
  • Autenticação: Usuário e senha fornecidos pela Redeinova, senhas fortes com mínimo de 8 caracteres.

Autorização por IP (output/baixa)

Para consultas/baixas (output) — e também envios (input) — o WebService exige que o IP de origem da máquina esteja autorizado na tabela RepositorioControleIntClaro.dbo.DistribuidorIP (coluna Ip), associado ao usuário do distribuidor (ex.: CLAROREDEFLEXWS) com Ativo = 1. Sem isso, o WS responde Usuário não autorizado para efetuar baixa.

Dicas para validação:

  • Em VPN (ex.: redeinova-dc), o IP de origem é o da interface de túnel (utun*). Descobrir com: ifconfig | grep "inet ".
  • O domínio do WS (clarogerencial.redeinova.com.br) resolve para IP interno (10.177.51.41), então o tráfego sai pela VPN. O IP a cadastrar é o da interface VPN — não o IP público retornado por curl ifconfig.me.
  • Para liberar/ajustar: INSERT/UPDATE em RepositorioControleIntClaro.dbo.DistribuidorIP.

Ambiente de homologação

Para solicitar ambiente de homologação, entre em contato com:

Licença

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ws_claro_gerencial_mcp-0.1.0.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ws_claro_gerencial_mcp-0.1.0-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file ws_claro_gerencial_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: ws_claro_gerencial_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.12.0

File hashes

Hashes for ws_claro_gerencial_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d669a0da4018d862c73ab57cd9be6115a5d2afa064e8527f19f588b52c1686e8
MD5 1a03076f02edb74b9442e8a35b29fb24
BLAKE2b-256 5020c096374d57a00b79590640c6f644237d838cc91def2ac2b872d016162cc4

See more details on using hashes here.

File details

Details for the file ws_claro_gerencial_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ws_claro_gerencial_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 33a90e44449c1d9550eda93096f98f1d7bcd737a21cd1c80a6677f2e9e76859e
MD5 6be13a578d1742b0ecda51c681690672
BLAKE2b-256 1cf772af9a9fa8ca24e64366bf27e9917e698eb891568fd98909f726c7377348

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page