io.github.codespar/mcp-vtex

NPM · @CODESPAR/MCP-VTEX · SCANNED AUG 3

MCP server for VTEX — e-commerce, orders, products, inventory, shipping

Available components

+22 this week 68 68 Trust /100

Trust breakdown (6 categories)

How this component scores in each security and reliability category. Every signal is checked automatically from public evidence about the published package, including repeated runs of it in an isolated sandbox, and we only credit what we can confirm. How we score →

Supply Chain Security86

No malware found by supply-chain analysis.Pass
Only part of the dependency tree could be resolved (94 of 98), so this covers what we could see, not the whole tree.Partial
No install/post-install scripts declared.Pass
Only part of the dependency tree could be resolved (94 of 98), so this covers what we could see, not the whole tree. View diagnostics → Partial

Provenance & Transparency45

Source repository is publicly reachable at the declared URL. View diagnostics → Pass
Provenance check failed: no build-provenance attestation is published. See how to fix → View diagnostics → Fail
Clear OSI-approved license (MIT).Pass
Actively maintained (last published 41 days ago).Pass
Disclosure check failed: no security disclosure policy was found in the source repository. See how to fix → Fail

Schema Quality & AI Usability70

AI-judged instruction clarity (good).Pass
Tool/resource definitions use about 2333 tokens (~70/item across 33 items; 33 tools + 0 resources), lean.Pass
Usage-examples check failed: none of the tools include examples. See how to fix → Fail

Stability & Change Management27

Stability observed for 8 of 30 days with no destabilising changes; credit accrues until the full window elapses.Partial

Tool Coverage100

100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
100% of tool parameters carry a description.Pass

Capabilities100

Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.Pass

Install

Add this component to your MCP client. Where a client-specific snippet is available, pick your client below and copy it straight into your config; otherwise use the connection detail shown.

npm · @codespar/mcp-vtex

Claude Codex opencode OpenClaw Hermes Other

# add to Claude Code

claude mcp add codespar-mcp-vtex -- npx -y @codespar/mcp-vtex

# add to Codex CLI

codex mcp add codespar-mcp-vtex -- npx -y @codespar/mcp-vtex

// opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "codespar-mcp-vtex": {
      "type": "local",
      "command": [
        "npx",
        "-y",
        "@codespar/mcp-vtex"
      ],
      "enabled": true
    }
  }
}

# add to OpenClaw

openclaw mcp add codespar-mcp-vtex --command npx --arg -y --arg @codespar/mcp-vtex

# ~/.hermes/config.yaml

mcp_servers:
  codespar-mcp-vtex:
    command: "npx"
    args: ["-y", "@codespar/mcp-vtex"]

// mcp.json

{
  "mcpServers": {
    "codespar-mcp-vtex": {
      "command": "npx",
      "args": [
        "-y",
        "@codespar/mcp-vtex"
      ]
    }
  }
}

Changelog

Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.

3 Aug 26 +1

No change was recorded against any check on this day. Stability & Change Management went from 23 to 27. That category is still filling its 30-day observation window: 7 days of observed history at the previous scan, 8 at this one. The score rises as the window fills, whether or not the server changes.
2 Aug 26 +46
- Provenance: unverified → fail ▼ security
- Install scripts: unverified → pass ▲ security
- Known CVEs: unverified → partial ▲ security
- Malware scan: unverified → pass ▲ security
- License: unverified → pass ▲ functional
- MCP protocol: unverified → pass ▲ functional
- Stability: unverified → 0.23 ▲ functional
- Schema quality: unverified → good ▲ functional
- Dependency health: unverified → partial ▲ functional
- Maintenance: unverified → pass ▲ functional
- Licence: MIT functional
31 Jul 26 −25
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
27 Jul 26 46

First indexed and scored.

Show 2 earlier entries Hide earlier entries

Diagnostics

Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.

Captured 3 Aug 2026 · Analysed npm/@codespar/[email protected]

