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

Name: VTEX Orders
Availability: InStock
Author: Vinkius

modelcontextprotocol.io/quickstart/user

Built by Vinkius GDPR 6 Tools IDE

Claude Desktop is Anthropic's native application for interacting with Claude AI models on macOS and Windows. It was the first consumer application to ship with built-in MCP support, making it the reference implementation for the Model Context Protocol standard.

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": {
      // Your Vinkius token — get it at cloud.vinkius.com
      "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.

Claude Desktop is the definitive way to connect VTEX Orders to your AI workflow. Add the Vinkius Edge URL to your config, restart the app, and Claude immediately exposes all 6 tools in the chat interface — ask a question, Claude calls the right tool, and you see the answer. Zero code, zero context switching.

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 Claude Desktop 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 Claude Desktop via MCP

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

Open Claude Desktop Settings

Go to Settings → Developer → Edit Config to open claude_desktop_config.json

Add the MCP Server

Paste the configuration above into the mcpServers section

Restart Claude Desktop

Close and reopen Claude Desktop to load the new server

Start using VTEX Orders

Look for the 🔌 icon in the chat — your 6 tools are now available

Why Use Claude Desktop with the VTEX Orders MCP Server

Claude Desktop by Anthropic provides unique advantages when paired with VTEX Orders through the Model Context Protocol.

Claude Desktop is the reference MCP client — it was designed alongside the protocol itself, ensuring the most complete and stable MCP implementation available

Zero-code configuration: add a server URL to a JSON file and Claude instantly discovers and exposes all available tools in the chat interface

Claude's extended thinking capability lets it reason through multi-step tool usage, chaining multiple API calls to answer complex questions

Enterprise-grade security with local config storage — your tokens never leave your machine, and connections go directly to the Vinkius Edge network

VTEX Orders + Claude Desktop Use Cases

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

Interactive data exploration: ask Claude to query DNS records, look up WHOIS data, and cross-reference results in a single conversation

Ad-hoc security audits: type a domain name and let Claude enumerate subdomains, check DNS history, and flag configuration anomalies — all through natural language

Executive briefings: generate comprehensive domain intelligence reports by asking Claude to compile findings into a formatted summary

Learning and training: new team members can explore API capabilities conversationally without needing to read documentation

VTEX Orders MCP Tools for Claude Desktop (6)

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

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

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

Server not appearing after restart

Ensure the JSON is valid (no trailing commas). Check the file path: ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\\Claude\\ (Windows).

Authentication error

Verify your Vinkius token is correct. Go to cloud.vinkius.com to regenerate it if needed.

Tools not showing in chat

Click the 🔌 icon at the bottom of the chat input. If it shows 0 tools, the server may still be connecting — wait a few seconds.

VTEX Orders + Claude Desktop FAQ

Common questions about integrating VTEX Orders MCP Server with Claude Desktop.

How does Claude Desktop discover MCP tools?

When Claude Desktop starts, it reads the claude_desktop_config.json file and connects to each configured MCP server. It calls the tools/list endpoint to fetch the schema for every available tool, then surfaces them as clickable options in the chat interface via the 🔌 icon.

What happens if the MCP server is temporarily unavailable?

Claude Desktop handles disconnections gracefully — if the server is unreachable at startup, the tools simply won't appear. Once the server becomes available again, restarting Claude Desktop will re-establish the connection. There is no timeout penalty or error loop.

Can I connect multiple MCP servers simultaneously?

Yes. You can add as many servers as you need in the mcpServers section of the config file. Each server appears as a separate tool provider, and Claude can use tools from multiple servers in a single conversation turn.

Is there a limit on the number of tools per server?

Claude Desktop can handle hundreds of tools per server. However, for optimal LLM performance, Vinkius servers are designed to expose focused, well-documented tool sets rather than overwhelming the model with too many options.

Does Claude Desktop support Streamable HTTP transport?

Yes. Claude Desktop supports both SSE (Server-Sent Events) and the newer Streamable HTTP transport that Vinkius uses. Simply provide the server URL — Claude auto-negotiates the transport protocol.