Skip to main content
Glama
VautlixDevelopment

Vaultix MCP Server

vaultix_list_customers

Retrieve customer records from the Vaultix Payment API. Filter by email or limit results to manage customer data for Brazilian payment methods including PIX, card, and boleto.

Instructions

List all customers

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum results (1-100)
emailNoFilter by email

Implementation Reference

  • The handler for the 'vaultix_list_customers' tool. It retrieves the list of customers from the Vaultix API using GET /customers with optional 'limit' and 'email' query parameters.
    case 'vaultix_list_customers':
      return client.get('/customers', {
        limit: args.limit,
        email: args.email,
      })
  • Input schema for the 'vaultix_list_customers' tool, defining optional parameters: limit (number) and email (string).
    inputSchema: {
      type: 'object',
      properties: {
        limit: { type: 'number', description: 'Maximum results (1-100)' },
        email: { type: 'string', description: 'Filter by email' },
      },
    },
  • Registration of the 'vaultix_list_customers' tool in the exported 'tools' array, including name, description, and input schema.
    {
      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' },
        },
      },
    },
Behavior2/5

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

With no annotations provided, the description carries full burden but lacks behavioral details. It doesn't disclose whether this is a read-only operation (implied by 'list' but not explicit), pagination behavior, rate limits, authentication requirements, or what the output looks like. The description is too minimal to provide meaningful behavioral context beyond the basic action.

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 extremely concise with just three words, front-loaded with the core action. There's zero wasted language, making it easy to parse quickly, though this brevity contributes to gaps in other dimensions.

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?

Given the tool's complexity (a list operation with filtering parameters), lack of annotations, and no output schema, the description is incomplete. It doesn't explain return values, error conditions, or behavioral nuances, leaving significant gaps for an AI agent to understand how to use this tool effectively.

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 fully documents the two parameters (limit and email). The description adds no parameter information beyond what's in the schema, not even hinting at filtering capabilities. Since the schema does the heavy lifting, the baseline score of 3 is appropriate.

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 'List all customers' states the basic action (list) and resource (customers), but it's vague about scope and functionality. It doesn't distinguish this tool from sibling list tools like 'vaultix_list_charges' or 'vaultix_list_products' beyond the resource name, nor does it clarify if 'all' means truly all customers or has implicit limitations.

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. For example, it doesn't mention when to use 'vaultix_list_customers' instead of 'vaultix_get_customer' (for a single customer) or how it relates to other list tools. The description offers no context on prerequisites, timing, or exclusions.

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