Provenance none

Ecosystem: npm · Outcome: none

Dependencies 94 packages

94 packages in the resolved dependency tree · 94 deprecated · 29 stale.

The dependency tree was only partially resolved, so these counts may be incomplete.

MCP tools — 33 exposed · ~2,266 tokens

The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability.

Tool Tokens

cancel_order ~32

Cancel an order

Input Output Examples

Name	Type	Req	Description
orderId	string	yes	Order ID
reason	string	—	Reason for cancellation

No output schema declared.

No examples provided.

create_category ~100

Create a new category in the catalog

Input Output Examples

Name	Type	Req	Description
Description	string	—	Category description
FatherCategoryId	number	—	Parent category ID (null for root)
IsActive	boolean	—	Active status (default true)
Keywords	string	—	SEO keywords (comma-separated)
Name	string	yes	Category name
ShowInStoreFront	boolean	—	Show in store navigation
Title	string	—	Page title (SEO)

No output schema declared.

No examples provided.

create_coupon ~99

Create a promotion coupon code

Input Output Examples

Name	Type	Req	Description
expirationIntervalPerUse	string	—	Time between uses (ISO 8601 duration)
isArchived	boolean	—	Archived state (default false)
maxItemsPerClient	number	—	Max usage per customer (0 = unlimited)
promotionId	string	yes	Promotion ID this coupon is tied to
utmSource	string	yes	Coupon code / UTM source (what the customer types)

No output schema declared.

No examples provided.

create_giftcard ~155

Create a gift card for a customer (GiftCard Hub)

Input Output Examples

Name	Type	Req	Description
caption	string	yes	Short description of the gift card
discount	boolean	—	Whether the gift card is a discount (default false)
expiringDate	string	yes	Expiration date in ISO 8601 format
multipleCredits	boolean	—	Allow multiple credits (default true)
multipleRedemptions	boolean	—	Allow multiple redemptions (default true)
profileId	string	yes	Customer profile ID (email or client ID)
relationName	string	yes	Unique identifier for client-gift card relationship (UUID recommended)
restrictedToOwner	boolean	—	Restrict redemption to the owner (default false)

No output schema declared.

No examples provided.

create_product ~129

Create a new product in the VTEX catalog

Input Output Examples

Name	Type	Req	Description
BrandId	number	yes	Brand ID
CategoryId	number	yes	Category ID
Description	string	—	Product description (HTML supported)
DescriptionShort	string	—	Short description
IsActive	boolean	—	Active status (default true)
IsVisible	boolean	—	Product visibility (default true)
LinkId	string	—	URL slug
Name	string	yes	Product name
RefId	string	—	Reference ID (internal code)
Title	string	—	Page title (SEO)

No output schema declared.

No examples provided.

create_promotion ~105

Create a promotion/discount in VTEX

Input Output Examples

Name	Type	Req	Description
beginDateUtc	string	yes	Start date (ISO 8601)
endDateUtc	string	yes	End date (ISO 8601)
isActive	boolean	—	Active status
name	string	yes	Promotion name
nominalDiscountValue	number	—	Fixed discount amount
percentualDiscountValue	number	—	Percentage discount (0-100)
type	string	yes	Promotion type

No output schema declared.

No examples provided.

create_sku ~117

Create a new SKU for a product

Input Output Examples

Name	Type	Req	Description
IsActive	boolean	—	Active status
Name	string	yes	SKU name
PackagedHeight	number	—	Packaged height in cm
PackagedLength	number	—	Packaged length in cm
PackagedWeightKg	number	—	Packaged weight in kg
PackagedWidth	number	—	Packaged width in cm
ProductId	number	yes	Parent product ID
RefId	string	—	Reference ID (internal code)

No output schema declared.

No examples provided.

create_subscription ~121

Create a recurring subscription for a customer (VTEX Subscriptions)

Input Output Examples

