mcpField
M
mcp-vtex

mcp-vtex

本地服务
github.com/codespar商业与营销2754 周前更新
代码仓库

关于 mcp-vtex

mcp-vtex 是面向 VTEX 电商平台的 MCP 服务，覆盖商品目录、订单、库存、价格、促销、运费和礼品卡等功能。适合希望通过 AI 助手管理 VTEX 店铺运营的商家与开发者。

主要功能

  1. 01商品、SKU 与分类的查询和维护
  2. 02订单查询、状态流转、开票与取消
  3. 03库存与仓库管理
  4. 04价格表、促销优惠券与礼品卡管理
  5. 05运费模拟与 Master Data 文档查询

适用场景

  1. 01通过 AI 助手查询订单并更新处理状态
  2. 02跨仓库查询和调整 SKU 库存
  3. 03创建促销优惠券或礼品卡

MCP 相关

该项目作为 MCP 服务运行，向 MCP 客户端暴露 33 个 VTEX 相关工具，使客户端能够调用 VTEX API 执行电商运营操作。

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
  "mcpServers": {
    "codespar-mcp-vtex": {
      "command": "npx",
      "args": [
        "-y",
        "@codespar/mcp-vtex"
      ],
      "env": {
        "VTEX_APP_TOKEN": "<VTEX_APP_TOKEN>"
      }
    }
  }
}
启动命令npx -y @codespar/mcp-vtex
需要配置的环境变量
VTEX_APP_TOKEN密钥API key for vtex

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包
npm@codespar/mcp-vtex0.2.2

工具

33

收录的工具列表 · 更新于 2 周前

参数类型必填说明
tonumber否结束索引（默认值为 10）
fromnumber否起始索引（默认值为 1）
categoryIdnumber否按类别 ID 筛选

详细介绍

@codespar/mcp-vtex

面向 VTEX 的 MCP 服务 — 电商平台，支持目录、订单、库存和促销

npm License: MIT

快速开始

Claude Desktop

添加到 ~/.config/claude/claude_desktop_config.json：

{
  "mcpServers": {
    "vtex": {
      "command": "npx",
      "args": ["-y", "@codespar/mcp-vtex"],
      "env": {
        "VTEX_ACCOUNT_NAME": "your-account",
        "VTEX_APP_KEY": "your-app-key",
        "VTEX_APP_TOKEN": "your-app-token"
      }
    }
  }
}
Claude Code
claude mcp add vtex -- npx @codespar/mcp-vtex
Cursor / VS Code

添加到 .cursor/mcp.json 或 .vscode/mcp.json：

{
  "servers": {
    "vtex": {
      "command": "npx",
      "args": ["-y", "@codespar/mcp-vtex"],
      "env": {
        "VTEX_ACCOUNT_NAME": "your-account",
        "VTEX_APP_KEY": "your-app-key",
        "VTEX_APP_TOKEN": "your-app-token"
      }
    }
  }
}

工具（33）

工具用途
list_products列出 VTEX 目录中的商品
get_product根据 ID 获取商品详情
create_product在 VTEX 目录中创建商品
update_product更新 VTEX 目录中的现有商品
list_skus列出商品的 SKU
create_sku为商品创建 SKU
list_categories分页列出所有类别
create_category在目录中创建类别
get_catalog获取目录类别树
list_orders列出订单，可选使用筛选条件
get_order根据 ID 获取完整的 OMS 订单详情
update_order_status将订单转入处理中状态（开始履约）
invoice_order为订单开具税务发票（nota fiscal）
track_order_invoice更新已开具发票的物流跟踪信息
cancel_order取消订单
list_customer_orders列出客户的订单历史记录（按电子邮件筛选）
get_sku_price获取 SKU 的定价详情（基础价格、标价、加价、成本价、按贸易政策设定的固定价格）
update_sku_price更新 SKU 的基础价格、标价或成本价
list_price_tables列出所有已配置的价格表（贸易政策）
get_inventory获取 SKU 在各仓库中的库存
update_inventory更新 SKU 在指定仓库中的库存数量
get_shipping_rates模拟将商品运送至指定邮政编码的运费
list_warehouses列出账户中配置的所有仓库
create_warehouse注册新仓库（履约中心）
create_promotion在 VTEX 中创建促销或折扣
list_coupons列出所有促销优惠券
create_coupon创建促销优惠券代码
list_subscriptions列出客户订阅
create_subscription为客户创建定期订阅（VTEX Subscriptions）
get_masterdata_document从 VTEX Master Data v2 获取文档（客户资料、自定义实体）
search_masterdata搜索 Master Data 实体中的文档
create_giftcard为客户创建礼品卡（GiftCard Hub）
get_giftcard根据 ID 获取礼品卡详情

身份验证

VTEX 使用应用密钥和应用令牌标头进行 API 身份验证。

沙盒 / 测试

VTEX 通过合作伙伴账户提供沙盒访问权限。请联系 VTEX 获取开发者访问权限。

获取凭据
  1. 前往 VTEX Developer Portal
  2. 登录 VTEX 管理后台，或创建合作伙伴账户
  3. 在 License Manager 中生成应用密钥和应用令牌
  4. 设置环境变量

环境变量

变量必填说明
VTEX_ACCOUNT_NAME是VTEX 账户名称
VTEX_APP_KEY是API 应用密钥
VTEX_APP_TOKEN是API 应用令牌
VTEX_ENVIRONMENT否环境主机标识（默认值为 vtexcommercestable）

路线图

v0.3（计划中）
  • 结账 / 购物车会话管理
  • 市场卖家和报价管理
  • 承运商（配送政策）注册

想要参与贡献？提交 PR 或请求添加工具。

链接

企业版

需要为 Agent 付款设置治理、预算上限和审计跟踪？CodeSpar Enterprise 在这些 MCP 服务之上增加了策略引擎、付款路由和合规模板。

许可证

MIT

评论

支持 Markdown

第一次接触 MCP？

从协议是什么，到在客户端里装上第一个服务，这几条回答覆盖了大多数入门问题。

一个开放协议，规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话，MCP 服务负责提供工具、资源和提示模板，两者通过标准消息通信，同一个服务可以被不同客户端复用。