AP-IntegrationGateway (AverbePorto Orchestrator)

🌟 Overview

This Model Context Protocol (MCP) endpoint, named AP-IntegrationGateway, establishes a robust connection to the AverbePorto infrastructure. Its primary function is to streamline access to proprietary authentication services and enable programmatic transmission of required documentation leveraging advanced Artificial Intelligence agents.

🌐 Accessing the Native Web Portal

To interact directly with the AverbePorto system:

1. Navigate to https://www.averbeporto.com.br.
2. Authenticate using your assigned credentials.
3. Within the user control panel, capabilities include:
   • API Key Generation (found under User Settings).
   • Batch submission of XML transit documents.
   • Real-time verification of ANTT consignment records.
   • Comprehensive lifecycle management for cargo insurance certificates.

🤖 Utilizing the MCP Endpoint with Generative Models

Deployment via Smithery

To integrate AP-IntegrationGateway into your local Claude Desktop environment automatically using Smithery:

bash npx -y @smithery/cli install @GHSix/averbeporto-mcp --client claude

Configuration for Claude Desktop

Modify the configuration file (%APPDATA%\Claude\claude_desktop_config.json on Windows or ~/Library/Application Support/Claude/claude_desktop_config.json on MacOS) by appending the following block:

{
  "mcpServers": {
    "AP-IntegrationGateway": {
      "command": "node",
      "args": ["/caminho/para/AverbePorto-MCP/build/index.js"]
    }
  }
}

Upon starting a session, the MCP gateway will initialize based on this definition.

Configuration for Cursor, Roo Code and others

Establish a configuration file such as .cursor/mcp.json or .roo/mcp.json within your project root:

{
  "mcpServers": {
    "AP-IntegrationGateway": {
      "command": "node",
      "args": ["/caminho/para/AverbePorto-MCP/build/index.js"],
      "disabled": false,
      "alwaysAllow": [
        "authenticateUser",
        "checkManifestStatus",
        "submitManifest",
        "fetchManifestDetails",
        "resolveAccessKey"
      ]
    }
  }
}

This configuration enables the gateway upon session start.

Integration with Github Copilot

If Copilot is active in your IDE, define the necessary parameters in .vscode/mcp.json:

{ "inputs": [ { "type": "promptString", "id": "ap-client-id", "description": "AverbePorto System Identifier (Username)" }, { "type": "promptString", "id": "ap-client-secret", "description": "AverbePorto Operational Secret (Password)", "password": true } ], "servers": { "AP-IntegrationGateway": { "command": "node", "args": ["/caminho/para/AverbePorto-MCP/build/index.js"], "env": { "AVERBEPORTO_USER": "${input:ap-client-id}", "AVERBEPORTO_PASS": "${input:ap-client-secret}" } } } }

During the initial invocation, your environment will securely prompt for and store these credentials. Copilot will then contextually suggest actions such as: - API handshake establishment. - Transmission of structured XML payloads. - Queries against ANTT documentation registries. - Automatic injection of required credentials for API interactions.

📚 Available Functionality for AI Agents

The AP-IntegrationGateway exposes the following defined functions:

• authenticateUser: Establishes a session with the service.
• Arguments: user, pass

• Returns: sessionId (Session Token)

• submitManifest: Transmits documentation files.

• Arguments: sessionId, filePath, recipient (optional), version (optional)

• Returns: uploadId (Submission Identifier)

• checkManifestStatus: Queries record statuses via identifiers or cross-references.

• Arguments: sessionId, keys, protocols, outputFormat, download, delimiter

• Output Formats Supported: json, xml, csv

• fetchManifestDetails: Retrieves previously submitted manifest records.

• Arguments:

  • sessionId: Required token from authentication.
  • modDoc: Document Type Classification (e.g., DI, MDF-e, CT-e, NF-e, Draft CT-e).
  • dtStart & dtLimit: Temporal boundaries using YYYY-MM-DD format.
  • dtType: Date field target (e.g., Update, Emission, Send); defaults to Send.
  • Supplementary Filters: numDoc, emit, rem, exped, receb, dest, toma, importador, representante, prot, taxId.
  • Paging Controls: page, start, limit.
  • Metadata: relation, modal, valid.

• resolveAccessKey: Breaks down complex access keys for analytical purposes.

• Arguments:
  • key: The 44-digit access identifier pertinent to NF-e, CT-e, or MDF-e.

🔒 Security Posture

• Adhere strictly to the API credentials obtained from the User Management module.
• Maintain the secrecy of all system credentials.
• Never disclose your active sessionId.
• Ensure all communications utilize secure channels.
• Regularly apply updates to the MCP endpoint software.