Zip Model Context Protocol

The Zip Model Context Protocol server allows you to integrate with Zip APIs through function calling. This protocol supports various tools to interact with different Zip Payment Services.

Quick Start

Run the MCP server using npx:

# All available tools
npx -y @zipph/mcp --tools=all --secret-key=YOUR_ZIP_SECRET_KEY

# Specific tools only
npx -y @zipph/mcp --tools=customers.create,charges.create --secret-key=YOUR_ZIP_SECRET_KEY

Claude Desktop Integration

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "zip": {
      "command": "npx",
      "args": ["-y", "@zipph/mcp", "--tools=all", "--secret-key=ZIP_SECRET_KEY"]
    }
  }
}

Available Tools

| Category | Tool | Description | | ------------------- | ------------------------- | ------------------------------------- | | Customers | customers.create | Create a customer | | | customers.read | Retrieve customer data | | | customers.update | Update customer information | | Payment Sources | sources.create | Create a payment source | | | sources.read | Retrieve payment source | | | sources.update | Attach/detach customer payment source | | Charges | charges.create | Create a charge | | | charges.create | Initiate bank login | | | charges.read | Retrieve charge information | | | charges.update | Void, capture, or verify a charge | | Refunds | refunds.create | Refund a charge | | Checkout | checkoutSessions.create | Create checkout session | | | checkoutSessions.read | Retrieve checkout session | | | checkoutSessions.update | Expire or capture a checkout session | | Invoices | paymentRequests.create | Create invoice | | | paymentRequests.read | Retrieve invoice | | | paymentRequests.update | Void or resend invoice | | Payment Links | paymentLinks.create | Create payment link | | | paymentLinks.read | Retrieve payment link | | | paymentLinks.read | Retrieve payment link transactions | | | paymentLinks.update | Activate or deactivate payment link |

Debugging

Use the MCP Inspector to debug your server:

# Build the server
npm run build

# Start MCP Inspector with server
npx @modelcontextprotocol/inspector node dist/index.js --tools=all --secret-key=YOUR_ZIP_SECRET_KEY

1. Launch the Inspector UI in your browser
2. Click Connect to start the MCP server
3. View and test available tools individually