Skip to main content
Glama
VautlixDevelopment

Vaultix MCP Server

vaultix_get_refund

Retrieve a specific refund by its ID to view details and status within the Vaultix payment system.

Instructions

Retrieve a refund by ID

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesRefund ID (re_...)

Implementation Reference

  • Executes the tool logic by calling the VaultixClient to GET /refunds/{id} with the provided refund ID.
    case 'vaultix_get_refund':
      return client.get(`/refunds/${args.id}`)
  • Defines the input schema for the vaultix_get_refund tool, requiring a refund ID string.
    inputSchema: {
      type: 'object',
      properties: {
        id: { type: 'string', description: 'Refund ID (re_...)' },
      },
      required: ['id'],
    },
  • Registers the vaultix_get_refund tool in the exported tools array for MCP, including name, description, and schema.
    {
      name: 'vaultix_get_refund',
      description: 'Retrieve a refund by ID',
      inputSchema: {
        type: 'object',
        properties: {
          id: { type: 'string', description: 'Refund ID (re_...)' },
        },
        required: ['id'],
      },
    },
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 basic action. It doesn't disclose whether this is a read-only operation, what authentication is needed, what happens if the ID doesn't exist, rate limits, or what format the return data will have. 'Retrieve' implies reading, but no behavioral details are provided.

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 with no wasted words. It's appropriately sized for a simple retrieval operation and front-loads the essential information immediately.

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 retrieval tool with no annotations and no output schema, the description is insufficient. It doesn't explain what data is returned, potential error cases, or how this fits into the broader refund workflow (e.g., relationship to create_refund or list_refunds). The context signals show this is a simple tool, but more completeness is needed.

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% (the 'id' parameter is fully described in the schema as 'Refund ID (re_...)'), so the description adds no additional parameter information beyond what's already in the structured 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 ('Retrieve') and resource ('a refund by ID'), making the purpose understandable. It distinguishes this from creation/listing operations but doesn't explicitly differentiate from other 'get_' tools like get_charge or get_customer, which have similar retrieval patterns.

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 about when to use this tool versus alternatives. While it's implied this is for retrieving specific refunds (vs. list_refunds for listing), there's no explicit mention of prerequisites, error conditions, or comparison to sibling tools like get_transaction that might retrieve similar financial data.

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