feat: ✨ remove description field to improve bank compatibility

- Remove description field from all PIX interfaces and schemas
- Eliminate field 62 (Additional Data) from EMV payload generation
- Update all tests to reflect simplified PIX structure
- Update README examples to remove description usage
- Reduces PIX code size from 155+ to 129 characters
- Improves bank acceptance by removing potential rejection source

BREAKING CHANGE: description parameter no longer supported in generateStaticPix

Author: faguzzi3-boop

README.md

@@ -55,8 +55,7 @@ curl -X POST http://localhost:3000/tools/call \
       "pixKey": "10891990909",
       "amount": 100.50,
       "recipientName": "Franco Camelo Aguzzi",
-      "recipientCity": "Florianopolis",
-      "description": "Payment for services"
+      "recipientCity": "Florianopolis"
     }
   }'
 ```
@@ -69,7 +68,6 @@ const result = await mcpClient.callTool('generateStaticPix', {
   amount: 100.5,
   recipientName: 'Franco Camelo Aguzzi',
   recipientCity: 'Florianopolis',
-  description: 'Payment for services',
 });
 ```
 
@@ -150,11 +148,10 @@ Creates a static Pix payment QR code following BACEN EMV 4.0 standards.
 - `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)
-- `description` (string, optional): Payment description (max 25 chars)
 
 **Returns:**
 
-- Payment details (amount, recipient, city, description)
+- Payment details (amount, recipient, city)
 - Pix copy-paste code (EMV format)
 - QR code image (base64 data URL)
 - Success status and message
@@ -197,17 +194,11 @@ npm run format
 - [x] EMV 4.0 compliance
 - [x] CRC16-CCITT validation
 - [x] All Pix key types support
+- [x] Public deployment
 
 ### Phase 2: MCP Discovery
 
 - [ ] Register with MCP registry
-- [ ] Public deployment
-
-### Phase 3: Tool Expansion
-
-- [ ] Dynamic Pix codes (with expiration)
-- [ ] Payment status checking
-- [ ] Webhook support for payment notifications
 
 ## 🔒 Security & Validation
 

src/index.ts

@@ -5,10 +5,7 @@ import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'
 import type { Tool } from '@modelcontextprotocol/sdk/types.js';
 import http from 'http';
 import { URL } from 'url';
-import {
-  CallToolRequestSchema,
-  ListToolsRequestSchema,
-} from '@modelcontextprotocol/sdk/types.js';
+import { CallToolRequestSchema, ListToolsRequestSchema } from '@modelcontextprotocol/sdk/types.js';
 import { z } from 'zod';
 import { StaticPixService } from './services/StaticPixService.js';
 
@@ -18,7 +15,6 @@ const GenerateStaticPixSchema = z.object({
   amount: z.number().positive().max(999999.99),
   recipientName: z.string().min(1).max(25),
   recipientCity: z.string().min(1).max(15),
-  description: z.string().optional().default(''),
 });
 
 class PixMCPServer {
@@ -53,7 +49,8 @@ class PixMCPServer {
         tools: [
           {
             name: 'generateStaticPix',
-            description: 'Generate a static Pix QR code for any Pix key (works without API credentials)',
+            description:
+              'Generate a static Pix QR code for any Pix key (works without API credentials)',
             inputSchema: {
               type: 'object',
               properties: {
@@ -81,11 +78,6 @@ class PixMCPServer {
                   minLength: 1,
                   maxLength: 15,
                 },
-                description: {
-                  type: 'string',
-                  description: 'Optional payment description',
-                  maxLength: 25,
-                },
               },
               required: ['pixKey', 'amount', 'recipientName', 'recipientCity'],
             },
@@ -112,7 +104,7 @@ class PixMCPServer {
           case 'generateStaticPix': {
             const validatedArgs = GenerateStaticPixSchema.parse(args);
             const result = await this.staticPixService.createStaticPix(validatedArgs);
-            
+
             return {
               content: [
                 {
@@ -122,7 +114,6 @@ class PixMCPServer {
 **Payment Details:**
 - Amount: R$ ${result.paymentDetails.amountFormatted}
 - Recipient: ${result.paymentDetails.recipient}
-- Description: ${result.paymentDetails.description || 'N/A'}
 - PIX Key: ${result.paymentDetails.pixKey}
 - City: ${result.paymentDetails.city}
 
@@ -132,9 +123,9 @@ class PixMCPServer {
 **QR Code:**
 ${result.qrCodeDataUrl ? `![QR Code](${result.qrCodeDataUrl})` : 'QR Code generation failed'}
 
-⚠️ **Note**: This is a static Pix code. Payment confirmation must be checked manually by the recipient.`
-                }
-              ]
+⚠️ **Note**: This is a static Pix code. Payment confirmation must be checked manually by the recipient.`,
+                },
+              ],
             };
           }
 
@@ -144,17 +135,17 @@ ${result.qrCodeDataUrl ? `![QR Code](${result.qrCodeDataUrl})` : 'QR Code genera
               timestamp: new Date().toISOString(),
               version: '2.0.0',
               mode: 'static-pix',
-              status: 'operational'
+              status: 'operational',
             };
-            
+
             return {
               content: [
                 {
                   type: 'text',
-                  text: `✅ Server is healthy\nVersion: ${status.version}\nMode: ${status.mode}\nStatus: ${status.status}`
-                }
+                  text: `✅ Server is healthy\nVersion: ${status.version}\nMode: ${status.mode}\nStatus: ${status.status}`,
+                },
               ],
-              status
+              status,
             };
           }
 
@@ -182,23 +173,25 @@ ${result.qrCodeDataUrl ? `![QR Code](${result.qrCodeDataUrl})` : 'QR Code genera
       res.setHeader('Access-Control-Allow-Origin', '*');
       res.setHeader('Access-Control-Allow-Methods', 'GET, POST, OPTIONS');
       res.setHeader('Access-Control-Allow-Headers', 'Content-Type, Authorization');
-      
+
       if (req.method === 'OPTIONS') {
         res.writeHead(200);
         res.end();
         return;
       }
 
       const url = new URL(req.url!, `http://${req.headers.host}`);
