VTEX Orders MCP Server for Mastra AI 6 tools — connect in under 2 minutes
Mastra AI is a TypeScript-native agent framework built for modern web stacks. Connect VTEX Orders through the Vinkius and Mastra agents discover all tools automatically — type-safe, streaming-ready, and deployable anywhere Node.js runs.
ASK AI ABOUT THIS MCP SERVER
Vinkius supports streamable HTTP and SSE.
import { Agent } from "@mastra/core/agent";
import { createMCPClient } from "@mastra/mcp";
import { openai } from "@ai-sdk/openai";
async function main() {
// Your Vinkius token — get it at cloud.vinkius.com
const mcpClient = await createMCPClient({
servers: {
"vtex-orders": {
url: "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp",
},
},
});
const tools = await mcpClient.getTools();
const agent = new Agent({
name: "VTEX Orders Agent",
instructions:
"You help users interact with VTEX Orders " +
"using 6 tools.",
model: openai("gpt-4o"),
tools,
});
const result = await agent.generate(
"What can I do with VTEX Orders?"
);
console.log(result.text);
}
main();
* 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.
Mastra's agent abstraction provides a clean separation between LLM logic and VTEX Orders tool infrastructure. Connect 6 tools through the Vinkius and use Mastra's built-in workflow engine to chain tool calls with conditional logic, retries, and parallel execution — deployable to any Node.js host in one command.
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 Mastra AI 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 Mastra AI via MCP
Follow these steps to integrate the VTEX Orders MCP Server with Mastra AI.
Install dependencies
Run npm install @mastra/core @mastra/mcp @ai-sdk/openai
Replace the token
Replace [YOUR_TOKEN_HERE] with your Vinkius token
Run the agent
Save to agent.ts and run with npx tsx agent.ts
Explore tools
Mastra discovers 6 tools from VTEX Orders via MCP
Why Use Mastra AI with the VTEX Orders MCP Server
Mastra AI provides unique advantages when paired with VTEX Orders through the Model Context Protocol.
Mastra's agent abstraction provides a clean separation between LLM logic and tool infrastructure — add VTEX Orders without touching business code
Built-in workflow engine chains MCP tool calls with conditional logic, retries, and parallel execution for complex automation
TypeScript-native: full type inference for every VTEX Orders tool response with IDE autocomplete and compile-time checks
One-command deployment to any Node.js host — Vercel, Railway, Fly.io, or your own infrastructure
VTEX Orders + Mastra AI Use Cases
Practical scenarios where Mastra AI combined with the VTEX Orders MCP Server delivers measurable value.
Automated workflows: build multi-step agents that query VTEX Orders, process results, and trigger downstream actions in a typed pipeline
SaaS integrations: embed VTEX Orders as a first-class tool in your product's AI features with Mastra's clean agent API
Background jobs: schedule Mastra agents to query VTEX Orders on a cron and store results in your database automatically
Multi-agent systems: create specialist agents that collaborate using VTEX Orders tools alongside other MCP servers
VTEX Orders MCP Tools for Mastra AI (6)
These 6 tools become available when you connect VTEX Orders to Mastra AI 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
Register a tax invoice and tracking number
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 Mastra AI
Ready-to-use prompts you can give your Mastra AI 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 Mastra AI
Common issues when connecting VTEX Orders to Mastra AI through the Vinkius, and how to resolve them.
createMCPClient not exported
npm install @mastra/mcpVTEX Orders + Mastra AI FAQ
Common questions about integrating VTEX Orders MCP Server with Mastra AI.
How does Mastra AI connect to MCP servers?
MCPClient with the server URL and pass it to your agent. Mastra discovers all tools and makes them available with full TypeScript types.Can Mastra agents use tools from multiple servers?
Does Mastra support workflow orchestration?
Connect VTEX Orders with your favorite client
Step-by-step setup guides for every MCP-compatible client and framework:
Anthropic's native desktop app for Claude with built-in MCP support.
AI-first code editor with integrated LLM-powered coding assistance.
GitHub Copilot in VS Code with Agent mode and MCP support.
Purpose-built IDE for agentic AI coding workflows.
Autonomous AI coding agent that runs inside VS Code.
Anthropic's agentic CLI for terminal-first development.
Python SDK for building production-grade OpenAI agent workflows.
Google's framework for building production AI agents.
Type-safe agent development for Python with first-class MCP support.
TypeScript toolkit for building AI-powered web applications.
TypeScript-native agent framework for modern web stacks.
Python framework for orchestrating collaborative AI agent crews.
Leading Python framework for composable LLM applications.
Data-aware AI agent framework for structured and unstructured sources.
Microsoft's framework for multi-agent collaborative conversations.
Connect VTEX Orders to Mastra AI
Get your token, paste the configuration, and start using 6 tools in under 2 minutes. No API key management needed.