Skip to main content
Glama
Vaultix MCP Server

Vaultix MCP Server

Vaultix MCP Server

Model Context Protocol (MCP) server for the Vaultix Payment API. Allows Claude to interact directly with your Vaultix account.

Installation

Option 1: Install from GitHub

npm install -g github:VautlixDevelopment/mcpVaultix

Option 2: Clone and build locally

git clone https://github.com/VautlixDevelopment/mcpVaultix.git
cd mcpVaultix
npm install
npm run build

Configuration

1. Get your API Key

Get your API key from the Vaultix Dashboard.

2. Configure Claude Code

Add to your Claude Code MCP settings (~/.claude/claude_desktop_config.json):

{
  "mcpServers": {
    "vaultix": {
      "command": "npx",
      "args": ["-y", "github:VautlixDevelopment/mcpVaultix"],
      "env": {
        "VAULTIX_API_KEY": "sk_live_your_key_here"
      }
    }
  }
}

Or if installed locally:

{
  "mcpServers": {
    "vaultix": {
      "command": "node",
      "args": ["/path/to/mcpVaultix/dist/index.js"],
      "env": {
        "VAULTIX_API_KEY": "sk_live_your_key_here"
      }
    }
  }
}

3. Restart Claude Code

After saving the configuration, restart Claude Code to load the MCP server.

Available Tools

Charges (Cobranças)

Tool

Description

vaultix_create_charge

Create a new charge (PIX, Card, Boleto)

vaultix_get_charge

Get a charge by ID

vaultix_list_charges

List all charges

vaultix_cancel_charge

Cancel a pending charge

Customers (Clientes)

Tool

Description

vaultix_create_customer

Create a new customer

vaultix_get_customer

Get a customer by ID

vaultix_list_customers

List all customers

vaultix_update_customer

Update a customer

vaultix_delete_customer

Delete a customer

Refunds (Reembolsos)

Tool

Description

vaultix_create_refund

Create a refund for a charge

vaultix_get_refund

Get a refund by ID

vaultix_list_refunds

List all refunds

Balance (Saldo)

Tool

Description

vaultix_get_balance

Get current balance

vaultix_list_balance_transactions

List balance transactions

Products (Produtos)

Tool

Description

vaultix_create_product

Create a product

vaultix_get_product

Get a product by ID

vaultix_list_products

List all products

vaultix_update_product

Update a product

vaultix_delete_product

Delete a product

Orders (Pedidos)

Tool

Description

vaultix_get_order

Get an order by ID

vaultix_list_orders

List all orders

Transactions (Transações)

Tool

Description

vaultix_get_transaction

Get a transaction by ID

vaultix_list_transactions

List all transactions

vaultix_get_transactions_summary

Get transaction summary

Tool

Description

vaultix_create_payment_link

Create a payment link

vaultix_get_payment_link

Get a payment link by ID

vaultix_list_payment_links

List all payment links

vaultix_deactivate_payment_link

Deactivate a payment link

Payouts (Saques)

Tool

Description

vaultix_create_payout

Create a payout (PIX or bank transfer)

vaultix_get_payout

Get a payout by ID

vaultix_list_payouts

List all payouts

vaultix_cancel_payout

Cancel a pending payout

Usage Examples

Once configured, you can ask Claude:

"Create a PIX charge for R$ 50,00 for customer João Silva (joao@email.com)"

"List all paid charges from this month"

"Create a payment link for R$ 100,00"

"What's my current balance?"

"Show me the transaction summary for the last 7 days"

Environment Variables

Variable

Description

VAULTIX_API_KEY

Your Vaultix secret API key (sk_live_... or sk_test_...)

API Documentation

For more information about the Vaultix API, visit:

Support

License

MIT

Available Tools

32 tools
vaultix_cancel_chargeC

Cancel a pending or authorized charge

Inputs: id (required).

vaultix_cancel_payoutB

Cancel a pending payout

Inputs: id (required).

