You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: 📝 Update README.md for v2.1.0 with latest changes
- Update version to v2.1.0 in title
- Fix CLI commands (remove non-existent --http flags)
- Add MCP_MODE environment variable documentation
- Update HTTP API endpoint and request format
- Add Railway deployment environment variables instructions
- Update tool name from createPixCharge to generateStaticPix
- Add supported Pix key types with examples
- Update MCP configuration to use npx command
- Add EMV 4.0 compliance and validation features
- Add important notes about CPF validation and test data
- Fix repository URLs and remove non-existent links
- Update roadmap with completed v2.1.0 features
Copy file name to clipboardExpand all lines: README.md
+85-56Lines changed: 85 additions & 56 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Pix MCP Server
1
+
# Pix MCP Server v2.1.0
2
2
3
3
A lightweight Model Context Protocol (MCP) server that enables AI agents (Claude, Cursor, Windsurf) to generate static Pix QR codes via natural-language prompts.
4
4
@@ -11,57 +11,64 @@ A lightweight Model Context Protocol (MCP) server that enables AI agents (Claude
11
11
-**📱 QR Code generation**: Automatic QR code creation for Pix payments
12
12
-**📦 Zero Dependencies**: No external API keys or services required
13
13
-**🌍 Open & Accessible**: Works without any registration or credentials
# Start in MCP mode for Claude Desktop integration
35
+
pix-mcp
32
36
```
33
37
34
38
### HTTP Mode
35
39
36
40
```bash
37
-
# Start in HTTP mode
38
-
pix-mcp-server --http --http-port 3000
41
+
# Start in HTTP mode on port 3000
42
+
MCP_MODE=http pix-mcp
39
43
```
40
44
41
45
### Making Requests
42
46
43
47
#### HTTP API
44
48
45
49
```bash
46
-
curl -X POST http://localhost:3000/generate-static-pix \
50
+
curl -X POST http://localhost:3000/tools/call \
47
51
-H "Content-Type: application/json" \
48
52
-d '{
49
-
"pixKey": "10891990909",
50
-
"amount": 100.50,
51
-
"recipientName": "Franco Camelo Aguzzi",
52
-
"recipientCity": "Florianopolis",
53
-
"description": "Payment for services"
53
+
"name": "generateStaticPix",
54
+
"arguments": {
55
+
"pixKey": "10891990909",
56
+
"amount": 100.50,
57
+
"recipientName": "Franco Camelo Aguzzi",
58
+
"recipientCity": "Florianopolis",
59
+
"description": "Payment for services"
60
+
}
54
61
}'
55
62
```
56
63
57
64
#### MCP Tool
58
65
59
66
```typescript
60
67
const result =awaitmcpClient.callTool('generateStaticPix', {
61
-
pixKey: "10891990909",
62
-
amount: 100.50,
63
-
recipientName: "Franco Camelo Aguzzi",
64
-
recipientCity": "Florianopolis",
68
+
pixKey: '10891990909',
69
+
amount: 100.5,
70
+
recipientName: 'Franco Camelo Aguzzi',
71
+
recipientCity: 'Florianopolis',
65
72
description: 'Payment for services',
66
73
});
67
74
```
@@ -72,6 +79,11 @@ const result = await mcpClient.callTool('generateStaticPix', {
72
79
73
80
[](https://railway.app/new/template?template=https%3A%2F%2Fgithub.com%2FRegenerating-World%2Fpix-mcp)
74
81
82
+
**⚠️ Important:** After deploying to Railway, add these environment variables in the Railway dashboard:
0 commit comments