Skip to content

cargoffer/cargoffer_mcp_skybridge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cargoffer MCP - Skybridge App

Interactive API documentation MCP app for the Cargoffer B2B logistics platform

Documentation · Website · GitHub


About

Cargoffer MCP is a Skybridge application that provides type-safe, interactive API documentation for the Cargoffer B2B logistics REST API. It enables AI assistants (Claude, ChatGPT, Cursor, Copilot) to explore and query the complete API surface through natural language.

Keywords

mcp model-context-protocol cargoffer logistics freight trucking trucks transport load-board carrier api-documentation openapi docs spanish english spain portugal latam b2b marketplace

Release

Version Last commit License


What is this?

Cargoffer MCP is a Skybridge application that provides type-safe, interactive API documentation for the Cargoffer B2B logistics REST API. It enables AI assistants (Claude, ChatGPT, Cursor, Copilot) to explore and query the complete API surface through natural language.

Features

  • Search endpoints by keyword, tag, module, or locale
  • View detailed endpoint docs including parameters, request bodies, and responses
  • Explore schemas with TypeScript inference
  • Navigation by tags for easy browsing
  • Multi-locale support: Spanish (es) and English (en)
  • Live documentation for 239+ API endpoints

Supported Modules

Module Description Locales
company Company management, authentication, users es, en
truckers Trucker/carrier management, freight es, en
vehicle-types Vehicle type catalog es, en

Installation

Prerequisites

  • Node.js >= 22.0.0
  • pnpm (recommended) or npm

Quick Install

# Clone the repository
git clone https://github.com/cargoffer/cargoffer_mcp_skybridge.git
cd cargoffer_mcp_skybridge

# Install dependencies
pnpm install

# Start development server
pnpm dev

Connect to Claude Desktop

This is a Skybridge app frontend. For the actual MCP server that connects to Cargoffer APIs, use:

For Cargoffer API Docs (Bolsa de Carga):

{
  "mcpServers": {
    "cargoffer": {
      "command": "npx",
      "args": ["-y", "@cargoffer/cargo-mcp"]
    }
  }
}

Or run from source:

git clone https://github.com/cargoffer/cargo_mcp.git
cd cargo_mcp && npm install && npm start

Tools Available

search_docs

Search across all Cargoffer API documentation by keywords.

{
  query: "authentication",
  module: "company",        // optional
  locale: "es",            // optional: "es" | "en"
  limit: 10                // optional: 1-100
}

get_endpoint

Get detailed information about a specific API endpoint.

{
  module: "company",
  path: "/company/auth/login",
  method: "POST",
  locale: "es"
}

list_modules

List all available API modules with statistics.

{
  locale: "es"  // optional
}

get_navigation

Get navigation structure organized by tags for a module.

{
  module: "company",
  locale: "es"
}

search_by_tag

Find all endpoints with a specific tag.

{
  tag: "authentication",
  module: "company",  // optional
  locale: "es"       // optional
}

get_schema

Retrieve schema definitions for request/response structures.

{
  module: "company",
  schemaName: "LoginRequest",
  locale: "es"
}

list_schemas

List all available schemas for a module.

{
  module: "company",
  locale: "es"
}

API Coverage

Authentication & Users (company)

  • POST /company/auth/login - User login
  • POST /company/auth/register - Company registration
  • POST /company/auth/refresh - Token refresh
  • GET /company/users/me - Current user profile
  • PUT /company/users/:id - Update user
  • And 50+ more endpoints

Truckers & Carriers (truckers)

  • GET /truckers - List truckers
  • GET /truckers/:id - Get trucker details
  • POST /truckers/search - Advanced search
  • GET /truckers/:id/auctions - Trucker's auctions
  • And 100+ more endpoints

Vehicle Types (vehicle-types)

  • GET /vehicle-types - List vehicle types
  • GET /vehicle-types/:id - Get vehicle type
  • GET /vehicle-types/:id/pricing - Pricing by zone
  • And 80+ more endpoints

Use Cases

For AI Assistants

This MCP enables AI assistants to:

  1. Help with integration - Find the right endpoint for a given use case
  2. Explain API contracts - Show schema structures for request/response
  3. Generate code examples - Reference endpoint definitions
  4. Debug integration issues - Compare expected vs actual schemas
  5. Explore available features - Navigate by tags or modules

For Developers

  • Interactive documentation in Claude, ChatGPT, or other MCP clients
  • Type-safe exploration with automatic TypeScript inference
  • Offline-capable - Bundle the documentation for local use

Deployment

Production Build

pnpm build
pnpm start

Environment Variables

# Optional: Custom port (default: 3000)
PORT=3000

# Optional: Enable.debug mode
DEBUG=false

Documentation

Tech Stack

License

ISC - Cargoffer Team

Support

Releases

No releases published

Packages

 
 
 

Contributors