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

Name: VTEX Orders
Availability: InStock
Author: Vinkius

docs.crewai.com/mcp/overview

Built by Vinkius GDPR 6 Tools Framework

Connect your CrewAI agents to VTEX Orders through Vinkius, pass the Edge URL in the `mcps` parameter and every VTEX Orders tool is auto-discovered at runtime. No credentials to manage, no infrastructure to maintain.

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

from crewai import Agent, Task, Crew

agent = Agent(
    role="VTEX Orders Specialist",
    goal="Help users interact with VTEX Orders effectively",
    backstory=(
        "You are an expert at leveraging VTEX Orders tools "
        "for automation and data analysis."
    ),
    # Your Vinkius token. get it at cloud.vinkius.com
    mcps=["https://edge.vinkius.com/[YOUR_TOKEN_HERE]/mcp"],
)

task = Task(
    description=(
        "Explore all available tools in VTEX Orders "
        "and summarize their capabilities."
    ),
    agent=agent,
    expected_output=(
        "A detailed summary of 6 available tools "
        "and what they can do."
    ),
)

crew = Crew(agents=[agent], tasks=[task])
result = crew.kickoff()
print(result)

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.

When paired with CrewAI, VTEX Orders becomes a first-class tool in your multi-agent workflows. Each agent in the crew can call VTEX Orders tools autonomously, one agent queries data, another analyzes results, a third compiles reports, all orchestrated through Vinkius with zero configuration overhead.

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

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

Install CrewAI

Run pip install crewai

Replace the token

Replace [YOUR_TOKEN_HERE] with your Vinkius token from cloud.vinkius.com

Customize the agent

Adjust the role, goal, and backstory to fit your use case

Run the crew

Run python crew.py. CrewAI auto-discovers 6 tools from VTEX Orders

Why Use CrewAI with the VTEX Orders MCP Server

CrewAI Multi-Agent Orchestration Framework provides unique advantages when paired with VTEX Orders through the Model Context Protocol.

Multi-agent collaboration lets you decompose complex workflows into specialized roles, one agent researches, another analyzes, a third generates reports, each with access to MCP tools

CrewAI's native MCP integration requires zero adapter code: pass Vinkius Edge URL directly in the `mcps` parameter and agents auto-discover every available tool at runtime

Built-in task delegation and shared memory mean agents can pass context between steps without manual state management, enabling multi-hop reasoning across tool calls

Sequential and hierarchical crew patterns map naturally to real-world workflows: enumerate subdomains → analyze DNS history → check WHOIS records → compile findings into actionable reports

VTEX Orders + CrewAI Use Cases

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

Automated multi-step research: a reconnaissance agent queries VTEX Orders for raw data, then a second analyst agent cross-references findings and flags anomalies. all without human handoff

Scheduled intelligence reports: set up a crew that periodically queries VTEX Orders, analyzes trends over time, and generates executive briefings in markdown or PDF format

Multi-source enrichment pipelines: chain VTEX Orders tools with other MCP servers in the same crew, letting agents correlate data across multiple providers in a single workflow

Compliance and audit automation: a compliance agent queries VTEX Orders against predefined policy rules, generates deviation reports, and routes findings to the appropriate team

VTEX Orders MCP Tools for CrewAI (6)

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

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

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

MCP tools not discovered

Ensure the Edge URL is correct. CrewAI connects lazily when the crew starts. check console output.

Agent not using tools

Make the task description specific. Instead of "do something", say "Use the available tools to list contacts".

Timeout errors

CrewAI has a 10s connection timeout by default. Ensure your network can reach the Edge URL.

Rate limiting or 429 errors

Vinkius enforces per-token rate limits. Check your subscription tier and request quota in the dashboard. Upgrade if you need higher throughput.

VTEX Orders + CrewAI FAQ

Common questions about integrating VTEX Orders MCP Server with CrewAI.

How does CrewAI discover and connect to MCP tools?

CrewAI connects to MCP servers lazily. when the crew starts, each agent resolves its MCP URLs and fetches the tool catalog via the standard tools/list method. This means tools are always fresh and reflect the server's current capabilities. No tool schemas need to be hardcoded.

Can different agents in the same crew use different MCP servers?

Yes. Each agent has its own mcps list, so you can assign specific servers to specific roles. For example, a reconnaissance agent might use a domain intelligence server while an analysis agent uses a vulnerability database server.

What happens when an MCP tool call fails during a crew run?

CrewAI wraps tool failures as context for the agent. The LLM receives the error message and can decide to retry with different parameters, fall back to a different tool, or mark the task as partially complete. This resilience is critical for production workflows.

Can CrewAI agents call multiple MCP tools in parallel?

CrewAI agents execute tool calls sequentially within a single reasoning step. However, you can run multiple agents in parallel using process=Process.parallel, each calling different MCP tools concurrently. This is ideal for workflows where separate data sources need to be queried simultaneously.

Can I run CrewAI crews on a schedule (cron)?

Yes. CrewAI crews are standard Python scripts, so you can invoke them via cron, Airflow, Celery, or any task scheduler. The crew.kickoff() method runs synchronously by default, making it straightforward to integrate into existing pipelines.