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 Windsurf 6 tools — connect in under 2 minutes

Name: VTEX Orders
Availability: InStock
Author: Vinkius

docs.windsurf.com/windsurf/mcp

Built by Vinkius GDPR 6 Tools IDE

Windsurf brings agentic AI coding to a purpose-built IDE. Connect VTEX Orders through the Vinkius and Cascade will auto-discover every tool — ask questions, generate code, and act on live data without leaving your editor.

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.

RecommendedModern Approach — Zero Configuration

Vinkius Desktop App

The modern way to manage MCP Servers — no config files, no terminal commands. Install VTEX Orders and 2,500+ MCP Servers from a single visual interface.

Download Free Open SourceNo signup required

Classic Setup·json

{
  "mcpServers": {
    "vtex-orders": {
      "url": "https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"
    }
  }
}

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.

Windsurf's Cascade agent chains multiple VTEX Orders tool calls autonomously — query data, analyze results, and generate code in a single agentic session. Paste the Vinkius Edge URL, reload, and all 6 tools are immediately available. Real-time tool feedback appears inline, so you see API responses directly in your editor.

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 Windsurf 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 Windsurf via MCP

Follow these steps to integrate the VTEX Orders MCP Server with Windsurf.

Open MCP Settings

Go to Settings → MCP Configuration or press Cmd+Shift+P and search "MCP"

Add the server

Paste the JSON configuration above into mcp_config.json

Save and reload

Windsurf will detect the new server automatically

Start using VTEX Orders

Open Cascade and ask: "Using VTEX Orders, help me..." — 6 tools available

Why Use Windsurf with the VTEX Orders MCP Server

Windsurf provides unique advantages when paired with VTEX Orders through the Model Context Protocol.

Windsurf's Cascade agent autonomously chains multiple tool calls in sequence, solving complex multi-step tasks without manual intervention

Purpose-built for agentic workflows — Cascade understands context across your entire codebase and integrates MCP tools natively

JSON-based configuration means zero code changes: paste a URL, reload, and all 6 tools are immediately available

Real-time tool feedback is displayed inline, so you see API responses directly in your editor without switching contexts

VTEX Orders + Windsurf Use Cases

Practical scenarios where Windsurf combined with the VTEX Orders MCP Server delivers measurable value.

Automated code generation: ask Cascade to fetch data from VTEX Orders and generate models, types, or handlers based on real API responses

Live debugging: query VTEX Orders tools mid-session to inspect production data while debugging without leaving the editor

Documentation generation: pull schema information from VTEX Orders and have Cascade generate comprehensive API docs automatically

Rapid prototyping: combine VTEX Orders data with Cascade's code generation to scaffold entire features in minutes

VTEX Orders MCP Tools for Windsurf (6)

These 6 tools become available when you connect VTEX Orders to Windsurf 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 Windsurf

Ready-to-use prompts you can give your Windsurf 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 Windsurf

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

Server not connecting

Check Settings → MCP for the server status. Try toggling it off and on.

VTEX Orders + Windsurf FAQ

Common questions about integrating VTEX Orders MCP Server with Windsurf.

How does Windsurf discover MCP tools?

Windsurf reads the mcp_config.json file on startup and connects to each configured server via Streamable HTTP. Tools are listed in the MCP panel and available to Cascade automatically.

Can Cascade chain multiple MCP tool calls?

Yes. Cascade is an agentic system — it can plan and execute multi-step workflows, calling several tools in sequence to accomplish complex tasks without manual prompting between steps.

Does Windsurf support multiple MCP servers?

Yes. Add as many servers as needed in mcp_config.json. Each server's tools appear in the MCP panel and Cascade can use tools from different servers in a single flow.