Ebl MCP Server

🚀 EBL MCP 服務器

本項目實現了一個模型上下文協議 (MCP) 服務器，主要用於管理電子提單（eBLs）。它具備發行、查詢、轉讓和交回電子提單等功能，為電子提單的管理提供了高效且可靠的解決方案。

🚀 快速開始

前提條件

• Node.js（推薦使用 LTS 版本）
• pnpm（可通過 npm install -g pnpm 進行安裝）

安裝

1. 克隆倉庫：

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

2. 安裝依賴項：

   pnpm install
   

運行服務器

• 開發模式：

  pnpm dev
  

• 生產模式：

  pnpm build
  pnpm start
  

  ⚠️ 重要提示

  構建和啟動腳本需要在 package.json 中進行定義。

✨ 主要特性

• 發行 eBL：能夠創建並註冊一個新的電子提單。
• 查詢 eBL：可檢索現有電子提單的詳細信息。
• 轉讓 eBL：支持更改電子提單的持有人/所有者。
• 交回 eBL：可將電子提單標記為已交回，通常在貨物交付時使用。

📦 安裝指南

前提條件

需安裝 Node.js（推薦 LTS 版本）和 pnpm（通過 npm install -g pnpm 安裝）。

安裝步驟

1. 克隆倉庫：

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

2. 安裝依賴項：

   pnpm install
   

🔧 技術細節

技術棧

項目結構（初步想法）

ebl-mcp-server/
├── src/
│   ├── index.ts         # 應用程序的主入口點
│   ├── routes/          # API 路由定義
│   ├── controllers/     # 請求處理程序
│   ├── services/        # 業務邏輯
│   ├── models/          # 數據模型/接口（例如 eBL 結構）
│   ├── middleware/      # 自定義中間件（認證、日誌等）
│   └── config/          # 配置文件
├── test/                # 單元測試和集成測試
├── .env.example         # 環境變量模板
├── .gitignore
├── package.json
├── pnpm-lock.yaml
├── tsconfig.json
├── README.md            # 該文件
└── PLAN.md              # 開發計劃

🤝 貢獻

我們歡迎大家為改進 EBL MCP Server 貢獻力量！請遵循以下指南，以確保合作順利進行。

開發工作流程

1. 叉克隆倉庫，並在 main 分支上創建功能分支。
2. 安裝依賴項：pnpm install。
3. 按照編碼標準進行代碼更改。
4. 為新功能添加測試。
5. 運行測試，確保一切正常。
6. 提交拉取請求。

編碼標準

• 使用 TypeScript 編寫代碼，並添加適當的類型定義。
• 遵循函數式編程範式，避免使用類。
• 確保所有函數都是純函數，且儘量無副作用。
• 使用描述性變量名，並添加輔助動詞（如 isLoading, hasError）。
• 文件結構方面，需導出組件、子組件、助手和靜態內容。
• 利用 @modelcontextprotocol/sdk 的機制實現全面的錯誤處理。

拉取請求流程

暫未提供詳細的拉取請求流程內容，可根據實際情況補充。