AverbePorto-MCP

SSE

by GHSix

132 downloads Not rated yet MIT license
GitHub Website

About

Integrates with the AverbePorto platform for authentication and document submission using AI tools.

Details

Transport
SSE
License
MIT license

Explore

1. 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}"

         }

       }

     }

   }

2. O VS Code solicitará suas credenciais na primeira execução e as armazenará de forma segura.
3. O Copilot reconhecerá os comandos MCP e oferecerá sugestões contextualizadas para:
- Autenticação na API
- Upload de documentos XML
- Consulta de protocolos ANTT
4. As credenciais serão automaticamente injetadas nas chamadas da API.

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name AverbePorto-MCP
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install via Smithery using npx -y @smithery/cli install @GHSix/averbeporto-mcp --client claude, or configure manually by adding the server to your MCP client's configuration file (Claude Desktop, Cursor, Roo Code, or GitHub Copilot) with the path to the build/index.js script and your AverbePorto API credentials.

login

Authenticates a user with the AverbePorto API using their username and password. Establishes a session and returns a unique `sessionId` required for subsequent API calls.

upload

Uploads a specified file to the AverbePorto API for processing. Requires an active `sessionId` obtained from the `login` tool. Returns the processing status, including counts of processed/duplicated/rejected/denied items, generated protocol numbers, and any errors encountered.

consultProtocol

Consults the AverbePorto API to retrieve details associated with one or more document access keys (44 digits) or protocol numbers (40 digits). Requires an active `sessionId`.

decomposeKey

Parses a 44-digit (infCte/Id) Brazilian electronic fiscal document access key (like NF-e, CT-e, MDF-e) into its individual components. Provides details such as state code, emission date, emitter CNPJ, document model, series, number, and emission type. This operation is performed locally without calling an external API.

retrieveDocument

Retrieves a list of electronic fiscal documents (NF-e, CT-e, MDF-e, Minuta CT-e) from the AverbePorto API based on specified filter criteria. Filters include document type, date range, date type (emission, update, send), document number (9 char max), involved parties (CNPJs), status, and more. Supports pagination. Requires an active `sessionId`.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "averbeporto-mcp": {
            "AverbePorto-MCP": {
                "command": "npx",
                "args": [
                    "-y",
                    "@smithery/cli",
                    "install",
                    "@GHSix/averbeporto-mcp",
                    "--client",
                    "claude"
                ]
            }
        }
    }
}

McpServers

{
    "AverbePorto-MCP": {
        "command": "npx",
        "args": [
            "-y",
            "@smithery/cli",
            "install",
            "@GHSix/averbeporto-mcp",
            "--client",
            "claude"
        ]
    }
}

smithery badge

🌟 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

1. Acesse https://www.averbeporto.com.br
2. Faça login com suas credenciais de usuário
3. 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

1. 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"]
        }
      }
    }
2. Ao iniciar a conversa, o servidor MCP será automaticamente iniciado com base na configuração.

Cursor, Roo Code e outros

1. Crie um arquivo como .cursor/mcp.json ou .roo/mcp.json em 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"
          ]
        }
      }
    }
2. Ao iniciar a conversa, o servidor MCP será automaticamente iniciado com base na configuração.

Github Copilot

1. 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}"
         }
       }
     }
   }
2. O VS Code solicitará suas credenciais na primeira execução e as armazenará de forma segura. 3. O Copilot reconhecerá os comandos MCP e oferecerá sugestões contextualizadas para: - Autenticação na API - Upload de documentos XML - Consulta de protocolos ANTT 4. 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

- upload: Envio de documentos
- Parâmetros: sessionId, filePath, recipient (opcional), version (opcional)
- Retorna: uploadId

- consultProtocol: Consulta de protocolos por chave ou vice-versa
- Parâmetros: sessionId, keys, protocols, outputFormat, download, delimiter
- Formatos de saída: json, xml, csv

- 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).
- dtStart e dtLimit: Datas de início e fim no formato YYYY-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.

- 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.

🔒 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
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

More like this

Similar MCP servers you might find useful

Browse category

Sequential Thinking

Sequential Thinking is an MCP server that provides a tool for dynamic and reflective problem-solving through a structured, step-by-step thinking process. It is…

— 88.2k 508.3k dl
Other

Aws Kb Retrieval Server

AWS Knowledge Base Retrieval MCP Server connects compatible AI clients with Amazon Bedrock Knowledge Bases, allowing models and agents to retrieve grounded…

— 88.2k 5.5k dl
Cloud Service

Filesystem

Filesystem is a Node.js server that implements the Model Context Protocol (MCP) for filesystem operations. It enables AI assistants to read, write, and manage…

— 88.1k 6.7k dl
Other

EverArt

EverArt MCP Server connects compatible AI clients with EverArt image generation, allowing models and agents to create and manage artwork through Model Context…

— 88.1k 3.6k dl
Other