Skip to main content
Glama
VautlixDevelopment

Vaultix MCP Server

by VautlixDevelopment
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Remote

vaultix_cancel_payout

Cancel a pending payout by providing the payout ID to stop the transaction from processing through the Vaultix Payment API.

Instructions

Cancel a pending payout

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesPayout ID to cancel

Implementation Reference

  • src/tools/index.ts:610-611 (handler)
    Handler logic for 'vaultix_cancel_payout' tool: Posts to `/payouts/${args.id}/cancel` using the VaultixClient to cancel a pending payout.
    case 'vaultix_cancel_payout':
  return client.post(`/payouts/${args.id}/cancel`)
  • src/tools/index.ts:409-414 (schema)
    Input schema definition for 'vaultix_cancel_payout' tool, requiring a payout ID.
    inputSchema: {
  type: 'object',
  properties: {
    id: { type: 'string', description: 'Payout ID to cancel' },
  },
  required: ['id'],
  • src/tools/index.ts:406-416 (registration)
    Registration of the 'vaultix_cancel_payout' tool in the exported tools array.
    {
  name: 'vaultix_cancel_payout',
  description: 'Cancel a pending payout',
  inputSchema: {
    type: 'object',
    properties: {
      id: { type: 'string', description: 'Payout ID to cancel' },
    },
    required: ['id'],
  },
},

Tool Definition Quality

B3.1/5.0
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. 'Cancel' implies a destructive mutation, but it doesn't disclose behavioral traits like whether cancellation is reversible, what happens to associated funds, required permissions, rate limits, or error conditions. For a financial operation with no 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 a single, efficient sentence that directly states the tool's purpose. It's front-loaded with no wasted words, making it easy to parse quickly. Every word earns its place.

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 complexity of a financial cancellation operation, no annotations, and no output schema, the description is incomplete. It lacks crucial context: what 'pending' means, cancellation effects, success/error responses, or dependencies. For a mutation tool in this domain, more detail is needed to ensure safe use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with the single parameter 'id' documented as 'Payout ID to cancel'. The description doesn't add meaning beyond the schema, but with only one parameter and high coverage, the baseline is strong. No additional param info is needed, though context like ID format could help.

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 'Cancel a pending payout' clearly states the action (cancel) and target resource (pending payout). It distinguishes from siblings like 'vaultix_create_payout' and 'vaultix_get_payout' by specifying the cancellation operation. However, it doesn't explicitly differentiate from 'vaultix_cancel_charge' beyond the resource name, which is slightly less specific than ideal.

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. It doesn't specify prerequisites (e.g., payout must be pending), exclusions (e.g., cannot cancel completed payouts), or mention sibling tools like 'vaultix_get_payout' for checking status first. Usage is implied but not explicitly stated.

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