Vaultix MCP Server

vaultix_create_customer

Create a new customer record in the Vaultix payment system by providing name, email, document, and phone details to enable payment processing.

Instructions

Create a new customer

Input Schema

TableJSON Schema

Name	Required	Description
`name`	Yes	Customer name
`email`	No	Customer email
`document`	No	CPF/CNPJ
`phone`	No	Phone number

Implementation Reference

src/tools/index.ts:456-462 (handler)
The switch case handler for 'vaultix_create_customer' that creates a new customer by posting customer data to the '/customers' API endpoint using the VaultixClient.
```
case 'vaultix_create_customer':
  return client.post('/customers', {
    name: args.name,
    email: args.email,
    document: args.document,
    phone: args.phone,
  })
```

src/tools/index.ts:68-81 (schema)

The tool definition and input schema for 'vaultix_create_customer', specifying the expected input parameters and their types.

{
  name: 'vaultix_create_customer',
  description: 'Create a new customer',
  inputSchema: {
    type: 'object',
    properties: {
      name: { type: 'string', description: 'Customer name' },
      email: { type: 'string', description: 'Customer email' },
      document: { type: 'string', description: 'CPF/CNPJ' },
      phone: { type: 'string', description: 'Phone number' },
    },
    required: ['name'],
  },
},

src/tools/index.ts:14-417 (registration)

The exported 'tools' array where 'vaultix_create_customer' is registered as part of the MCP tools list.

