Store (E Commerce)

🚀 MCP Store

An MCP (Model Context Protocol) server for retrieving customer and order information from the store API.

🚀 Quick Start

This project implements an MCP server, offering tools for interacting with store data. It enables Claude to:

• Retrieve a list of all customers.
• Search for customers by name.
• Fetch all orders based on a specific customer ID.

✨ Features

• Customer Retrieval: Get a list of all customers and search for customers by name.
• Order Retrieval: Fetch all orders for a specific customer.

📦 Installation

Prerequisites

• Node.js (It is recommended to use the latest LTS version).
• A local API server running at http://localhost:3000, providing customer and order data.

# Clone the repository
git clone <repository-url>
cd mcp-store

# Install dependencies
npm install

# Build the project
npm run build

💻 Usage Examples

Basic Usage

The MCP server provides the following tools:

get-all-customers

Returns a list of all customers in the store database.

get-customer-by-name

Searches for customers by name and returns all matching results.

Parameters:

• customerName: The name of the customer to search for.

get-all-orders-by-customer

Retrieves all order information based on a specific customer ID.

Parameters:

• customerId: The unique identifier of the customer.

📚 Documentation

Data Models

The server uses the following data models:

Customer

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

Order

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;
}

Product

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

Development

To modify this project:

1. Modify the source files in the src directory.
2. Build the project using npm run build.

📄 License

ISC