ebl-mcp-server

🚀 EBL MCP 服务器

本项目实现了一个模型上下文协议 (MCP) 服务器，专门用于管理电子提单（eBLs）。它具备发行、查询、转让和交回电子提单等功能，为电子提单的管理提供了全面的解决方案。

🚀 快速开始

此项目旨在实现一个模型上下文协议 (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

运行服务器

• 开发模式：

pnpm dev

• 生产模式：

pnpm build
pnpm start

⚠️ 重要提示：构建和启动脚本需要在 package.json 中定义。

🔧 技术细节

技术栈

| 属性 | 详情 | |------|------| | 语言 | TypeScript | | 包管理器 | pnpm | | 运行时 | Node.js | | 框架 | @modelcontextprotocol/sdk |

项目结构（初步想法）

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 服务器进行改进！请遵循以下指南，以确保合作顺利：

开发工作流程

1. 叉克隆仓库，并在 main 分支上创建功能分支。
2. 安装依赖项：pnpm install。
3. 按照我们的编码标准进行代码更改。
4. 为新功能添加测试。
5. 运行测试，确保一切正常工作。
6. 提交拉取请求。

编码标准

• 使用 TypeScript 编写代码，并添加适当的类型定义。
• 遵循函数式编程范式，避免使用类。
• 确保所有函数都是纯函数，且尽量减少副作用。
• 使用描述性的变量名，并添加辅助动词（如 isLoading、hasError）。
• 文件结构：导出组件、子组件、助手和静态内容。
• 使用 @modelcontextprotocol/sdk 的机制实现全面的错误处理。

拉取请求流程

提交拉取请求时，请确保提供详细的描述，说明所做的更改及其目的。我们将尽快进行审核和反馈。