MCP VTEX Server

vtex_create_gift_card

Generate gift cards for VTEX e-commerce with customizable balance, expiration dates, and owner restrictions to manage customer promotions and loyalty programs.

Instructions

Create a new gift card

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "balance": "<balance>"
    },
    "name": "vtex_create_gift_card"
  }
}

Input Schema

Name	Required	Description
`balance`	Yes	Gift card balance
`caption`	No	Gift card caption/description
`expiringDate`	No	Expiration date (ISO 8601)
`relationName`	No	Relation name
`profileId`	No	Profile ID
`restrictedToOwner`	No	Restrict to owner only

Schema Changelog

Changes observed during successful MCP inspections.

First observedv1.0.0Jan 10, 2026

TDQS

C2.9/5.0

Behavior2/5

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

With no annotations provided, the description carries full burden for behavioral disclosure but only states the basic action. It doesn't mention whether this is a write operation (implied but not explicit), what permissions are required, whether gift cards are immediately active, what happens on failure, or what the response contains. For a creation tool with zero annotation coverage, this is insufficient.

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 states exactly what the tool does with zero wasted words. It's appropriately sized for a straightforward creation operation.

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 creation tool with no annotations and no output schema, the description is inadequate. It doesn't explain what happens after creation, what format the response takes, whether there are side effects, or how this fits into the broader gift card management workflow. The agent would be left guessing about important behavioral aspects.

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?

The input schema has 100% description coverage, so all parameters are documented in the schema itself. The description adds no additional parameter information beyond what's already in the schema descriptions. This meets the baseline expectation when schema coverage is complete.

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 ('Create') and resource ('gift card'), making the purpose immediately understandable. However, it doesn't differentiate this tool from its sibling 'vtex_create_gift_card_transaction', which could cause confusion about when to use each.

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 'vtex_create_gift_card_transaction' or other gift card-related tools. There's no mention of prerequisites, typical use cases, or relationship to other operations in the gift card lifecycle.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server