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

Name: VTEX Orders
Availability: InStock
Author: Vinkius

docs.llamaindex.ai/en/stable/module_guides/tools/mcp

Built by Vinkius GDPR 6 Tools Framework

LlamaIndex specializes in data-aware AI agents that connect LLMs to structured and unstructured sources. Add VTEX Orders as an MCP tool provider through Vinkius and your agents can query, analyze, and act on live data alongside your existing indexes.

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.

python

import asyncio
from llama_index.tools.mcp import BasicMCPClient, McpToolSpec
from llama_index.core.agent.workflow import FunctionAgent
from llama_index.llms.openai import OpenAI

async def main():
    # Your Vinkius token. get it at cloud.vinkius.com
    mcp_client = BasicMCPClient("https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp")
    mcp_tool_spec = McpToolSpec(client=mcp_client)
    tools = await mcp_tool_spec.to_tool_list_async()

    agent = FunctionAgent(
        tools=tools,
        llm=OpenAI(model="gpt-4o"),
        system_prompt=(
            "You are an assistant with access to VTEX Orders. "
            "You have 6 tools available."
        ),
    )

    response = await agent.run(
        "What tools are available in VTEX Orders?"
    )
    print(response)

asyncio.run(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.

LlamaIndex agents combine VTEX Orders tool responses with indexed documents for comprehensive, grounded answers. Connect 6 tools through Vinkius and query live data alongside vector stores and SQL databases in a single turn. ideal for hybrid search, data enrichment, and analytical workflows.

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

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

Install dependencies

Run pip install llama-index-tools-mcp llama-index-llms-openai

Replace the token

Replace [YOUR_TOKEN_HERE] with your Vinkius token

Run the agent

Save to agent.py and run: python agent.py

Explore tools

The agent discovers 6 tools from VTEX Orders

Why Use LlamaIndex with the VTEX Orders MCP Server

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

Data-first architecture: LlamaIndex agents combine VTEX Orders tool responses with indexed documents for comprehensive, grounded answers

Query pipeline framework lets you chain VTEX Orders tool calls with transformations, filters, and re-rankers in a typed pipeline

Multi-source reasoning: agents can query VTEX Orders, a vector store, and a SQL database in a single turn and synthesize results

Observability integrations show exactly what VTEX Orders tools were called, what data was returned, and how it influenced the final answer

VTEX Orders + LlamaIndex Use Cases

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

Hybrid search: combine VTEX Orders real-time data with embedded document indexes for answers that are both current and comprehensive

Data enrichment: query VTEX Orders to augment indexed data with live information before generating user-facing responses

Knowledge base agents: build agents that maintain and update knowledge bases by periodically querying VTEX Orders for fresh data

Analytical workflows: chain VTEX Orders queries with LlamaIndex's data connectors to build multi-source analytical reports

VTEX Orders MCP Tools for LlamaIndex (6)

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

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

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

BasicMCPClient not found

Install: pip install llama-index-tools-mcp

VTEX Orders + LlamaIndex FAQ

Common questions about integrating VTEX Orders MCP Server with LlamaIndex.

How does LlamaIndex connect to MCP servers?

Use the MCP client adapter to create a connection. LlamaIndex discovers all tools and wraps them as query engine tools compatible with any LlamaIndex agent.

Can I combine MCP tools with vector stores?

Yes. LlamaIndex agents can query VTEX Orders tools and vector store indexes in the same turn, combining real-time and embedded data for grounded responses.