Skip to main content
Glama
VautlixDevelopment

Vaultix MCP Server

vaultix_list_orders

Retrieve and filter payment orders from Vaultix by status or payment status to manage transactions and monitor business operations.

Instructions

List all orders

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum results (1-100)
statusNoFilter by status
payment_statusNoFilter by payment status

Implementation Reference

  • Handler implementation for the 'vaultix_list_orders' tool within the handleToolCall switch statement. It retrieves the list of orders from the Vaultix API using client.get('/orders') with optional limit, status, and payment_status filters.
    case 'vaultix_list_orders':
      return client.get('/orders', {
        limit: args.limit,
        status: args.status,
        payment_status: args.payment_status,
      })
  • Tool definition including name, description, and input schema for 'vaultix_list_orders'. This registers the tool in the exported 'tools' array for MCP.
    {
      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' },
        },
      },
    },
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 only states the action without behavioral details. It doesn't mention whether this is a read-only operation, pagination behavior, rate limits, authentication requirements, or what the output looks like. 'List all orders' suggests a retrieval operation but lacks transparency about implementation.

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?

Extremely concise at just three words with zero wasted language. It's front-loaded with the core action and resource, though this brevity comes at the cost of completeness.

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 list tool with 3 parameters and no output schema or annotations, the description is inadequate. It doesn't explain return format, pagination, ordering, or how filters interact. While schema covers parameters, the overall context for using this tool effectively is incomplete.

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%, with all three parameters well-documented in the schema itself. The description adds no parameter information beyond what's in the schema, so it meets the baseline of 3 for high schema coverage without adding extra value.

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 orders' clearly states the verb ('List') and resource ('orders'), but it's vague about scope and doesn't distinguish from sibling tools like 'vaultix_get_order' (singular) or 'vaultix_list_charges' (different resource). It lacks specificity about what 'all' means in context of available filters.

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 on when to use this tool versus alternatives like 'vaultix_get_order' for a single order or other list tools for different resources. The description implies it's for listing orders, but doesn't specify use cases, prerequisites, 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