-      
+
       if (url.pathname === '/health') {
         res.writeHead(200, { 'Content-Type': 'application/json' });
-        res.end(JSON.stringify({ 
-          status: 'healthy', 
-          service: 'pix-mcp-server',
-          version: '1.0.0',
-          timestamp: new Date().toISOString()
-        }));
+        res.end(
+          JSON.stringify({
+            status: 'healthy',
+            service: 'pix-mcp-server',
+            version: '1.0.0',
+            timestamp: new Date().toISOString(),
+          })
+        );
         return;
       }
 
@@ -223,18 +216,14 @@ ${result.qrCodeDataUrl ? `![QR Code](${result.qrCodeDataUrl})` : 'QR Code genera
                     minLength: 1,
                     maxLength: 100,
                   },
-                  description: {
-                    type: 'string',
-                    description: 'Optional payment description',
-                    maxLength: 200,
-                  },
                 },
                 required: ['amount', 'recipientName'],
               },
             },
             {
               name: 'generateStaticPix',
-              description: 'Generate a static Pix QR code for any Pix key (works without API credentials)',
+              description:
+                'Generate a static Pix QR code for any Pix key (works without API credentials)',
               inputSchema: {
                 type: 'object',
                 properties: {
@@ -262,11 +251,6 @@ ${result.qrCodeDataUrl ? `![QR Code](${result.qrCodeDataUrl})` : 'QR Code genera
                     minLength: 1,
                     maxLength: 15,
                   },
-                  description: {
-                    type: 'string',
-                    description: 'Optional payment description',
-                    maxLength: 25,
-                  },
                 },
                 required: ['pixKey', 'amount', 'recipientName', 'recipientCity'],
               },
@@ -289,37 +273,38 @@ ${result.qrCodeDataUrl ? `![QR Code](${result.qrCodeDataUrl})` : 'QR Code genera
 
       if (url.pathname === '/tools/call' && req.method === 'POST') {
         let body = '';
-        req.on('data', chunk => body += chunk);
+        req.on('data', (chunk) => (body += chunk));
         req.on('end', async () => {
           try {
             const { name, arguments: args } = JSON.parse(body);
-            
+
             // Handle tool calls directly
             if (name === 'generateStaticPix') {
               const validatedArgs = GenerateStaticPixSchema.parse(args);
               const result = await this.staticPixService.createStaticPix(validatedArgs);
-              
+
               const response = {
-                content: [{
-                  type: 'text',
-                  text: `✅ Static Pix QR code generated successfully!
+                content: [
+                  {
+                    type: 'text',
+                    text: `✅ Static Pix QR code generated successfully!
 
 **Payment Details:**
 - Amount: ${result.paymentDetails.amountFormatted}
 - Recipient: ${result.paymentDetails.recipient}
 - City: ${result.paymentDetails.city}
-- Description: ${result.paymentDetails.description || 'N/A'}
 
 **Pix Code (copy and paste):**
 \`${result.pixCode}\`
 
 **QR Code:**
 ${result.qrCodeDataUrl ? `![QR Code](${result.qrCodeDataUrl})` : 'QR Code generation failed'}
 
-⚠️ **Note**: This is a static Pix code. Payment confirmation must be checked manually by the recipient.`
-                }]
+⚠️ **Note**: This is a static Pix code. Payment confirmation must be checked manually by the recipient.`,
+                  },
+                ],
               };
-              
+
               res.writeHead(200, { 'Content-Type': 'application/json' });
               res.end(JSON.stringify(response));
             } else if (name === 'healthCheck') {
@@ -328,23 +313,25 @@ ${result.qrCodeDataUrl ? `![QR Code](${result.qrCodeDataUrl})` : 'QR Code genera
                 timestamp: new Date().toISOString(),
                 version: '2.0.0',
                 mode: 'static-pix',
-                status: 'operational'
+                status: 'operational',
               };
-              
+
               const response = {
-                content: [{
-                  type: 'text',
-                  text: `🟢 **Pix MCP Server Health Check**
+                content: [
+                  {
+                    type: 'text',
+                    text: `🟢 **Pix MCP Server Health Check**
 
 **Status:** ${status.server}
 **Version:** ${status.version}
 **Mode:** ${status.mode}
 **Timestamp:** ${status.timestamp}
 
-✅ All systems operational`
-                }]
+✅ All systems operational`,
+                  },
+                ],
               };
-              
+
               res.writeHead(200, { 'Content-Type': 'application/json' });
               res.end(JSON.stringify(response));
             } else {
@@ -353,10 +340,12 @@ ${result.qrCodeDataUrl ? `![QR Code](${result.qrCodeDataUrl})` : 'QR Code genera
           } catch (error) {
             const errorMessage = error instanceof Error ? error.message : 'Unknown error occurred';
             const response = {
-              content: [{
-                type: 'text',
-                text: `❌ Error: ${errorMessage}`,
-              }],
+              content: [
+                {
+                  type: 'text',
+                  text: `❌ Error: ${errorMessage}`,
+                },
+              ],
               isError: true,
             };
             res.writeHead(400, { 'Content-Type': 'application/json' });

src/services/PixService.ts

@@ -1,4 +1,9 @@
-import { PixChargeRequest, PixChargeResponse, StaticPixRequest, StaticPixResponse } from '../types/PixTypes.js';
+import {
+  PixChargeRequest,
+  PixChargeResponse,
+  StaticPixRequest,
+  StaticPixResponse,
+} from '../types/PixTypes.js';
 import { StaticPixService } from './StaticPixService.js';
 
 export class PixService {
@@ -27,21 +32,21 @@ export class PixService {
         amount: request.amount,
         recipientName: request.recipientName,
         recipientCity: request.recipientCity,
-        description: request.description || ''
       });
 
       return {
         txid: `static-${Date.now()}`,
         amount: result.paymentDetails.amount,
         recipientName: result.paymentDetails.recipient,
-        description: result.paymentDetails.description,
         pixCode: result.pixCode,
         qrCodeDataUrl: result.qrCodeDataUrl,
         expiresAt: new Date(Date.now() + 30 * 24 * 60 * 60 * 1000), // 30 days from now
-        provider: 'static-pix'
+        provider: 'static-pix',
       };
     } catch (error) {
-      throw new Error(`Failed to create static Pix: ${error instanceof Error ? error.message : 'Unknown error'}`);
+      throw new Error(
+        `Failed to create static Pix: ${error instanceof Error ? error.message : 'Unknown error'}`
+      );
     }
   }