返回 MCP 目录
public公开dns本地运行

heybeauty-mcp

HeyBeauty虚拟试衣MCP服务,基于TypeScript实现,提供服装资源管理、试衣任务提交与查询功能,集成HeyBeauty API实现虚拟试穿效果。

article

README

🚀 HeyBeauty MCP 服务器

HeyBeauty 虚拟试穿是一个基于 TypeScript 的 MCP 服务器,借助 HeyBeauty API 实现虚拟试穿功能。该服务器通过特定方式演示核心 MCP 概念,为用户提供便捷的虚拟试穿体验。

🚀 快速开始

申请 API Key

首先,你需要申请 HeyBeauty API Key

配置服务器

将服务器配置添加到 MCP 客户端配置文件中:

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

资源相关

  • 资源访问:使用 cloth:// URI 列出和访问服装。
  • 资源信息:每件服装都有 id、名称、描述、图片 URL 和元数据。
  • 内容访问:使用纯文本 MIME 类型进行简单内容访问。

工具使用

  • 提交试穿任务submit_tryon_task 工具可用于提交试穿任务。它接受用户图片 URL、服装图片 URL、服装 ID 和服装描述作为必填参数,并将试穿任务存储在服务器状态中。
  • 查询试穿任务query_tryon_task 工具用于查询试穿任务。它接受任务 ID 作为必填参数,并返回试穿任务信息。

提示使用

tryon_cloth 提示可帮助你尝试穿上衣服。它接受用户图片 URL、服装图片 URL、服装 ID 和服装描述作为必填参数,并返回用于 LLM 试穿的结构化提示。

资源说明

cloth:// 是表示服装的 URI,每件服装都有 id、名称、描述、图片 URL 和元数据。

📦 安装指南

与 Claude Desktop 一起使用时,请添加以下配置:

  • MacOS:在 ~/Library/Application Support/Claude/claude_desktop_config.json 中添加配置。
  • 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"
    }
  }
}

请按照文档 获取 HeyBeauty API Key

调试说明

由于 MCP 服务器通过 stdio 进行通信,调试可能具有挑战性。我们推荐使用 MCP Inspector,该工具可通过以下命令获得:

npm run inspector

Inspector 将提供一个访问调试工具的 URL,你在浏览器中打开即可进行调试。

🔧 开发步骤

安装依赖

npm install

构建服务器

npm run build

开发模式

带有自动重建功能的开发,可使用以下命令:

npm run watch
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端