Metadata-Version: 2.4
Name: BigGo-MCP-Server
Version: 0.1.12
Summary: A Model Context Protocol (MCP) server that provides product search, price history tracking, and specification search capabilities.
Project-URL: Source, https://github.com/Funmula-Corp/BigGo-MCP-Server
Author-email: alex <alex@funmula.com>
License: Copyright 2025 Funmula-Corp
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
License-File: LICENSE
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Requires-Dist: aiohttp>=3.11.11
Requires-Dist: async-lru>=2.0.4
Requires-Dist: elasticsearch8[async]>=8.17.1
Requires-Dist: mcp[cli]>=1.2.1
Requires-Dist: typing-extensions>=4.12.2
Description-Content-Type: text/markdown

# 🔍 BigGo MCP Server
[![PyPI - Version](https://img.shields.io/pypi/v/BigGo-MCP-Server?style=for-the-badge)](https://pypi.org/project/BigGo-MCP-Server/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/BigGo-MCP-Server?style=for-the-badge)
## Introduction
BigGo MCP Server utilizes APIs from BigGo, a professional price comparison website.

## Features
- **Product Discovery**: Search for products across multiple e-commerce platforms (Amazon, Aliexpress, Ebay, Taobao, Shopee ... etc.)
- **Price History Tracking**: Track product price history by supplying product url or related terms.
- **Spec Comparison**: Compare and find products based on their specifications, from basic infos to more complex technical specs.

## Installation
### Prerequisites
1. Python >= 3.10
2. [uvx package manager ( Included with uv )](https://docs.astral.sh/uv/getting-started/installation/)
3. BigGo Certification (`client_id` and `client_secret`) for specification search. 

#### How to obtain BigGo certification?
  - [Register](https://account.biggo.com/?url=https%3A%2F%2Fbiggo.com%2F&lang=en&source=web&type=biggo3&method=register) a BigGo account if you don't have one.
  - Go to [BigGo Certification Page](https://account.biggo.com/setting/token)
  - Click "Generate certification" button
  - ![Generate Certification](./docs/Pics/generate-certification.png)
  - Copy the `client_id` and `client_secret`
  - Use them in the MCP Server configuration (`BIGGO_MCP_SERVER_CLIENT_ID` and `BIGGO_MCP_SERVER_CLIENT_SECRET`)

```json
{
  "mcpServers": {
    "biggo-mcp-server": {
      "command": "uvx",
      "args": [ "BigGo-MCP-Server"],
      "env": {
        "BIGGO_MCP_SERVER_CLIENT_ID": "CLIENT_ID",
        "BIGGO_MCP_SERVER_CLIENT_SECRET": "CLIENT_SECRET",
        "BIGGO_MCP_SERVER_REGION": "REGION"
      }
    }
  }
}
```
> For specific version use `BigGo-MCP-Server@VERSION`, ex: `BigGo-MCP-Server@0.1.1`

## Environment Variables
| Variable                         | Description               | Default | Choices                                    |
| -------------------------------- | ------------------------- | ------- | ------------------------------------------ |
| `BIGGO_MCP_SERVER_CLIENT_ID`     | Client ID                 | None    | Required for specification search          |
| `BIGGO_MCP_SERVER_CLIENT_SECRET` | Client Secret             | None    | Required for specification search          |
| `BIGGO_MCP_SERVER_REGION`        | Region for product search | TW      | US, TW, JP, HK, SG, MY, IN, PH, TH, VN, ID |

## Available Tools
- `product_search`: Product search with BigGo search api
- `price_history_graph`: Link that visualizes product price history
- `price_history_with_history_id`: Uses history IDs from product search results
- `price_history_with_url`: Tracks price history using product URLs
- `spec_indexes`: Lists available Elasticsearch indexes for product specifications
- `spec_mapping`: Shows Elasticsearch index mapping with example documents
- `spec_search`: Query product specifications from Elasticsearch
- `get_current_region`: Get the current region

## FAQ
### How to trigger tool usage?
For **Product Discovery** related:
```
Look for Nike running shoes
```
For **Price History Tracking** related:
```
Show me the price history of this product: https://some-product-url
```
For **Spec Comparison** related:
```
Find me phones with 16GB RAM and 1TB storage
```
```
Please show me diving watches that can withstand the most water pressure
```

## Build
See [build.md](docs/build.md) for more details.

## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
