# Walmart Scraper4 MCP Server

English | [简体中文](./README.md) | [繁體中文](./README_ZH-TW.md)

## 🚀 Quick Start with EMCP Platform

**[EMCP](https://sit-emcp.kaleido.guru)** is a powerful MCP server management platform that allows you to quickly use various MCP servers without manual configuration!

### Quick Start:

1. 🌐 Visit **[EMCP Platform](https://sit-emcp.kaleido.guru)**
2. 📝 Register and login
3. 🎯 Go to **MCP Marketplace** to browse all available MCP servers
4. 🔍 Search or find this server (`bach-walmart_scraper4`)
5. 🎉 Click the **"Install MCP"** button
6. ✅ Done! You can now use it in your applications

### EMCP Platform Advantages:

- ✨ **Zero Configuration**: No need to manually edit config files
- 🎨 **Visual Management**: Easy-to-use GUI for managing all MCP servers
- 🔐 **Secure & Reliable**: Centralized API key and authentication management
- 🚀 **One-Click Install**: Rich selection of servers in MCP Marketplace
- 📊 **Usage Statistics**: Real-time service call monitoring

Visit **[EMCP Platform](https://sit-emcp.kaleido.guru)** now to start your MCP journey!


---

## Introduction

This is an automatically generated MCP server using [FastMCP](https://fastmcp.wiki) for accessing the Walmart Scraper4 API.

- **PyPI Package**: `bach-walmart_scraper4`
- **Version**: 1.0.0
- **Transport Protocol**: stdio


## 安装

### 从 PyPI 安装:

```bash
pip install bach-walmart_scraper4
```

### 从源码安装:

```bash
pip install -e .
```

## 运行

### 方式 1: 使用 uvx（推荐，无需安装）

```bash
# 运行（uvx 会自动安装并运行）
uvx --from bach-walmart_scraper4 bach_walmart_scraper4

# 或指定版本
uvx --from bach-walmart_scraper4@latest bach_walmart_scraper4
```

### 方式 2: 直接运行（开发模式）

```bash
python server.py
```

### 方式 3: 安装后作为命令运行

```bash
# 安装
pip install bach-walmart_scraper4

# 运行（命令名使用下划线）
bach_walmart_scraper4
```

## Configuration

### API Authentication

This API requires authentication. Please set environment variable:

```bash
export API_KEY="your_api_key_here"
```

### Environment Variables

| Variable | Description | Required |
|----------|-------------|----------|
| `API_KEY` | API Key | Yes |




### 在 Claude Desktop 中使用

编辑 Claude Desktop 配置文件 `claude_desktop_config.json`:


```json
{
  "mcpServers": {
    "walmart_scraper4": {
      "command": "python",
      "args": ["E:\path\to\walmart_scraper4\server.py"],
      "env": {
        "API_KEY": "your_api_key_here"
      }
    }
  }
}
```

**Note**: Replace `E:\path\to\walmart_scraper4\server.py` with the actual server file path.


## 可用工具

此服务器提供以下工具:


### `get_product_data_from_url`

This API endpoint is used to collect product information from a URL

**端点**: `POST /api/ecommerce/walmart-scraper/products`



---


### `monitor_status`

Some scraping data may take longer than average. If that's the case, you'll get a task_id. Use it to retrieve your data when it's complete.

**端点**: `GET /api/monitor-status`


**参数**:

- `task_id` (string) *必需*: Example value: s_m195ovji14wesgd4u1



---


### `discover_top_products_in_a_category_by_keyword`

This endpoint if for discovering top products from a given category keyword.

**端点**: `POST /api/ecommerce/walmart-scraper/products-by-keyword`



---


### `discover_top_products_in_a_category`

This API endpoint scrapes top products in a given category. It takes URL as parameter.

**端点**: `POST /api/ecommerce/walmart-scraper/category-products`



---



## 技术栈

- **FastMCP**: 快速、Pythonic 的 MCP 服务器框架
- **传输协议**: stdio
- **HTTP 客户端**: httpx

## 开发

This server is automatically generated by [API-to-MCP](https://github.com/BACH-AI-Tools/api-to-mcp) tool.

Version: 1.0.0
