Claro Gerencial

Servidor MCP para integração com os WebServices SOAP do Claro Gerencial (Redeinova)

OtherPythonv0.1.0

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ávelObrigatóriaPadrãoDescrição
CLARO_USUARIOSim—Usuário de acesso ao webservice
CLARO_SENHASim—Senha de acesso ao webservice
CLARO_AMBIENTENãohomologacaoAmbiente: homologacao ou producao
CLARO_URL_BASE_OUTPUTNãohttps://clarogerencial.redeinova.com.br/wsoutputURL base do WS de Output
CLARO_URL_BASE_INPUTNãohttps://clarogerencial.redeinova.com.br/wsinputURL 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

Installation

Source-derived launch command. Check the maintainer’s required arguments and credentials before running:

bash
uvx ws-claro-gerencial-mcp

Set up in your AI client

Merge this template into ~/Library/Application Support/Claude/claude_desktop_config.json. Keep existing servers. Add any arguments, credentials, and permissions required by the maintainer; this template has not been install-tested.

json
{
  "mcpServers": {
    "io-github-hlgurgel-ws-claro-gerencial": {
      "command": "uvx",
      "args": [
        "ws-claro-gerencial-mcp"
      ]
    }
  }
}

Restart Claude Desktop completely for changes to take effect. Confirm the server appears connected in the client’s tool list, then try a read-only example from its documentation.

Claude Desktop setup reference

Package

ws-claro-gerencial-mcppypi

Compatible MCP Clients

Claro Gerencial works with any MCP-compatible client. Copy the config snippet from the Configuration section above and add it to the file shown for your client, then restart the application.

  • Claude Desktop~/Library/Application Support/Claude/claude_desktop_config.jsonRestart Claude Desktop completely for changes to take effect.
  • Cursor~/.cursor/mcp.jsonRestart Cursor for changes to take effect.
  • VS Code.vscode/mcp.jsonReload VS Code window for changes to take effect.
  • Windsurf~/.codeium/windsurf/mcp_config.jsonRestart Windsurf for changes to take effect.
  • Claude Code.mcp.jsonSave at the project root, then start Claude Code in that project and review the MCP server approval prompt. Keep real credentials out of shared files.

Learn More