Store (E Commerce)

🚀 MCP 商店

一個用於從商店 API 獲取客戶和訂單信息的 Model Context Protocol（MCP）服務器，為商店數據交互提供便捷工具。

🚀 快速開始

MCP 商店項目實現了一個 Model Context Protocol 服務器，可與商店數據進行交互。Claude 能借助該服務器獲取所有客戶列表、按名稱搜索客戶以及根據特定客戶 ID 獲取所有訂單。

✨ 主要特性

• 能夠獲取商店數據庫中所有客戶列表。
• 支持按名稱搜索客戶，並返回所有匹配結果。
• 可根據特定客戶 ID 獲取該客戶的所有訂單信息。

📦 安裝指南

先決條件

• Node.js（推薦使用最新 LTS 版本）
• 運行在 http://localhost:3000 的本地 API 服務器，提供客戶和訂單數據

安裝步驟

# 克隆倉庫
git clone <倉庫地址>
cd mcp-store

# 安裝依賴項
npm install

# 構建項目
npm run build

💻 使用示例

基礎用法

MCP 服務器提供了以下實用工具：

get-all-customers

返回商店數據庫中所有客戶列表。

get-customer-by-name

按名稱搜索客戶並返回所有匹配結果。 參數：

• customerName：要搜索的客戶姓名

get-all-orders-by-customer

根據特定客戶 ID 獲取所有訂單信息。 參數：

• customerId：客戶的唯一標識符

📚 詳細文檔

數據模型

服務器使用以下數據模型：

客戶

interface ICustomer {
  name: string;
  email: string;
  phone?: string;
  address?: {
    street?: string;
    city?: string;
    state?: string;
    zip?: string;
    country?: string;
  };
  createdAt?: Date;
}

訂單

interface IOrder {
  customer: string;
  items: IOrderItem[];
  totalAmount: number;
  status?: "pending" | "processing" | "shipped" | "delivered" | "cancelled";
  paymentMethod?: "credit_card" | "debit_card" | "paypal" | "cash";
  createdAt?: Date;
}

interface IOrderItem {
  product: string;
  quantity: number;
  price: number;
}

產品

interface IProduct {
  name: string;
  description?: string;
  price: number;
  category?: string;
  inStock?: boolean;
  createdAt?: Date;
}

開發說明

要修改該項目，可按以下步驟操作：

1. 修改src目錄下的源文件。
2. 使用npm run build構建項目。

📄 許可證

本項目採用 ISC 許可證。