Printify MCP

🚀 Printify Project Documentation

This repository contains an MCP (Central Control Panel) server for managing products in the Printful application. The MCP allows users to create, read, update, and delete products via the API. Here are the detailed project information:

✨ Features

• Printful API Integration: Seamlessly connect with the Printful platform to create and manage products.
• Image Upload Support: Allow direct image uploads to the Printful service.
• Logging: Detailed server-side logs for easy debugging and monitoring.

🔧 Technical Details

• Language and Framework: Node.js and TypeScript
• Build Tool: Docker for containerized deployment
• Dependency Management: npm package manager

📚 Documentation of the Codebase

The project source code is located in the src folder. Here is a brief description of the key files:

Main Files

1. index.ts: The main entry point of the project, responsible for initializing and running the MCP server.
2. printify-api.ts: Implements interactions with the Printful API, including product creation, reading, updating, and deletion.
3. replicate-client.ts: A client module for handling image uploads.

Third - Party Dependencies

The project uses the following npm packages:

• @types/node: Node.js type definitions
• express: Web framework
• typescript: Static type support
• @types/express: Express type definitions
• dotenv: Environment variable management
• multer: File upload handling

🚀 Quick Start

To run this project, you need the following:

1. Install Node.js and npm: Ensure Node.js 14+ and npm 6+ are installed on your system.
2. Install Docker: For building and running containerized services.
3. Clone the Repository: Clone this repository from GitHub to your local development environment.

Steps

1. Clone the repository:

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

2. Install dependencies:

   npm install
   

3. Start the project:

   • Using Docker Compose:

     docker-compose up --build
     

   • Or run directly:

     npm run dev
     

📚 Documentation

For detailed code information, please refer to the following documentation files:

• Documentation for index.ts
• Documentation for printify-api.ts
• Documentation for replicate-client.ts

💡 Troubleshooting

Common Issues

Printful API Client Not Initialized

If you encounter the error message "Printful API client is not initialized", please check the following:

1. Confirm that the PRINTFUL_API_KEY environment variable in the .env file is correctly set.
2. Verify the validity and permissions of the API key.

Replicate Client Not Initialized

If you encounter the error message "Replicate client is not initialized", please check the following:

1. Confirm that the REPLICATE_API_TOKEN in the .env file is correctly set.
2. Verify the validity and permissions of the API token.

Error Creating Product

If an error occurs during product creation, please check the following:

1. Ensure that the blueprint ID and print provider ID used are correct and valid.
2. Check that the uploaded images meet Printful's format and size requirements.

Contact Information

If you need help or want to report an issue, please contact the project maintainers at support@printify.com.

💻 Usage Examples

Basic Usage

Here is a simple example of creating a product using this 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();

📁 Project Structure

printify-mcp/
├── src/                 # Source code folder
│   ├── index.ts         # Project entry point
│   ├── printify-api.ts  # Printful API implementation module
│   └── replicate-client.ts # Image upload handling module
├── docs/                # Documentation folder
│   ├── index.ts.md      # Detailed documentation for index.ts
│   └── ...
├── package.json        # Project dependencies and script information
├── docker-compose.yml  # Docker container configuration file
└── .env.example        # Example file for environment variables

🤝 Contribution Guidelines

If you wish to contribute to this project, please follow these steps:

1. Fork the repository: git clone https://github.com/username/printify-mcp.git
2. Create a feature branch: git checkout -b feature/new-feature
3. Commit your changes: git add . && git commit -m 'Add new feature'
4. Push to the remote repository: git push origin feature/new-feature
5. Submit a Pull Request to the main branch.

📄 License

This project uses the MIT License, as follows:

MIT License

📎 Appendix

Command - Line Tools

• Build a Docker Image:

  docker build -t printify-mcp .
  

• Run a Container:

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

Environment Variables

In the .env file, you need to set at least the following environment variables:

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

Image Upload Format Requirements

Printful supports image formats including JPG, PNG, and GIF. The maximum image size is 5000px × 5000px, and the file size should not exceed 20MB.

Thank you for your support of Printify! If you have any questions, please feel free to contact our support team.