Skip to main content
Glama
VautlixDevelopment

Vaultix MCP Server

vaultix_list_products

Retrieve product listings from Vaultix Payment API with filtering options for status, search terms, and result limits.

Instructions

List all products

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum results (1-100)
statusNoFilter by status
searchNoSearch by name or SKU

Implementation Reference

  • Handler for vaultix_list_products tool that retrieves the list of products from the Vaultix API using the client.get method with optional query parameters for limit, status, and search.
    case 'vaultix_list_products':
      return client.get('/products', {
        limit: args.limit,
        status: args.status,
        search: args.search,
      })
  • Input schema defining the parameters for listing products: optional limit, status filter, and search term.
    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' },
      },
    },
  • Registration of the vaultix_list_products tool in the exported tools array, specifying name, description, and input schema.
    {
      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' },
        },
      },
    },
Behavior2/5

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

No annotations are provided, so the description carries full burden for behavioral disclosure. 'List all products' implies a read-only operation, but it doesn't specify whether this requires authentication, how results are returned (e.g., pagination), rate limits, or what 'all' means in context (e.g., all accessible products). For a list tool with zero annotation coverage, this is a significant gap.

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-loading the core purpose without any wasted text. Every word earns its place, making it easy to parse quickly.

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 no annotations and no output schema, the description is incomplete for a list tool with three parameters. It doesn't explain return values, error conditions, or behavioral aspects like pagination. While the schema covers parameters well, the overall context for safe and effective use is lacking.

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 three parameters (limit, status, search) with descriptions and enum values. The description adds no parameter information beyond what's in the schema, which is acceptable given the high coverage, resulting in the baseline score of 3.

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 'List all products' clearly states the action (list) and resource (products), making the purpose immediately understandable. However, it doesn't distinguish this tool from its sibling 'vaultix_get_product' (singular vs. plural) or explain how it differs from other list tools like 'vaultix_list_customers' beyond the resource type.

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_get_product' (for single product retrieval) or other list tools. There's no mention of prerequisites, typical use cases, or when not to use it, leaving the agent to infer usage from the name alone.

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