Name	Type	Req	Description
customerEmail	string	yes	Customer email
items	array	yes	Items in the subscription (skuId + quantity)
nextPurchaseDate	string	—	ISO 8601 datetime of next purchase
plan	object	yes	Plan / frequency settings
purchaseSettings	object	yes	Purchase settings (currencyCode, paymentMethod, etc.)
shippingAddress	object	yes	Shipping address. Must include addressId or full address fields.
title	string	—	Subscription title

No output schema declared.

No examples provided.

create_warehouse ~88

Input Output Examples

Name	Type	Req	Description
id	string	yes	Warehouse ID (slug, unique)
isActive	boolean	—	Active (default true)
name	string	yes	Warehouse display name
priority	number	—	Priority among warehouses (lower = higher priority)
warehouseDocks	array	—	Docks (shipping origin points) attached to this warehouse

No output schema declared.

No examples provided.

get_catalog ~30

Get the catalog category tree

Input Output Examples

Name	Type	Req	Description
levels	number	—	Number of category tree levels (default 3)

No output schema declared.

No examples provided.

get_giftcard ~29

Get gift card details by ID

Input Output Examples

Name	Type	Req	Description
giftCardId	string	yes	Gift card ID

No output schema declared.

No examples provided.

get_inventory ~28

Get inventory/stock for a SKU across warehouses

Input Output Examples

Name	Type	Req	Description
skuId	number	yes	SKU ID

No output schema declared.

No examples provided.

get_masterdata_document ~72

Get a document (customer profile, custom entity) from VTEX Master Data v2

Input Output Examples

Name	Type	Req	Description
dataEntity	string	yes	Data entity name (e.g., CL for clients)
fields	string	—	Comma-separated fields to return (default: all)
id	string	yes	Document ID

No output schema declared.

No examples provided.

get_order ~26

Get full OMS order details by ID

Input Output Examples

Name	Type	Req	Description
orderId	string	yes	Order ID

No output schema declared.

No examples provided.

get_product ~24

Get product details by ID

Input Output Examples

Name	Type	Req	Description
productId	number	yes	Product ID

No output schema declared.

No examples provided.

get_shipping_rates ~55

Simulate shipping rates for items to a postal code

Input Output Examples

Name	Type	Req	Description
country	string	—	Country code (default BRA)
items	array	yes	Items to simulate
postalCode	string	yes	Destination postal code (CEP)

No output schema declared.

No examples provided.

get_sku_price ~45

Get pricing details for an SKU (base price, list price, markup, cost, fixed prices per trade policy)

Input Output Examples

Name	Type	Req	Description
itemId	string	yes	SKU / item ID

No output schema declared.

No examples provided.

invoice_order ~164

Issue a fiscal invoice (nota fiscal) for an order

Input Output Examples

Name	Type	Req	Description
courier	string	—	Shipping carrier name
invoiceKey	string	—	Fiscal key (chave da NFe)
invoiceNumber	string	yes	Invoice number issued by the ERP
invoiceUrl	string	—	URL to the invoice PDF/XML
invoiceValue	number	yes	Invoice total value in cents
issuanceDate	string	yes	Issuance date in ISO 8601 format
items	array	yes	Items in the invoice
orderId	string	yes	Order ID
trackingNumber	string	—	Tracking number
trackingUrl	string	—	Tracking URL
type	string	yes	Invoice type: Output (sale) or Input (return)

No output schema declared.

No examples provided.

list_categories ~40

List all categories with pagination

Input Output Examples

Name	Type	Req	Description
from	number	—	Start index (default 1)
to	number	—	End index (default 10)

No output schema declared.

No examples provided.

list_coupons ~15

List all promotion coupons

Input Output Examples

Input schema present but exposes no named parameters.

No output schema declared.

No examples provided.

list_customer_orders ~64

List order history for a customer (filtered by email)

Input Output Examples

Name	Type	Req	Description
clientEmail	string	yes	Customer email
page	number	—	Page number (default 1)
per_page	number	—	Items per page
status	string	—	Filter by status

