Fastmcp Qikink
No description available
Ask AI about Fastmcp Qikink
Powered by Claude Β· Grounded in docs
I know everything about Fastmcp Qikink. Ask me about installation, configuration, usage, or troubleshooting.
0/500
Reviews
Documentation
Qikink MCP Server
A comprehensive Model Context Protocol (MCP) server implementation for Qikink's Print-on-Demand API using FastMCP. This server provides a robust interface for managing print-on-demand orders, real-time status updates, and seamless integration with Qikink's services.
π Features
- Complete API Integration: Full support for Qikink's Print-on-Demand API
- Real-time Updates: Server-Sent Events (SSE) for order status and count updates
- Robust Error Handling: Comprehensive error management with retries and rate limiting
- Type Safety: Full Pydantic model validation for requests and responses
- Async Support: Built with modern async/await patterns
- Developer Friendly: Detailed logging and debugging capabilities
π οΈ Implemented Tools
-
Authentication Tool (
qikink_authenticate)- Secure token management
- Automatic token refresh
- Client credential support
-
Order Management
- Create Order (
qikink_create_order) - Retrieve Orders (
qikink_get_orders) - Single Order Details (
qikink_get_single_order) - Order Count (
qikink_get_orders_count)
- Create Order (
-
System Health
- Health Check (
qikink_health_check) - Environment Information
- API Status Monitoring
- Health Check (
π Requirements
- Python 3.12+
- FastMCP
- Pydantic v2
- HTTPX
- Additional dependencies in
requirements.txt
π§ Installation
-
Clone the repository:
git clone https://github.com/yourusername/fastmcp-qikink.git cd fastmcp-qikink -
Create and activate a virtual environment:
python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate -
Install dependencies:
pip install -r requirements.txt -
Set up environment variables:
cp env.example .env # Edit .env with your Qikink API credentials
π Usage
-
Start the server:
python qikink_mcp_server.py -
The server supports multiple transport modes:
- SSE (Server-Sent Events):
python qikink_mcp_server.py sse - Streamable HTTP:
python qikink_mcp_server.py streamable-http - STDIO (default):
python qikink_mcp_server.py
- SSE (Server-Sent Events):
Example: Creating an Order
# Using the MCP client
response = await client.call_tool("qikink_create_order", {
"order_number": "ORD123456",
"qikink_shipping": True,
"gateway": "COD",
"total_order_value": 99.99,
"line_items": [{
"product_id": "TSHIRT-BLK-L",
"quantity": 2
}],
"shipping_address": {
"name": "John Doe",
"address_line1": "123 Main St",
"city": "New York",
"postal_code": "10001",
"country": "US",
"phone": "1234567890",
"email": "john@example.com"
}
})
π API Documentation
Detailed API documentation is available through the qikink://docs/api resource endpoint. It provides:
- Tool descriptions and parameters
- Example requests and responses
- Error handling guidelines
- Best practices
π€ Contributing
We welcome contributions! Here's how you can help:
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Please ensure your PR:
- Follows the existing code style
- Includes appropriate tests
- Updates documentation as needed
- Describes the changes made
π License
This project is licensed under the MIT License - see the LICENSE file for details.
π Special Thanks
Special thanks to Cursor AI for their invaluable assistance in developing this project. The AI-powered coding environment significantly enhanced the development process and helped create more robust and maintainable code.
π Support
For support, please:
- Check the Issues page
- Create a new issue if needed
- Join our Discord community
π Project Status
This project is actively maintained and welcomes community contributions. Check the Projects page for planned features and improvements.
