How to Use the VTEX Checkout MCP in Vercel AI SDK

Q: Can Vercel AI SDK automate coupon application for VTEX Checkout?

Yes. The agent uses the addcoupon tool to apply a specific promotional code directly against the shopping cart data, simulating the final price drop in real time.

Q: Where is payment validation handled when using Vercel AI SDK with VTEX Checkout?

Payment validation happens via simulatepayment. This tool checks if a given payment method is valid for the simulated cart, allowing you to show error states instantly in your UI.

Build real-time checkout experiences directly into your UI using Vercel AI SDK.

See Vinkius in Action

Works with every AI agent you already use

…and any MCP-compatible client

MCP Servers - Free for Subscribers

Connect VTEX Checkout MCP to Vercel AI SDK

Create your Vinkius account to connect VTEX Checkout to Vercel AI SDK and route execution through our secure gateway. The platform manages server hosting, runtime updates, and security layers. Configuration requires no manual server provisioning.

GDPR Free for Subscribers

Setup VTEX Checkout with Vercel AI SDK

Ask AI about this MCP

ChatGPT

Claude

Perplexity

Real-Time Checkout Interactions with Vercel AI SDK

When you need to check a client's details, the `get_client_profile` tool pulls data and streams it into the UI instantly. Users see profile fields appear live—no loading spinner, just immediate data flow. This makes building user-facing products much smoother. You can call other tools like `add_coupon` or `simulate_order`, and the results stream right back to the React component.

Simulating Transactions with Vercel AI SDK

The `simulate_order` tool lets your agent run a complete cart calculation without touching live inventory. It calculates both the cart total and projected shipping costs. Need to check if payment goes through? Use `simulate_payment`. This validates payment logic on the front end before committing any actual funds.

Managing Checkout Data with Vercel AI SDK

The `get_orderform` tool gathers all details for a specific shopping cart, giving your agent a full picture of what's in the checkout. You can then use this data to calculate final pricing. If the user needs to change their location, the `create_address` tool handles adding that new address to the client profile immediately.

Setup guide

Set up VTEX Checkout MCP in Vercel AI SDK

Prerequisites

Node.js 18+ and a TypeScript project
ai + @modelcontextprotocol/sdk packages
Active Vinkius subscription with a valid endpoint token

1

Install dependencies

Run npm install ai @modelcontextprotocol/sdk plus your preferred model provider (e.g. @ai-sdk/openai).
2

Create the Streamable HTTP transport

Use StreamableHTTPClientTransport with your Vinkius endpoint URL. Replace [YOUR_TOKEN_HERE] with your token from cloud.vinkius.com.
3

Discover and use tools

Call mcpClient.tools() to auto-discover all VTEX Checkout tools. Pass them directly to generateText() or streamText() — no manual schema definitions needed.
4

Works with any model provider

Swap openai("gpt-4o") for any AI SDK provider — Anthropic, Google, Mistral. The MCP tools work identically across all supported models.

index.ts

import { experimental_createMCPClient as createMCPClient } from "ai";
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp";
import { generateText } from "ai";
import { openai } from "@ai-sdk/openai";

const transport = new StreamableHTTPClientTransport(
  new URL("https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp")
);

const mcpClient = await createMCPClient({ transport });
const tools = await mcpClient.tools();

const { text } = await generateText({
  model: openai("gpt-4o"),
  tools,
  prompt: "List recent VTEX Checkout transactions",
});

console.log(text);
await mcpClient.close();

Get your connection token →

Independent Platform Disclaimer: Vinkius is an independent platform and is not affiliated with, endorsed by, sponsored by, verified by, or otherwise authorized by VTEX. All third-party trademarks, logos, and brand names are the property of their respective owners. Their use on this website is strictly for informational purposes to identify service compatibility and interoperability.

Why Choose Vinkius

Vinkius connects your tools to AI with real-time monitoring and automatic cost savings — all from one dashboard.

Connect VTEX Checkout now

Real-time monitoring

Live

visibility into every interaction

Connect your favorite tools to your AI and see exactly what's happening — every request, every response, in real time.

Built-in savings

60%

lower AI costs

Vinkius compresses data between your apps and your AI automatically. Lower bills every month — no configuration required.

Single dashboard

One

place for every integration

Every tool your AI connects to, managed from a single screen. One account, complete control.

Common questions about VTEX Checkout MCP in Vercel AI SDK

Your agent uses the MCP Server tools directly. For example, calling `simulate_order` lets it calculate shipping and costs live in your Next.js frontend without needing a backend API call for every step.

It exposes client profile details, specifically the user's address information when using `get_client_profile` or `create_address`. This is critical for accurate shipping simulations.

Yes. The agent uses the `add_coupon` tool to apply a specific promotional code directly against the shopping cart data, simulating the final price drop in real time.

Payment validation happens via `simulate_payment`. This tool checks if a given payment method is valid for the simulated cart, allowing you to show error states instantly in your UI.

This MCP Server touches client profile details. Always ensure that any PII retrieved via `get_client_profile` is handled according to your application's security guidelines.

Use it with your favorite AI tools

Connect this server to Cursor, Claude, VS Code, and more.

OpenAI Agents SDK sdk-python

Google ADK sdk-python

Pydantic AI sdk-python

Vercel AI SDK sdk-typescript