项目简介

这是一个基于TypeScript实现的Model Context Protocol (MCP) 服务器，它利用HeyBeauty API为AI客户端（如大型语言模型）提供虚拟试穿功能。服务器将服装作为“资源”进行管理，注册提交和查询试穿任务的“工具”，并定义用于指导AI进行虚拟试穿交互的“提示模板”。

主要功能点

• 服装资源访问： 允许AI客户端列出并读取HeyBeauty平台上的服装列表，获取服装的URI、名称、描述等信息。
• 虚拟试穿工具： 提供工具供AI调用，以提交用户图片和服装图片的虚拟试穿请求，并能根据任务ID查询试穿结果。
• 试穿交互提示： 定义提示模板，指导AI客户端如何结合用户输入的图片和选择的服装资源，使用虚拟试穿工具完成任务。

安装步骤

本项目基于Node.js环境。您需要先安装Node.js和npm。

1. 克隆或下载仓库代码。
2. 进入项目目录。
3. 运行以下命令安装依赖：

   npm install
   

4. 构建项目：

   npm run build
   

   这会在 'build' 目录下生成可执行的JavaScript文件。

服务器配置

要让支持MCP协议的AI客户端（例如Claude Desktop）使用此服务器，需要在客户端的配置文件中添加服务器信息。

核心配置项包括：

• 服务器名称 ('server name')： 用于标识该服务器的名称，例如 'heybeauty-mcp'。
• 启动命令 ('command')： 客户端用于启动此MCP服务器进程的命令。根据您的安装方式，可以是 'npx'（如果全局安装或使用npx执行）或 'node' 加上服务器 'build' 目录下主文件的路径（例如 '/path/to/heybeauty-mcp/build/index.js'）。
• 启动参数 ('args')： 传递给启动命令的参数。通常是主文件的路径（如果command是node）。
• 环境变量 ('env')： MCP服务器需要您的HeyBeauty API Key才能工作。请在环境变量中设置 'HEYBEAUTY_API_KEY'，值为您从HeyBeauty获取的API Key。

请查阅您的MCP客户端文档，了解具体的配置格式和位置。

基本使用方法

1. 按照上述步骤安装并配置服务器到您的MCP客户端。
2. 确保您已获取并配置了HeyBeauty API Key。
3. 启动您的MCP客户端。客户端会自动尝试根据配置启动并连接到HeyBeauty MCP服务器。
4. 在AI客户端中，您将能够访问到此服务器提供的服装资源列表、调用虚拟试穿工具，并通过预设的提示与AI进行虚拟试穿的交互。用户可以提供自己的图片，并选择服务器提供的服装资源进行试穿。