Ebl MCP Server

🚀 EBL MCP Server

This project implements a Model Context Protocol (MCP) server for managing electronic bills of lading (eBLs). It offers functions for issuing, querying, transferring, and surrendering eBLs.

🚀 Quick Start

Prerequisites

• Node.js (LTS version is recommended)
• pnpm (Install via npm install -g pnpm)

Installation

1. Clone the repository:

   git clone <your-repo-url>
   cd ebl-mcp-server
   

2. Install dependencies:

   pnpm install
   

Running the Server

• Development mode:

  pnpm dev
  

• Production mode:

  pnpm build
  pnpm start
  

  (Note: The build and start scripts need to be defined in package.json)

✨ Features

• Issue eBLs: Create and register a new electronic bill of lading.
• Query eBLs: Retrieve detailed information of existing eBLs.
• Transfer eBLs: Change the holder/owner of an eBL.
• Surrender eBLs: Mark an eBL as surrendered, typically upon cargo delivery.

📦 Installation

1. Clone the repository:

   git clone <your-repo-url>
   cd ebl-mcp-server
   

2. Install dependencies:

   pnpm install
   

📚 Documentation

Project Structure (Initial Idea)

ebl-mcp-server/
├── src/
│   ├── index.ts         # Main entry point of the application
│   ├── routes/          # API route definitions
│   ├── controllers/     # Request handlers
│   ├── services/        # Business logic
│   ├── models/          # Data models/interfaces (e.g., eBL structure)
│   ├── middleware/      # Custom middleware (authentication, logging, etc.)
│   └── config/          # Configuration files
├── test/                # Unit and integration tests
├── .env.example         # Environment variable template
├── .gitignore
├── package.json
├── pnpm-lock.yaml
├── tsconfig.json
├── README.md            # This file
└── PLAN.md              # Development plan

Contribution

We welcome contributions to improve the EBL MCP Server! Please follow the guidelines below for smooth collaboration:

Development Workflow

1. Fork the repository and create a feature branch on main.
2. Install dependencies with pnpm install.
3. Make changes following our coding standards.
4. Add tests for new features.
5. Run tests to ensure everything works properly.
6. Submit a pull request.

Coding Standards

• Write code in TypeScript with appropriate type definitions.
• Follow the functional programming paradigm; avoid using classes.
• Ensure all functions are pure and have no side - effects whenever possible.
• Use descriptive variable names with auxiliary verbs (e.g., isLoading, hasError).
• File structure: Export components, sub - components, helpers, and static content.
• Implement comprehensive error handling using the mechanisms of @modelcontextprotocol/sdk.

Pull Request Process

🔧 Technical Details

Technology Stack