export const tools: Tool[] = [
  // ==================== CHARGES ====================
  {
    name: 'vaultix_create_charge',
    description: 'Create a new payment charge (PIX, Credit Card, or Boleto). Amount is in cents (e.g., 5000 = R$ 50,00)',
    inputSchema: {
      type: 'object',
      properties: {
        amount: { type: 'number', description: 'Amount in cents (minimum 100 = R$ 1,00)' },
        payment_method: { type: 'string', enum: ['pix', 'credit_card', 'boleto'], description: 'Payment method' },
        customer_name: { type: 'string', description: 'Customer name' },
        customer_email: { type: 'string', description: 'Customer email' },
        customer_document: { type: 'string', description: 'Customer CPF/CNPJ' },
        description: { type: 'string', description: 'Charge description' },
      },
      required: ['amount', 'payment_method', 'customer_name', 'customer_email'],
    },
  },
  {
    name: 'vaultix_get_charge',
    description: 'Retrieve a charge by ID',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Charge ID (ch_...)' },
      },
      required: ['id'],
    },
  },
  {
    name: 'vaultix_list_charges',
    description: 'List all charges with optional filters',
    inputSchema: {
      type: 'object',
      properties: {
        limit: { type: 'number', description: 'Maximum results (1-100)' },
        status: { type: 'string', enum: ['pending', 'paid', 'failed', 'canceled', 'refunded'], description: 'Filter by status' },
        payment_method: { type: 'string', enum: ['pix', 'credit_card', 'boleto'], description: 'Filter by payment method' },
      },
    },
  },
  {
    name: 'vaultix_cancel_charge',
    description: 'Cancel a pending or authorized charge',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Charge ID to cancel' },
      },
      required: ['id'],
    },
  },

  // ==================== CUSTOMERS ====================
  {
    name: 'vaultix_create_customer',
    description: 'Create a new customer',
    inputSchema: {
      type: 'object',
      properties: {
        name: { type: 'string', description: 'Customer name' },
        email: { type: 'string', description: 'Customer email' },
        document: { type: 'string', description: 'CPF/CNPJ' },
        phone: { type: 'string', description: 'Phone number' },
      },
      required: ['name'],
    },
  },
  {
    name: 'vaultix_get_customer',
    description: 'Retrieve a customer by ID',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Customer ID (cus_...)' },
      },
      required: ['id'],
    },
  },
  {
    name: 'vaultix_list_customers',
    description: 'List all customers',
    inputSchema: {
      type: 'object',
      properties: {
        limit: { type: 'number', description: 'Maximum results (1-100)' },
        email: { type: 'string', description: 'Filter by email' },
      },
    },
  },
  {
    name: 'vaultix_update_customer',
    description: 'Update a customer',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Customer ID' },
        name: { type: 'string', description: 'New name' },
        email: { type: 'string', description: 'New email' },
        phone: { type: 'string', description: 'New phone' },
      },
      required: ['id'],
    },
  },
  {
    name: 'vaultix_delete_customer',
    description: 'Delete a customer',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Customer ID to delete' },
      },
      required: ['id'],
    },
  },

  // ==================== REFUNDS ====================
  {
    name: 'vaultix_create_refund',
    description: 'Create a refund for a paid charge. Amount in cents for partial refund.',
    inputSchema: {
      type: 'object',
      properties: {
        charge: { type: 'string', description: 'Charge ID to refund' },
        amount: { type: 'number', description: 'Amount in cents (optional, for partial refund)' },
        reason: { type: 'string', description: 'Reason for refund' },
      },
      required: ['charge'],
    },
  },
  {
    name: 'vaultix_get_refund',
    description: 'Retrieve a refund by ID',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Refund ID (re_...)' },
      },
      required: ['id'],
    },
  },
  {
    name: 'vaultix_list_refunds',
    description: 'List all refunds',
    inputSchema: {
      type: 'object',
      properties: {
        limit: { type: 'number', description: 'Maximum results (1-100)' },
        charge: { type: 'string', description: 'Filter by charge ID' },
      },
    },
  },

  // ==================== BALANCE ====================
  {
    name: 'vaultix_get_balance',
    description: 'Get current account balance (available and pending)',
    inputSchema: {
      type: 'object',
      properties: {},
    },
  },
  {
    name: 'vaultix_list_balance_transactions',
    description: 'List balance transactions (statement)',
    inputSchema: {
      type: 'object',
      properties: {
        limit: { type: 'number', description: 'Maximum results (1-100)' },
        type: { type: 'string', enum: ['charge', 'refund'], description: 'Filter by type' },
      },
    },
  },

  // ==================== PRODUCTS ====================
  {
    name: 'vaultix_create_product',
    description: 'Create a new product in the catalog. Price is in cents.',
    inputSchema: {
      type: 'object',
      properties: {
        name: { type: 'string', description: 'Product name' },
        price: { type: 'number', description: 'Price in cents' },
        description: { type: 'string', description: 'Product description' },
        stock_quantity: { type: 'number', description: 'Stock quantity' },
        sku: { type: 'string', description: 'SKU code' },
      },
      required: ['name', 'price'],
    },
  },
  {
    name: 'vaultix_get_product',
    description: 'Retrieve a product by ID',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Product ID (prod_...)' },
      },
      required: ['id'],
    },
  },
  {
    name: 'vaultix_list_products',
    description: 'List all products',
    inputSchema: {
      type: 'object',
      properties: {
        limit: { type: 'number', description: 'Maximum results (1-100)' },
        status: { type: 'string', enum: ['active', 'draft', 'archived'], description: 'Filter by status' },
        search: { type: 'string', description: 'Search by name or SKU' },
      },
    },
  },
  {
    name: 'vaultix_update_product',
    description: 'Update a product',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Product ID' },
        name: { type: 'string', description: 'New name' },
        price: { type: 'number', description: 'New price in cents' },
        stock_quantity: { type: 'number', description: 'New stock quantity' },
      },
      required: ['id'],
    },
  },
  {
    name: 'vaultix_delete_product',
    description: 'Delete a product',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Product ID to delete' },
      },
      required: ['id'],
    },
  },

  // ==================== ORDERS ====================
  {
    name: 'vaultix_get_order',
    description: 'Retrieve an order by ID',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Order ID' },
        expand: { type: 'string', enum: ['items'], description: 'Expand items' },
      },
      required: ['id'],
    },
  },
  {
    name: 'vaultix_list_orders',
    description: 'List all orders',
    inputSchema: {
      type: 'object',
      properties: {
        limit: { type: 'number', description: 'Maximum results (1-100)' },
        status: { type: 'string', enum: ['pending', 'processing', 'completed', 'canceled'], description: 'Filter by status' },
        payment_status: { type: 'string', enum: ['pending', 'paid', 'failed'], description: 'Filter by payment status' },
      },
    },
  },

  // ==================== TRANSACTIONS ====================
  {
    name: 'vaultix_get_transaction',
    description: 'Retrieve a transaction by ID',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Transaction ID' },
      },
      required: ['id'],
    },
  },
  {
    name: 'vaultix_list_transactions',
    description: 'List all transactions (unified view of charges, refunds, payouts)',
    inputSchema: {
      type: 'object',
      properties: {
        limit: { type: 'number', description: 'Maximum results (1-100)' },
        type: { type: 'string', enum: ['charge', 'refund', 'payout'], description: 'Filter by type' },
        source: { type: 'string', enum: ['charge', 'refund', 'payout'], description: 'Filter by source' },
      },
    },
  },
  {
    name: 'vaultix_get_transactions_summary',
    description: 'Get transaction summary for a period',
    inputSchema: {
      type: 'object',
      properties: {
        period: { type: 'string', enum: ['24h', '7d', '30d', '90d'], description: 'Period for summary (default: 30d)' },
      },
    },
  },

  // ==================== PAYMENT LINKS ====================
  {
    name: 'vaultix_create_payment_link',
    description: 'Create a shareable payment link. Amount in cents.',
    inputSchema: {
      type: 'object',
      properties: {
        amount: { type: 'number', description: 'Amount in cents (minimum 100)' },
        description: { type: 'string', description: 'Link description' },
        payment_methods: { type: 'array', items: { type: 'string' }, description: 'Allowed methods: pix, credit_card' },
        success_url: { type: 'string', description: 'Redirect URL after payment' },
        max_uses: { type: 'number', description: 'Maximum number of uses' },
      },
      required: ['amount'],
    },
  },
  {
    name: 'vaultix_get_payment_link',
    description: 'Retrieve a payment link by ID',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Payment Link ID (plink_...)' },
      },
      required: ['id'],
    },
  },
  {
    name: 'vaultix_list_payment_links',
    description: 'List all payment links',
    inputSchema: {
      type: 'object',
      properties: {
        limit: { type: 'number', description: 'Maximum results (1-100)' },
        status: { type: 'string', enum: ['active', 'inactive'], description: 'Filter by status' },
      },
    },
  },
  {
    name: 'vaultix_deactivate_payment_link',
    description: 'Deactivate a payment link',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Payment Link ID to deactivate' },
      },
      required: ['id'],
    },
  },

  // ==================== PAYOUTS ====================
  {
    name: 'vaultix_create_payout',
    description: 'Create a payout (withdrawal) via PIX or bank transfer. Amount in cents.',
    inputSchema: {
      type: 'object',
      properties: {
        amount: { type: 'number', description: 'Amount in cents (minimum 100)' },
        pix_key: { type: 'string', description: 'PIX key (for PIX payout)' },
        bank_code: { type: 'string', description: 'Bank code (for bank transfer)' },
        branch: { type: 'string', description: 'Branch number' },
        account: { type: 'string', description: 'Account number' },
        account_type: { type: 'string', enum: ['checking', 'savings'], description: 'Account type' },
        holder_name: { type: 'string', description: 'Account holder name' },
        holder_document: { type: 'string', description: 'Holder CPF/CNPJ' },
        description: { type: 'string', description: 'Payout description' },
      },
      required: ['amount'],
    },
  },
  {
    name: 'vaultix_get_payout',
    description: 'Retrieve a payout by ID',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Payout ID (po_...)' },
      },
      required: ['id'],
    },
  },
  {
    name: 'vaultix_list_payouts',
    description: 'List all payouts',
    inputSchema: {
      type: 'object',
      properties: {
        limit: { type: 'number', description: 'Maximum results (1-100)' },
        status: { type: 'string', enum: ['pending', 'in_transit', 'completed', 'failed', 'canceled'], description: 'Filter by status' },
      },
    },
  },
  {
    name: 'vaultix_cancel_payout',
    description: 'Cancel a pending payout',
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Payout ID to cancel' },
      },
      required: ['id'],
    },
  },
]

