Skip to main content
Glama
VautlixDevelopment

Vaultix MCP Server

vaultix_create_charge

Create payment charges for PIX, credit card, or boleto transactions in Brazilian currency. Specify amount in cents, customer details, and payment method to process payments.

Instructions

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
amountYesAmount in cents (minimum 100 = R$ 1,00)
payment_methodYesPayment method
customer_nameYesCustomer name
customer_emailYesCustomer email
customer_documentNoCustomer CPF/CNPJ
descriptionNoCharge description

Implementation Reference

  • The handler for the 'vaultix_create_charge' tool. It maps the input arguments to a POST request to the '/charges' endpoint using the VaultixClient.
    case 'vaultix_create_charge':
      return client.post('/charges', {
        amount: args.amount,
        payment_method: args.payment_method,
        description: args.description,
        customer: {
          name: args.customer_name,
          email: args.customer_email,
          document: args.customer_document,
        },
      })
  • Input schema defining the parameters and validation rules for the 'vaultix_create_charge' tool.
    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'],
    },
  • Registration of the 'vaultix_create_charge' tool in the exported tools array, including name, description, and schema.
    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'],
    },
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. It mentions the amount format (cents) but fails to describe critical behaviors such as authentication requirements, rate limits, idempotency, response format, error handling, or side effects (e.g., whether the charge is immediately processed). This leaves significant gaps for a mutation tool.

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

Conciseness5/5

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

The description is a single, efficient sentence that front-loads the core action and key details (payment methods, amount format). There is no wasted verbiage, and it directly addresses the most critical information for initial understanding.

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 insufficient. It lacks details on behavioral traits (e.g., permissions, idempotency), response structure, error cases, and usage context relative to siblings. While concise, it doesn't compensate for the missing structured data, leaving the agent under-informed.

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?

Schema description coverage is 100%, so the schema already documents all parameters thoroughly. The description adds minimal value by clarifying the amount unit (cents) and providing a currency example, but it doesn't explain parameter interactions, validation rules, or business logic beyond what's in the schema. This meets the baseline for high schema coverage.

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

Purpose4/5

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

The description clearly states the verb ('Create') and resource ('new payment charge'), specifying the payment methods (PIX, Credit Card, or Boleto) and currency context (Brazilian Real). It distinguishes from siblings like 'vaultix_create_customer' or 'vaultix_create_refund' by focusing on charges, though it doesn't explicitly contrast with similar tools like 'vaultix_create_payment_link'.

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?

No guidance is provided on when to use this tool versus alternatives such as 'vaultix_create_payment_link' for payment links or 'vaultix_create_refund' for refunds. The description lacks context about prerequisites, error conditions, or typical use cases, offering only basic functional information.

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

Install Server

Other Tools

Latest Blog Posts

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