AverbePorto-MCP
🌟 Sobre
O AverbePorto-MCP é um servidor MCP (Model Context Protocol) que permite a integração com a plataforma AverbePorto, facilitando o acesso aos serviços de autenticação e envio de documentos através de ferramentas de IA (Inteligência Artificial).
🌐 Acessando o Sistema Web
- Acesse https://www.averbeporto.com.br
- Faça login com suas credenciais de usuário
- Na plataforma, você poderá:
- Gerar Credenciais de API em Cadastro do Usuário
- Realizar envio de documentos XML
- Consultar protocolos ANTT
- Acompanhar e gerenciar suas averbações de seguros de carga
🤖 Utilizando o MCP Server com Ferramentas de IA
Instalação pelo Smithery
Para instalar averbeporto-mcp para Claude Desktop automaticamente via Smithery:
npx -y @smithery/cli install @GHSix/averbeporto-mcp --client claude
Claude Desktop
- Edite o arquivo
%APPDATA%\Claude\claude_desktop_config.json(Windows) ou~/Library/Application Support/Claude/claude_desktop_config.json(MacOS) e adicione a seguinte configuração:{ "mcpServers": { "AverbePorto-MCP": { "command": "node", "args": ["/caminho/para/AverbePorto-MCP/build/index.js"] } } } - Ao iniciar a conversa, o servidor MCP será automaticamente iniciado com base na configuração.
Cursor, Roo Code e outros
- Crie um arquivo como
.cursor/mcp.jsonou.roo/mcp.jsonem seu projeto com a seguinte configuração:{ "mcpServers": { "AverbePorto-MCP": { "command": "node", "args": ["/caminho/para/AverbePorto-MCP/build/index.js"], "disabled": false, "alwaysAllow": [ "login", "consultProtocol", "upload", "retrieveDocument", "decomposeKey" ] } } } - Ao iniciar a conversa, o servidor MCP será automaticamente iniciado com base na configuração.
Github Copilot
- Com o Github Copilot ativo em seu editor, crie o arquivo
.vscode/mcp.json:{ "inputs": [ { "type": "promptString", "id": "averbeporto-user", "description": "AverbePorto API Username" }, { "type": "promptString", "id": "averbeporto-pass", "description": "AverbePorto API Password", "password": true } ], "servers": { "AverbePorto-MCP": { "command": "node", "args": ["/caminho/para/AverbePorto-MCP/build/index.js"], "env": { "AVERBEPORTO_USER": "${input:averbeporto-user}", "AVERBEPORTO_PASS": "${input:averbeporto-pass}" } } } } - O VS Code solicitará suas credenciais na primeira execução e as armazenará de forma segura.
- O Copilot reconhecerá os comandos MCP e oferecerá sugestões contextualizadas para:
- Autenticação na API
- Upload de documentos XML
- Consulta de protocolos ANTT
- As credenciais serão automaticamente injetadas nas chamadas da API.
📚 Ferramentas Disponíveis para a IA
O AverbePorto-MCP oferece as seguintes ferramentas:
-
login: Autenticação na plataforma- Parâmetros:
user,pass - Retorna:
sessionId
- Parâmetros:
-
upload: Envio de documentos- Parâmetros:
sessionId,filePath,recipient(opcional),version(opcional) - Retorna:
uploadId
- Parâmetros:
-
consultProtocol: Consulta de protocolos por chave ou vice-versa- Parâmetros:
sessionId,keys,protocols,outputFormat,download,delimiter - Formatos de saída: json, xml, csv
- Parâmetros:
-
retrieveDocument: Consulta de documentos enviados- Parâmetros:
sessionId: ID da sessão obtido no login.modDoc: Tipo de documento (e.g., DI, MDF-e, CT-e, NF-e, Minuta CT-e).dtStartedtLimit: Datas de início e fim no formatoYYYY-MM-DD.dtType: Tipo de data (Update, Emission, Send), padrão éSend.- Filtros opcionais:
numDoc,emit,rem,exped,receb,dest,toma,importador,representante,prot,taxId. - Paginação:
page,start,limit. - Outros:
relation,modal,valid.
- Parâmetros:
-
decomposeKey: Decomposição de chaves para análise- Parâmetros:
key: Chave de acesso de 44 dígitos para NF-e, CT-e ou MDF-e.
- Parâmetros:
🔒 Segurança
- Utilize as credenciais de API geradas no módulo Cadastro do Usuário
- Mantenha suas credenciais em segurança
- Não compartilhe seu
sessionId - Utilize sempre conexões seguras
- Mantenha o servidor MCP atualizado