Printify 项目文档

项目介绍

这个仓库包含一个用于管理 Printful 应用程序产品的 MCP（中心控制面板）服务器。MCP 允许用户通过 API 创建、读取、更新和删除产品。以下是项目的详细信息：

功能特性

• Printful API 集成：与 Printful 平台无缝连接，实现产品的创建和管理。
• 图片上传支持：允许将图片直接上传到 Printful 服务。
• 日志记录：详细的服务器端日志，便于调试和监控。

技术栈

• 语言框架：Node.js 和 TypeScript
• 构建工具：Docker 容器化部署
• 依赖管理：npm 包管理器

代码库说明

项目源代码位于 src 文件夹中，以下是关键文件的简要说明：

主要文件

1. index.ts：项目的主入口文件，负责初始化和运行 MCP 服务器。
2. printify-api.ts：实现与 Printful API 的交互，包括产品创建、读取、更新和删除功能。
3. replicate-client.ts：用于处理图片上传的客户端模块。

第三方依赖

项目使用以下 npm 包：

• @types/node：Node.js 类型定义
• express：Web 框架
• typescript：静态类型支持
• @types/express：Express 类型定义
• dotenv：环境变量管理
• multer：文件上传处理

使用说明

要运行这个项目，需要以下条件：

1. 安装 Node.js 和 npm：确保系统上已安装 Node.js 14+ 和 npm 6+。
2. 安装 Docker：用于构建和运行容器化的服务。
3. 克隆仓库：从 GitHub 克隆此仓库到本地开发环境。

快速开始

1. 克隆仓库：

   git clone https://github.com/username/printify-mcp.git
   cd printify-mcp
   

2. 安装依赖：

   npm install
   

3. 启动项目：

   • 使用 Docker Compose：

     docker-compose up --build
     

   • 或者直接运行：

     npm run dev
     

详细文档

如需了解代码的详细信息，请参考以下文档文件：

• index.ts 文档
• printify-api.ts 文档
• replicate-client.ts 文档

故障排除

常见问题

Printful API 客户端未初始化

如果遇到错误信息“Printful API client is not initialized”，请检查以下内容：

1. 确认 .env 文件中的 PRINTFUL_API_KEY 环境变量是否正确设置。
2. 验证 API 密钥的有效性和权限。

Replicate 客户端未初始化

如果遇到错误信息“Replicate client is not initialized”，请检查以下内容：

1. 确认 .env 文件中的 REPLICATE_API_TOKEN 是否正确设置。
2. 验证 API 令牌的有效性和权限。

创建产品时出错

如果在创建产品过程中出现错误，请检查以下内容：

1. 确保使用的 blueprint ID 和 print provider ID 正确且有效。
2. 检查上传的图片是否符合 Printful 的格式和大小要求。

联系方式

如需帮助或报告问题，请联系项目维护人员：support@printify.com

代码示例

以下是一个使用此 MCP 创建产品的简单示例：

import { createProduct } from './printify-api';

const main = async () => {
    try {
        const product = await createProduct({
            title: 'My New Product',
            description: 'This is a test product.',
            images: ['path/to/image1.jpg', 'path/to/image2.jpg']
        });
        console.log('Product created successfully:', product);
    } catch (error) {
        console.error('Error creating product:', error.message);
    }
};

main();

项目结构

以下是项目的目录结构：

printify-mcp/
├── src/                 # 源代码文件夹
│   ├── index.ts         # 项目入口点
│   ├── printify-api.ts  # Printful API 实现模块
│   └── replicate-client.ts # 图片上传处理模块
├── docs/                # 文档文件夹
│   ├── index.ts.md      # index.ts 的详细文档
│   └── ...
├── package.json        # 项目依赖和脚本信息
├── docker-compose.yml  # Docker 容器配置文件
└── .env.example        # 环境变量示例文件

贡献指南

如果希望为这个项目做贡献，请遵循以下步骤：

1. 叉建华克仓库：git clone https://github.com/username/printify-mcp.git
2. 创建功能分支：git checkout -b feature/new-feature
3. 提交更改：git add . && git commit -m 'Add new feature'
4. 推送到远程仓库：git push origin feature/new-feature
5. 提交 Pull Request 到主分支。

许可证

项目使用 MIT 许可证，具体内容如下：

MIT License

附录

命令行工具

• 构建 Docker 镜像：

  docker build -t printify-mcp .
  

• 运行容器：

  docker run -p 3000:3000 --env-file .env printify-mcp
  

环境变量

在 .env 文件中，至少需要设置以下环境变量：

PRINTFUL_API_KEY=your_api_key_here
REPLICATE_API_TOKEN=your_token_here
NODE_ENV=development
PORT=3000

图片上传格式要求

Printful 支持的图片格式包括 JPG、PNG 和 GIF。图片的最大尺寸为 5000px × 5000px，文件大小不超过 20MB。

感谢您对 Printify 的支持！如果有任何问题，请随时联系我们的支持团队。