How do I get my VTEX API credentials?

Log in to your VTEX Admin, go to **Account Settings → Application Keys**, and create a new App Key. You'll receive an App Key and App Token pair. You also need your Account Name (the subdomain you use to access the VTEX Admin, e.g., 'mystore'). Ensure the key has **OMS** read/write permissions. No code, no SDK — just connect and go.

Can my agent register an invoice and tracking number at the same time?

Yes! The 'register_invoice' tool accepts the invoice number and an optional tracking number in one call. Once submitted, the order automatically moves to 'Invoiced' status — eliminating the manual step of navigating to the VTEX Admin, opening the order detail, and filling each field separately.

How does the agent handle order cancellations with refunds?

Just tell your agent to cancel the order. It uses the 'cancel_order' tool with an optional reason (so your team has an audit trail). VTEX then handles the refund automatically based on the payment method. No tab-switching, no admin navigation — your support team resolves it in one conversation.

Can I monitor fulfillment status across hundreds of orders?

Absolutely. The 'search_orders' tool supports status filters and pagination, so your agent can scan the entire order queue — for example, listing all orders stuck in 'ready-for-handling' to identify fulfillment delays. Perfect for operations teams managing high-volume VTEX stores with multiple sellers.

VTEX Orders MCP Server for Vercel AI SDK 6 tools — connect in under 2 minutes

Name: VTEX Orders
Availability: InStock
Author: Vinkius

ai-sdk.dev/docs/ai-sdk-core/mcp

Built by Vinkius GDPR 6 Tools SDK

The Vercel AI SDK is the TypeScript toolkit for building AI-powered applications. Connect VTEX Orders through Vinkius and every tool is available as a typed function. ready for React Server Components, API routes, or any Node.js backend.

Get MCP Server for AI Agents

ASK AI ABOUT THIS MCP SERVER

Open in ChatGPT Open in Claude Open in Perplexity

Vinkius supports streamable HTTP and SSE.

typescript

import { createMCPClient } from "@ai-sdk/mcp";
import { generateText } from "ai";
import { openai } from "@ai-sdk/openai";

async function main() {
  const mcpClient = await createMCPClient({
    transport: {
      type: "http",
      // Your Vinkius token. get it at cloud.vinkius.com
      url: "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp",
    },
  });

  try {
    const tools = await mcpClient.tools();
    const { text } = await generateText({
      model: openai("gpt-4o"),
      tools,
      prompt: "Using VTEX Orders, list all available capabilities.",
    });
    console.log(text);
  } finally {
    await mcpClient.close();
  }
}

main();

Fully ManagedVinkius Servers

60%Token savings

High SecurityEnterprise-grade

IAMAccess control

EU AI ActCompliant

DLPData protection

V8 IsolateSandboxed

Ed25519Audit chain

<40msKill switch

Stream every event to Splunk, Datadog, or your own webhook in real-time

* Every MCP server runs on Vinkius-managed infrastructure inside AWS - a purpose-built runtime with per-request V8 isolates, Ed25519 signed audit chains, and sub-40ms cold starts optimized for native MCP execution. See our infrastructure

About VTEX Orders MCP Server

Connect your VTEX Order Management System (OMS) to any AI agent and take full control of your store's order lifecycle through natural conversation.

The Vercel AI SDK gives every VTEX Orders tool full TypeScript type inference, IDE autocomplete, and compile-time error checking. Connect 6 tools through Vinkius and stream results progressively to React, Svelte, or Vue components. works on Edge Functions, Cloudflare Workers, and any Node.js runtime.

What you can do

Order Lookup — Retrieve the full details of any order by ID, including items, client profile, payment method, logistics, and current status.
Order Search — Search and filter orders by status (e.g., 'ready-for-handling', 'invoiced', 'canceled') with built-in pagination for large result sets.
Status Updates — Advance orders through the fulfillment pipeline by updating their status (e.g., move from 'ready-for-handling' to 'handling').
Shipment Tracking — Retrieve tracking information for shipped packages, including carrier, tracking number, and tracking URL.
Invoice Registration — Attach tax invoices (NF-e) and tracking numbers to orders, automatically moving them to 'Invoiced' status.
Order Cancellation — Cancel orders with an optional reason, triggering automatic refund processing.

The VTEX Orders MCP Server exposes 6 tools through the Vinkius. Connect it to Vercel AI SDK in under two minutes — no API keys to rotate, no infrastructure to provision, no vendor lock-in. Your configuration, your data, your control.

How to Connect VTEX Orders to Vercel AI SDK via MCP

Follow these steps to integrate the VTEX Orders MCP Server with Vercel AI SDK.

Install dependencies

Run npm install @ai-sdk/mcp ai @ai-sdk/openai

Replace the token

Replace [YOUR_TOKEN_HERE] with your Vinkius token

Run the script

Save to agent.ts and run with npx tsx agent.ts

Explore tools

The SDK discovers 6 tools from VTEX Orders and passes them to the LLM

Why Use Vercel AI SDK with the VTEX Orders MCP Server

Vercel AI SDK provides unique advantages when paired with VTEX Orders through the Model Context Protocol.

TypeScript-first: every MCP tool gets full type inference, IDE autocomplete, and compile-time error checking out of the box

Framework-agnostic core works with Next.js, Nuxt, SvelteKit, or any Node.js runtime. same VTEX Orders integration everywhere

Built-in streaming UI primitives let you display VTEX Orders tool results progressively in React, Svelte, or Vue components

Edge-compatible: the AI SDK runs on Vercel Edge Functions, Cloudflare Workers, and other edge runtimes for minimal latency

VTEX Orders + Vercel AI SDK Use Cases

Practical scenarios where Vercel AI SDK combined with the VTEX Orders MCP Server delivers measurable value.

AI-powered web apps: build dashboards that query VTEX Orders in real-time and stream results to the UI with zero loading states

API backends: create serverless endpoints that orchestrate VTEX Orders tools and return structured JSON responses to any frontend

Chatbots with tool use: embed VTEX Orders capabilities into conversational interfaces with streaming responses and tool call visibility

Internal tools: build admin panels where team members interact with VTEX Orders through natural language queries

VTEX Orders MCP Tools for Vercel AI SDK (6)

These 6 tools become available when you connect VTEX Orders to Vercel AI SDK via MCP:

cancel_order

Cancel an order

get_order

Get full details of a specific order

get_tracking_info

Get tracking info for an order package

register_invoice

search_orders

g., "ready-for-handling"). Search for orders by status or pagination

update_order_status

Update the status of an order

Example Prompts for VTEX Orders in Vercel AI SDK

Ready-to-use prompts you can give your Vercel AI SDK agent to start working with VTEX Orders immediately.

"Show me the details of order v-1234567890"

"List all orders with status 'ready-for-handling'"

"Cancel order v-444 — customer requested wrong size"

Troubleshooting VTEX Orders MCP Server with Vercel AI SDK

Common issues when connecting VTEX Orders to Vercel AI SDK through the Vinkius, and how to resolve them.

createMCPClient is not a function

Install: npm install @ai-sdk/mcp

VTEX Orders + Vercel AI SDK FAQ

Common questions about integrating VTEX Orders MCP Server with Vercel AI SDK.

How does the Vercel AI SDK connect to MCP servers?

Import createMCPClient from @ai-sdk/mcp and pass the server URL. The SDK discovers all tools and provides typed TypeScript interfaces for each one.