ecomcp / docs /HUGGINGFACE_SPACES_GUIDE.md
vinhnx90's picture
docs: Remove `docs/` and `../` prefixes from internal links across documentation files.
d12052d

A newer version of the Gradio SDK is available: 6.13.0

Upgrade

HuggingFace Spaces Deployment Guide

For MCP's 1st Birthday Hackathon (Nov 14-30, 2025)


Quick Checklist

Before deploying to HF Spaces, ensure:

  • Your app is complete and tested locally
  • README.md has proper track tags
  • Demo video recorded (1-5 minutes)
  • Social media post prepared
  • Dockerfile or requirements.txt ready
  • All team members registered
  • Team usernames in Space README
  • Space created in MCP-1st-Birthday organization

Step-by-Step Deployment

1. Create HF Space

  1. Go to HuggingFace Spaces
  2. Click "Create new Space"
  3. Set up:
    • Name: Your project name
    • License: Apache 2.0 or MIT
    • Space SDK: Docker (if using Dockerfile) or Gradio
    • Organization: MCP-1st-Birthday
    • Visibility: Public (required)

2. Push Code to Space

# Clone your space locally
git clone https://huggingface.co/spaces/MCP-1st-Birthday/your-space-name
cd your-space-name

# Copy your project files
cp -r path/to/ecomcp/* .

# Push to HF
git add .
git commit -m "Initial commit"
git push

3. Configure README.md

Your Space's README.md must include:

---
title: EcoMCP - E-commerce Intelligence
emoji: 
colorFrom: blue
colorTo: purple
sdk: docker
sdk_version: latest
app_file: run_ui.py
pinned: false
tags:
  - mcp-in-action-track-consumer
  - ecommerce
  - gradio
---

# EcoMCP - E-commerce Model Context Protocol

**Production-ready MCP server for e-commerce intelligence**

##  Hackathon Track

Track: **MCP in Action - Consumer Applications**  
Tag: `mcp-in-action-track-consumer`

##  About This Project

EcoMCP provides 4 AI-powered tools for e-commerce:
-  Product Analysis - Market insights & positioning
-  Review Analysis - Sentiment extraction & insights
-  Listing Generation - High-converting product copy
-  Price Recommendation - Data-driven pricing strategy

##  Quick Start

```bash
python3 run_ui.py
# Open http://localhost:7860

Demo Video

[Link to your demo video on YouTube/Loom]

Social Media Post

[Link to your X/LinkedIn post about this project]

Team Members

Key Features

Modular architecture
Type hints & docstrings
Comprehensive documentation
Production-ready code

Documentation

Support

For questions, visit our Discord


Built for MCP's 1st Birthday Hackathon


### 4. Set Required Tags

**Track 1: Building MCP**
  • building-mcp-track-enterprise
  • building-mcp-track-consumer
  • building-mcp-track-creative

**Track 2: MCP in Action** ← EcoMCP fits here
  • mcp-in-action-track-enterprise
  • mcp-in-action-track-consumer
  • mcp-in-action-track-creative

### 5. Create Demo Video

**Requirements:**
- Length: 1-5 minutes
- Show your app in action
- Demonstrate key features
- Clear audio/video quality

**How to create:**
1. Record screen with OBS Studio (free)
2. Edit video if needed
3. Upload to YouTube as unlisted/public
4. Add link to Space README

---

##  Docker Deployment

Your Dockerfile should:

```dockerfile
FROM python:3.10-slim

WORKDIR /app

# Copy project files
COPY . .

# Install dependencies
RUN pip install --no-cache-dir -r requirements.txt

# Set environment variables
ENV GRADIO_SERVER_NAME="0.0.0.0"
ENV GRADIO_SERVER_PORT=7860

# Run app
CMD ["python3", "run_ui.py"]

requirements.txt

gradio==6.0.0
aiohttp==3.9.0

Track Selection

Track 1: Building MCP Yes

EcoMCP is an MCP server (src/server/mcp_server.py)

Include:

  • Video showing MCP server in action
  • Integration with Claude Desktop/Cursor
  • Documentation of tools/capabilities

Track 2: MCP in Action Yes

EcoMCP is a Gradio AI agent app using MCP tools

Include:

  • Video showing autonomous agent behavior
  • Planning, reasoning, execution examples
  • Real-world use case demonstration

** EcoMCP qualifies for BOTH tracks!**


Social Media Requirements

Post about your project on X, LinkedIn, or both:

Sample Post (X/Twitter)

 Just submitted EcoMCP to MCP's 1st Birthday Hackathon!

 An AI-powered e-commerce intelligence platform with:
- Product market analysis
- Review sentiment analysis
- Smart product listing generation
- Data-driven pricing

Built with @gradio, @AnthropicAI MCP, and @OpenAI

 [HF Space Link]

#MCPHackathon #Gradio #MCP #AI

Sample Post (LinkedIn)

Excited to announce EcoMCP - my submission to the MCP's 1st Birthday Hackathon! 

This production-ready platform brings AI intelligence to e-commerce through:
 Advanced product analysis with market insights
 Customer review sentiment analysis
 AI-powered listing generation
 Intelligent pricing strategies

The project demonstrates autonomous AI agents making data-driven decisions to help e-commerce businesses optimize their operations.

Check it out and let me know what you think!

#MCP #Gradio #AI #Hackathon #ECommerce

Final Submission Checklist

Code Requirements

  • App runs without errors
  • All dependencies in requirements.txt
  • Dockerfile builds successfully
  • No API keys in code (use env vars)

Documentation

  • README.md with proper tags
  • Demo video uploaded (1-5 min)
  • Social media post published
  • Team members listed (if applicable)
  • Clear feature descriptions

Track Specifics

If submitting to Track 1 (Building MCP):

  • MCP server functional
  • Video shows MCP integration
  • Tools documented
  • Instructions for client setup

If submitting to Track 2 (MCP in Action):

  • Gradio app demonstrates agents
  • Shows planning/reasoning/execution
  • Real-world use case clear
  • MCP tools integrated

Both tracks:

  • Original work (created Nov 14-30)
  • Gradio 6 features used
  • High-quality UI/UX
  • Professional documentation

Prize Categories for EcoMCP

Track 1: Building MCP

  • Enterprise MCP Servers (Tag: building-mcp-track-enterprise)
  • Consumer MCP Servers (Tag: building-mcp-track-consumer)
  • Creative MCP Servers (Tag: building-mcp-track-creative)

Track 2: MCP in Action

  • Enterprise Applications (Tag: mcp-in-action-track-enterprise)
  • Consumer Applications (Tag: mcp-in-action-track-consumer)
  • Creative Applications (Tag: mcp-in-action-track-creative)

Prize Pool

  • First Place: $2,500 USD
  • Second Place: $1,000 USD
  • Third Place: $500 USD
  • Community Choice: $1,000 USD

Sponsor Awards

  • OpenAI: Best API Integration ($1,000 credits)
  • Modal: Innovation Award ($2,500 cash)
  • LlamaIndex: Category Award ($1,000)
  • Blaxel: Choice Award ($2,500 cash)
  • ElevenLabs: 6 months Scale-tier + AirPods4 Pro
  • Google Gemini: $30,000 API credits

Troubleshooting

App won't start

# Check logs
docker logs your-space-name

# Verify requirements
pip install -r requirements.txt

# Test locally
python3 run_ui.py

Dependencies missing

# Update requirements.txt with all imports
pip freeze > requirements.txt

Environment variables

# In Dockerfile
ENV OPENAI_API_KEY=${OPENAI_API_KEY}
ENV GRADIO_SERVER_NAME="0.0.0.0"
ENV GRADIO_SERVER_PORT=7860

Resources


Tips for Success

Do:

  • Use Gradio 6 features (enhanced UI/UX)
  • Document thoroughly
  • Include demo video
  • Share on social media
  • Engage with community
  • Test thoroughly before submit

Don't:

  • Hardcode API keys
  • Submit incomplete projects
  • Miss deadline (Nov 30, 11:59 PM UTC)
  • Forget track tags
  • Skip documentation
  • Ignore review feedback

Final Steps

  1. Create Space in MCP-1st-Birthday organization
  2. Push code with Dockerfile/requirements.txt
  3. Update README.md with track tags
  4. Record demo and upload to YouTube
  5. Post on social media with your project link
  6. Add links to README (demo + social post)
  7. Register for hackathon if not already done
  8. Verify all requirements met
  9. Submit before Nov 30, 11:59 PM UTC
  10. Wait for results (Dec 15)

Status: Ready for HuggingFace Spaces Submission

Your EcoMCP project is production-ready for the hackathon!