No output schema declared.

No examples provided.

list_orders ~131

List orders with optional filters

Input Output Examples

Name	Type	Req	Description
f_creationDate	string	—	Date range filter (e.g., creationDate:[2024-01-01T00:00:00.000Z TO 2024-12-31T23:59:59.999Z])
page	number	—	Page number (default 1)
per_page	number	—	Items per page (default 15)
q	string	—	Search query (order ID, customer name, email)
status	string	—	Filter by status (e.g., ready-for-handling, payment-approved)

No output schema declared.

No examples provided.

list_price_tables ~18

List all configured price tables (trade policies)

Input Output Examples

Input schema present but exposes no named parameters.

No output schema declared.

No examples provided.

list_products ~53

List products from VTEX catalog

Input Output Examples

Name	Type	Req	Description
categoryId	number	—	Filter by category ID
from	number	—	Start index (default 1)
to	number	—	End index (default 10)

No output schema declared.

No examples provided.

list_skus ~26

List SKUs for a product

Input Output Examples

Name	Type	Req	Description
productId	number	yes	Product ID

No output schema declared.

No examples provided.

list_subscriptions ~59

List customer subscriptions

Input Output Examples

Name	Type	Req	Description
page	number	—	Page number (default 1)
perPage	number	—	Items per page
status	string	—	Filter by status (ACTIVE, PAUSED, CANCELED, EXPIRED)

No output schema declared.

No examples provided.

list_warehouses ~18

List all warehouses configured in the account

Input Output Examples

Input schema present but exposes no named parameters.

No output schema declared.

No examples provided.

search_masterdata ~97

Search documents in a Master Data entity

Input Output Examples

Name	Type	Req	Description
dataEntity	string	yes	Data entity name (e.g., CL for clients)
fields	string	yes	Comma-separated fields (required by VTEX)
rangeEnd	number	—	Pagination end (default 10)
rangeStart	number	—	Pagination start (default 0)
where	string	—	Filter expression (e.g., [email protected])

No output schema declared.

No examples provided.

track_order_invoice ~67

Update tracking info for a previously issued invoice

Input Output Examples

Name	Type	Req	Description
courier	string	—	Carrier name
invoiceNumber	string	yes	Invoice number
orderId	string	yes	Order ID
trackingNumber	string	yes	Tracking number
trackingUrl	string	—	Tracking URL

No output schema declared.

No examples provided.

update_inventory ~62

Update inventory quantity for a SKU at a specific warehouse

Input Output Examples

Name	Type	Req	Description
quantity	number	yes	New quantity
skuId	number	yes	SKU ID
unlimitedQuantity	boolean	—	Set unlimited quantity (default false)
warehouseId	string	yes	Warehouse ID

No output schema declared.

No examples provided.

update_order_status ~30

Transition an order to the handling state (start fulfillment)

Input Output Examples

Name	Type	Req	Description
orderId	string	yes	Order ID

No output schema declared.

No examples provided.

update_product ~88

Update an existing product in the VTEX catalog

Input Output Examples

Name	Type	Req	Description
BrandId	number	—	Brand ID
CategoryId	number	—	Category ID
Description	string	—	Product description
IsActive	boolean	—	Active status
IsVisible	boolean	—	Product visibility
Name	string	—	Product name
productId	number	yes	Product ID to update

No output schema declared.

No examples provided.

update_sku_price ~79

Update base/list/cost price for an SKU

Input Output Examples

Name	Type	Req	Description
basePrice	number	—	Selling base price
costPrice	number	—	Cost price
itemId	string	yes	SKU / item ID
listPrice	number	—	Suggested selling (crossed-out) price
markup	number	—	Markup percentage

No output schema declared.

No examples provided.

On this page

Handy links

Scoring key

80+ high trust
60–79 medium
below 60 low

How we score

Score history · last 30 days

27 Jul 3 Aug