Heybeauty MCP

🚀 HeyBeauty MCP Server

HeyBeauty Virtual Try-On is a TypeScript-based MCP server that uses the HeyBeauty API to implement virtual try-on functionality. It demonstrates core MCP concepts in the following ways:

• Represents clothing resources using cloth:// URIs and metadata.
• Provides tools for submitting try-on tasks and querying task information.
• Offers prompts for trying on clothes.

🚀 Quick Start

1. Apply for a HeyBeauty API Key.
2. Add the server configuration to the MCP client configuration file.

{
  "mcpServers": {
    "heybeauty-mcp": {
      "command": "npx",
      "args": ["-y", "heybeauty-mcp"],
      "env": {
        "HEYBEAUTY_API_KEY": "your_heybeauty_api_key"
      }
    }
  }
}

Resources

• List and access clothing using cloth:// URIs.
• Each piece of clothing has an ID, name, description, image URL, and metadata.
• Use the plain text MIME type for simple content access.

Tools

• submit_tryon_task - Submit a try-on task.
  • Accepts the user image URL, clothing image URL, clothing ID, and clothing description as required parameters.
  • Stores the try-on task in the server state.
• query_tryon_task - Query a try-on task.
  • Accepts the task ID as a required parameter.
  • Returns try-on task information.

Prompts

• tryon_cloth - Try on clothes.
  • Accepts the user image URL, clothing image URL, clothing ID, and clothing description as required parameters.
  • Returns a structured prompt for LLM try-on.

Resources

• cloth:// - URI representing clothing.
  • Each piece of clothing has an ID, name, description, image URL, and metadata.

💻 Usage Examples

Basic Usage

# Install dependencies
npm install

# Build the server
npm run build

# Development with automatic rebuild
npm run watch

📦 Installation

When using with Claude Desktop, add the following configuration:

• On MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• On Windows: %APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "heybeauty-mcp": {
      "command": "node",
      "args": ["/path/to/heybeauty-mcp/build/index.js"]
    },
    "env": {
      "HEYBEAUTY_API_KEY": "your_heybeauty_api_key"
    }
  }
}

Follow the documentation to Get a HeyBeauty API Key.

Debugging

Since MCP servers communicate via stdio, debugging can be challenging. We recommend using MCP Inspector, which can be obtained with the following command:

npm run inspector

The Inspector will provide a URL to access the debugging tools. Open it in your browser.