AverbePorto-DataGateway

🌟 Abstract

This AverbePorto-DataGateway component serves as an MCP (Model Context Protocol) intermediary, establishing connectivity with the AverbePorto platform. It streamlines access to core functionalities, specifically focusing on secure authorization procedures and electronic document remittance utilizing AI-driven workflows.

🌐 Accessing the Web Portal

1. Navigate to https://www.averbeporto.com.br
2. Authenticate using your assigned credentials.
3. Within the portal, capabilities include:
4. Retrieving API Access Keys under User Profile settings.
5. Executing submissions for XML documentation.
6. Performing lookups against ANTT protocols.
7. Oversight and administration of your cargo insurance endorsements.

🤖 Employing the DataGateway with AI Constructs

Installation via Smithery

To provision the averbeporto-mcp module automatically for Claude Desktop using Smithery:

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

Claude Desktop

1. Modify the configuration file located at %APPDATA%\Claude\claude_desktop_config.json (Windows) or ~/Library/Application Support/Claude/claude_desktop_config.json (MacOS) and integrate the following stanza:

   { "mcpServers": { "AverbePorto-DataGateway": { "command": "node", "args": ["/path/to/AverbePorto-MCP/build/index.js"] } } }

2. Upon conversation initiation, the MCP server will initialize based on this configuration.

Cursor, Roo Code and Analogous Environments

1. Establish a configuration file, such as .cursor/mcp.json or .roo/mcp.json, within your project directory containing:

   { "mcpServers": { "AverbePorto-DataGateway": { "command": "node", "args": ["/path/to/AverbePorto-MCP/build/index.js"], "disabled": false, "alwaysAllow": [ "authenticate", "queryRegulatoryRecord", "ingestFile", "fetchManifest", "parseIdentifier" ] } } }

2. The DataGateway will automatically activate upon starting the session.

Github Copilot

1. With Copilot active in your IDE, generate the file .vscode/mcp.json:

{ "inputs": [ { "type": "promptString", "id": "avp-user-id", "description": "AverbePorto API User Identifier" }, { "type": "promptString", "id": "avp-secret-key", "description": "AverbePorto API Secret Key", "password": true } ], "servers": { "AverbePorto-DataGateway": { "command": "node", "args": ["/path/to/AverbePorto-MCP/build/index.js"], "env": { "AVP_API_USER": "${input:avp-user-id}", "AVP_API_SECRET": "${input:avp-secret-key}" } } } }

1. Your IDE will prompt for credentials on first execution, ensuring secure storage.
2. Copilot will recognize the DataGateway commands and suggest context-aware operations for:
3. API Session Establishment
4. XML Document Transmission
5. ANTT Protocol Information Retrieval
6. Credentials will be transparently injected into API interactions.

📚 Available Functions for the AI Agent

The AverbePorto-DataGateway exposes the following utilities:

• authenticate: Establishes session security.
• Arguments: user, pass

• Yields: sessionId

• ingestFile: Transmits payload data.

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

• Yields: uploadId

• queryRegulatoryRecord: Fetches protocol details via key reference or vice-versa.

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

• Output Formats: json, xml, csv

• fetchManifest: Retrieves previously transmitted artifacts.

• Arguments:

  • sessionId: Session token from successful authentication.
  • modDoc: Document classification code (e.g., DI, MDF-e, CT-e, NF-e, Draft CT-e).
  • dtStart & dtLimit: Temporal bounds in YYYY-MM-DD format.
  • dtType: Date classification (Update, Emission, Dispatch); defaults to Dispatch.
  • Optional Filters: numDoc, emit, rem, exped, receb, dest, toma, importador, representante, prot, taxId.
  • Paging Controls: page, start, limit.
  • Ancillary: relation, modal, valid.

• parseIdentifier: Breaks down access keys for detailed inspection.

• Arguments:
  • key: The 44-digit access token for NF-e, CT-e, or MDF-e.

🔒 Security Posture

• Leverage API credentials provisioned within the User Configuration module.
• Maintain strict confidentiality of access credentials.
• Never disclose your active sessionId.
• Prioritize secure communication channels exclusively.
• Ensure the DataGateway server software remains current.