Store (E Commerce)

🚀 MCP 商店

このプロジェクトは、商店APIから顧客と注文情報を取得するためのModel Context Protocol（MCP）サーバーです。MCPサーバーを通じて、商店データとのやり取りが可能になります。

🚀 クイックスタート

このMCPサーバーは、商店データとのやり取りを可能にするツールを提供します。Claudeは以下の操作ができます。

• 全顧客リストを取得する
• 名前で顧客を検索する
• 特定の顧客IDに基づいてすべての注文を取得する

✨ 主な機能

• 全顧客リストの取得
• 顧客名による検索
• 特定顧客の注文情報の取得

📦 インストール

前提条件

• Node.js（最新のLTSバージョンを推奨）
• 顧客と注文データを提供する、http://localhost:3000で実行されるローカルAPIサーバー

インストール手順

# リポジトリをクローンする
git clone <リポジトリのURL>
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