官方说明Pix MCP Server v2.1.0 A lightweight Model Context Protocol (MCP) server that enables AI agents (Claude, Cursor, Windsurf) to generate static Pix QR codes via natural-language prompts.
A lightweight Model Context Protocol (MCP) server that enables AI agents (Claude, Cursor, Windsurf) to generate static Pix QR codes via natural-language prompts. 🚀 Features - **🔧 MCP Tool**: - generateStaticPix - Generate static Pix QR codes for any Pix key (no API required) - **🚀 Production-ready**: Comprehensive error handling and logging - **🔒 Type-safe**: Full TypeScript implementation with Zod validation - **📱 QR Code generation**: Automatic QR code creation for Pix payments - **📦 Zero Dependencies**: No external API keys or services required - **🌍 Open & Accessible**: Works without any registration or credentials - **✅ EMV 4.0 Compliant**: Follows BACEN PIX standards with proper CRC16-CCITT validation 🚀 Quick Start 🔧 Usage MCP Mode (Default) HTTP Mode Making Requests HTTP API MCP Tool 🚀 Deployment Railway **⚠️ Important:** After deploying to Railway, add these environment variables in the Railway dashboard: - MCP_MODE=http - NODE_ENV=production (optional) Manual Deployment 📝 License MIT 🔧 Configuration Environment Variables - MCP_MODE: Server mode (stdio for MCP, http for HTTP API) - Default: stdio - NODE_ENV: Environment (development/production) - Default: development - PORT: HTTP port when in HTTP mode - Default: 3000 🤖 Usage with AI Tools Claude Desktop 1. Install the package globally: 2. Add to your Claude Desktop MCP configuration (~/Library/Application Support/Claude/claude_desktop_config.json on macOS or %APPDATA%/Claude/claude_desktop_config.json on Windows): 3. Restart Claude Desktop and start using: Cursor (with MCP support) Add to your Cursor MCP settings: Windsurf (with MCP support) Configure in Windsurf MCP settings: Any MCP-compatible tool Your tool should support MCP servers. Configure using: - **Command**: npx pix-mcp or pix-mcp (if installed globally) - **Protocol**: stdio - **Environment**: MCP_MODE=stdio 🔨 Available Tools generateStaticPix Creates a static Pix payment QR code following BACEN EMV 4.0 standards. **Parameters:** - pixKey (string): Valid Pix key (email, phone, CPF, CNPJ, or random key) - amount (number): Payment amount in BRL (0.01 to 999,999.99) - recipientName (string): Name of the payment recipient (max 25 chars) - recipientCity (string): City of the payment recipient (max 15 chars) **Returns:** - Payment details (amount, recipient, city) - Pix copy-paste code (EMV format) - QR code image (base64 data URL) - Success status and message **Supported Pix Key Types:** - 📧 Email: example@email.com - 📱 Phone: +5511999999999 - 👤 CPF: 12345678901 (11 digits) - 🏢 CNPJ: 12345678000195 (14 digits) - 🔑 Random Key: 123e4567-e89b-12d3-a456-426614174000 (UUID format) 🏗️ Development 🗺️ Roadmap Phase 1: MVP ✅ - [x] generateStaticPix tool - [x] Static Pix QR code generation - [x] QR code generation - [x] Claude Desktop compatibility - [x] EMV 4.0 compliance - [x] CRC16-CCITT validation - [x] All Pix key types support - [x] Public deployment