vaultix_create_chargeC

Create a new payment charge (PIX, Credit Card, or Boleto). Amount is in cents (e.g., 5000 = R$ 50,00)

Inputs: amount (required), payment_method (required), customer_name (required), customer_email (required), +2 more.

vaultix_create_customerC

Create a new customer

Inputs: name (required), email, document, phone.

vaultix_create_payoutC

Create a payout (withdrawal) via PIX or bank transfer. Amount in cents.

Inputs: amount (required), pix_key, bank_code, branch, +5 more.

vaultix_create_productC

Create a new product in the catalog. Price is in cents.

Inputs: name (required), price (required), description, stock_quantity, +1 more.

vaultix_create_refundC

Create a refund for a paid charge. Amount in cents for partial refund.

Inputs: charge (required), amount, reason.

vaultix_delete_customerC

Delete a customer

Inputs: id (required).

vaultix_delete_productB

Delete a product

Inputs: id (required).

vaultix_get_balanceB

Get current account balance (available and pending)

Inputs: no named parameters.

vaultix_get_chargeC

Retrieve a charge by ID

Inputs: id (required).

vaultix_get_customerC

Retrieve a customer by ID

Inputs: id (required).

vaultix_get_orderC

Retrieve an order by ID

Inputs: id (required), expand.

vaultix_get_payoutC

Retrieve a payout by ID

Inputs: id (required).

vaultix_get_productC

Retrieve a product by ID

Inputs: id (required).

vaultix_get_refundC

Retrieve a refund by ID

Inputs: id (required).

vaultix_get_transactionC

Retrieve a transaction by ID

Inputs: id (required).

vaultix_get_transactions_summaryC

Get transaction summary for a period

Inputs: period.

vaultix_list_balance_transactionsC

List balance transactions (statement)

Inputs: limit, type.

vaultix_list_chargesC

List all charges with optional filters

Inputs: limit, status, payment_method.

vaultix_list_customersC

List all customers

Inputs: limit, email.

vaultix_list_ordersC

List all orders

Inputs: limit, status, payment_status.

vaultix_list_payoutsC

List all payouts

Inputs: limit, status.

vaultix_list_productsC

List all products

Inputs: limit, status, search.

vaultix_list_refundsC

List all refunds

Inputs: limit, charge.

vaultix_list_transactionsC

List all transactions (unified view of charges, refunds, payouts)

Inputs: limit, type, source.

vaultix_update_customerC

Update a customer

Inputs: id (required), name, email, phone.

vaultix_update_productC

Update a product

Inputs: id (required), name, price, stock_quantity.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    B3.2/5.0

    Scored across 32 tools

    Disambiguation5/5

    Every tool has a clearly distinct purpose targeting specific resources and actions with no overlap. For example, create_charge, get_charge, and list_charges are clearly differentiated by operation type, and tools like get_balance vs list_balance_transactions serve different functions. The descriptions reinforce this clarity, making misselection unlikely.

    Naming Consistency5/5

    All tools follow a perfectly consistent verb_noun pattern with the 'vaultix_' prefix (e.g., vaultix_create_charge, vaultix_get_customer, vaultix_list_products). The verbs (create, get, list, update, delete, cancel, deactivate) are used predictably across resources, and snake_case is applied uniformly throughout the set.

    Tool Count3/5

    With 32 tools, the count is borderline high for a payment processing server, potentially feeling heavy but not extreme. It covers multiple resources (charges, customers, products, etc.) with full CRUD operations, which justifies some bulk, but it approaches the upper limit of what might be considered well-scoped without being overwhelming.

    Completeness5/5

    The tool set provides complete CRUD/lifecycle coverage for the payment processing domain, including charges, customers, products, payouts, refunds, and payment links. It supports all essential operations (create, retrieve, update, delete, list) and includes specialized actions like canceling and deactivating, with no obvious gaps that would hinder agent workflows.

    Related MCP Connectors