Tool Definition Quality

C2.6/5.0

Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. 'Create a new customer' implies a write/mutation operation, but it doesn't disclose important behavioral traits like required permissions, whether duplicate customers are allowed, what happens on success/failure, rate limits, or what the response contains. This leaves significant gaps for an agent to understand how to use this tool effectively.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise at just 3 words, which is appropriate for a simple operation. It's front-loaded with the essential action and resource. However, this conciseness comes at the cost of completeness, as it lacks necessary context for proper tool usage.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations and no output schema, the description is insufficiently complete. It doesn't explain what happens after creation, what data is returned, error conditions, or how this tool relates to other customer management tools in the system. The agent would need to guess about important behavioral aspects of this write operation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 100%, so the schema already documents all 4 parameters (name, email, document, phone) with their types and descriptions. The description adds no additional parameter information beyond what's in the schema, so it meets the baseline of 3 for adequate but not additive parameter documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Create a new customer' clearly states the verb ('Create') and resource ('customer'), which is better than a tautology. However, it lacks specificity about what constitutes a customer in this system and doesn't differentiate from sibling tools like 'vaultix_update_customer' or 'vaultix_get_customer' beyond the basic action verb.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'vaultix_update_customer' for modifying existing customers or 'vaultix_get_customer' for retrieving customer data. There's no mention of prerequisites, typical use cases, or when not to use this tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Latest Blog Posts

Tool Definition Quality Score (TDQS)
By punkpeye on April 3, 2026.
mcp
The Hackers Who Tracked My Sleep Cycle
By punkpeye on March 26, 2026.
security
Open Source Has a Bot Problem
By punkpeye on March 19, 2026.
open source

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/VautlixDevelopment/mcpVaultix'

If you have feedback or need assistance with the MCP directory API, please join our Discord server