VTEX IO MCP

io.github.commentemeapp由 GitHub 帳號 commentemeapp 發布v0.2.0更新於 Oct 30, 2026

Scaffold VTEX IO apps, Node services and GraphQL, look up Store Framework block props, search docs

已驗證STDIO僅桌面知識與記憶開發者工具

概覽

AI 產生的概覽

本機 MCP 伺服器,協助助理產生 VTEX IO 應用程式、Node 服務與 GraphQL 骨架,並查詢 Store Framework 區塊、VTEX 文件與 REST API。

可以做什麼
  • 產生 VTEX IO 應用程式骨架,包含 manifest.json 與所選 builder 的資料夾結構
  • 產生 Node 服務(路由、事件處理器)以及含型別化 resolver 的 GraphQL schema
  • 查詢 Store Framework 區塊的 props 與範例,並產生經驗證的 blocks.jsonc JSONC 片段
  • 依關鍵字搜尋 391 份 VTEX 文件與 10 門官方課程,並依 ID 讀取完整概念文件
  • 查詢 catalog、orders、checkout、Master Data、logistics、pricing 等 VTEX REST API 參考
  • 提供概念與課程索引及全文的唯讀資源
適用情境
適合在開發或擴充 VTEX IO 店面與後端時使用:讓助理產生樣板程式碼、核對區塊 props,或直接依據內建的 VTEX 文件回答問題,不必離開編輯器。
執行需求
透過 npx 以 stdio 在本機執行,需要 Node 18 或更新版本;無須事先安裝,也可選擇全域安裝 npm 套件。不需要任何憑證、API 金鑰或環境變數,也不會呼叫外部 API。
安裝前請注意
產生的骨架與 JSONC 片段會由助理寫入你的專案,提交前請自行檢查。內建知識在執行時為唯讀且不會下載任何內容,但它是 VTEX 文件與課程的快照,可能落後於最新版本;目前僅涵蓋少數區塊。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 VTEX IO MCP,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

[vtex-io-mcp · Servidor MCP para desarrollar en VTEX IO: Store Framework, React, Node, GraphQL y Admin.]

vtex-io-mcp

Servidor MCP para desarrollar en VTEX IO: Store Framework, React, Node, GraphQL y Admin.

[npm] [node] [licencia]

Instalación

bash
claude mcp add vtex-io -- npx -y @commenteme/vtex-io-mcp

El cliente MCP corre el servidor con npx, así que no hace falta instalar nada. Requiere Node >= 18. Para Claude Desktop, Cursor, VS Code y Windsurf, mira Clientes MCP.

Uso rápido

Reinicia el cliente y pide lo que necesitas. El asistente elige la herramienta:

  • "Crea una app VTEX IO llamada product-reviews con los builders react, node, graphql y store"
  • "Que props acepta el flex-layout.row? Dame un ejemplo con dos columnas"
  • "Genera un servicio Node con una ruta pública GET /_v/order/:orderId y un handler para order.created"
  • "Arma el esquema GraphQL con una query productReviews(productId: ID!) y una mutation addReview"
  • "Busca en la documentación como funcionan las CSS Handles"
  • "Que endpoints tiene la API de Master Data?"

Que incluye

  • Scaffolding de apps VTEX IO: manifest.json y carpetas para cualquier combinación de builders.
  • Backend listo para empezar: servicio Node con service.json, clients, rutas HTTP y handlers de eventos; esquema GraphQL con resolvers tipados.
  • Store Framework: props, ejemplos y JSONC validado para los blocks del catálogo.
  • Documentación en el editor: 391 documentos de VTEX y 10 cursos oficiales, con búsqueda por palabras clave.
  • Local y sin credenciales: todo el conocimiento va en el paquete. No llama a APIs externas ni pide claves.

Funciona con Claude Code, Claude Desktop, Cursor, VS Code, Windsurf y cualquier cliente MCP por stdio.

Documentación

Clientes MCP

Claude Code. Para compartirlo con el equipo en un repositorio, agrega --scope project al comando de Instalación: la configuración queda en .mcp.json.

Claude Desktop, en claude_desktop_config.json (macOS: ~/Library/Application Support/Claude/, Windows: %APPDATA%\Claude\). Cursor, en ~/.cursor/mcp.json (global) o .cursor/mcp.json (por proyecto). Windsurf, en ~/.codeium/windsurf/mcp_config.json:

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

VS Code, en .vscode/mcp.json:

json
{  "servers": {    "vtex-io": {      "type": "stdio",      "command": "npx",      "args": ["-y", "@commenteme/vtex-io-mcp"]    }  }}

Otros clientes. Cualquiera con transporte stdio sirve: el comando es npx y los argumentos, -y @commenteme/vtex-io-mcp. Si prefieres instalación global, npm install -g @commenteme/vtex-io-mcp y usa vtex-io-mcp como comando.

El servidor está en el Official MCP Registry como io.github.commentemeapp/vtex-io-mcp.

Herramientas

La entrada src/index.ts conecta el servidor por stdio: el cliente inicia el proceso y habla por la entrada y salida estándar, sin abrir puerto HTTP. Las nueve herramientas se registran en src/tools/index.ts.

Apps y backend

herramientaparámetrosque hace
scaffold-vtex-appappName, vendor, builders, version?, description?Genera manifest.json y las carpetas de los builders elegidos: store, react, node, graphql, styles, messages, admin, pixel, docs.
scaffold-node-serviceappName, vendor, routes?, events?, memory?, timeout?Genera node/index.ts, service.json, clients y middlewares. Cada ruta lleva name, path, method y public; cada evento, name, sender y keys.
scaffold-graphqlappName, vendor, queries?, mutations?Genera schema.graphql y los resolvers en TypeScript, con argumentos, tipo de retorno y descripción.

Store Framework

herramientaparámetrosque hace
lookup-block-propsblockNameDevuelve descripción, props y ejemplos de un block.
add-blockblockName, blockId?, props?, children?Genera un fragmento JSONC para blocks.jsonc y valida las props contra el esquema del block.

Blocks disponibles hoy: rich-text, info-card, flex-layout.row, flex-layout.col, shelf, image.

Documentación

herramientaparámetrosque hace
search-conceptsquery, maxResults?Busca por palabras clave en los 391 documentos y devuelve resultados ordenados con extractos.
explain-conceptconceptDevuelve el documento completo de un concepto por su ID.
search-coursesquery, courseId?Busca en los cursos oficiales de VTEX IO y devuelve extractos con contexto.
lookup-vtex-apiapiReferencia REST de una API de VTEX: catalog, orders, checkout, master-data, logistics, pricing, intelligent-search, session, headless-cms, promotions, payments-gateway, license-manager.

Resources

URIcontenido
vtex://conceptsÍndice de los documentos, agrupados por prefijo.
vtex://concepts/{conceptId}Documento completo de un concepto.
vtex://coursesÍndice de los cursos, con título, descripción y número de pasos.
vtex://courses/{id}Contenido completo de un curso: onboarding, basic-blocks, layout-blocks, styles-course, store-block, service-course, calling-commerce-apis, admin, content-workflow, store-performance.

Hoja de ruta

  • Mas blocks de Store Framework: layouts (slider-layout, tab-layout, responsive-layout, stack-layout, condition-layout, modal-layout, disclosure-layout), producto (product-summary, product-images, product-price, sku-selector, buy-button), búsqueda, header, footer, minicart y login
  • Referencia de todos los builders en data/builders/ (hoy: store y node)
  • Herramientas de Store Framework: validate-blocks, create-page-template
  • Herramientas de React: generate-react-component, add-css-handles, create-graphql-query
  • Herramientas de backend: add-route-handler, add-event-handler, create-client, add-graphql-field
  • Herramientas de manifiesto: add-builder, add-dependency, add-policy, generate-manifest
  • Scaffolding de apps Admin y Pixel
  • Resources vtex://builders/{name} y vtex://api/{client} con los clients de @vtex/api
  • Prompts MCP para escenarios comunes: home, PDP, servicio REST, app fullstack, app Admin
  • Scripts de ingestión para actualizar data/ desde los cursos y los README de vtex-apps

Estructura

text
src/├── index.ts          # entry point del binario (stdio)├── server.ts         # McpServer: registra tools y resources├── tools/            # una herramienta por archivo, registradas en tools/index.ts├── resources/        # vtex://concepts y vtex://courses└── knowledge/        # carga y búsqueda sobre data/data/├── blocks/           # un JSON por block + _index.json├── builders/         # referencia por builder├── concepts/         # documentación en Markdown└── courses/          # cursos en Markdown + _index.jsonassets/               # header del README (no va en el paquete npm)

Desarrollo

bash
git clone https://github.com/commentemeapp/vtex-io-mcp.gitcd vtex-io-mcpnpm installnpm run buildnpm run inspect

npm run inspect abre el MCP Inspector sobre build/index.js para llamar cada herramienta y leer los resources sin cliente. Para probar la versión local en un cliente, apunta el comando a la build en vez de npx:

bash
claude mcp add vtex-io-local -- node /ruta/a/vtex-io-mcp/build/index.js
comandoque hace
npm run buildCompila TypeScript en build/ y marca el binario como ejecutable.
npm run devCompilación en modo watch.
npm run lintVerificación de tipos (tsc --noEmit).
npm run inspectAbre el MCP Inspector sobre el servidor compilado.

Agregar una herramienta

  1. Crea src/tools/<nombre>.ts exportando el esquema zod (<nombre>Schema) y la función que devuelve el contenido.
  2. Regístrala en src/tools/index.ts con server.tool(nombre, descripción, esquema, función). La descripción es lo que el modelo lee para decidir cuando usarla: di que hace y con que ejemplos.
  3. Si necesita conocimiento nuevo, agrega los archivos en data/ y cárgalos desde src/knowledge/.
  4. npm run build y pruébala en el Inspector.

Convenciones

  • TypeScript con módulos ESM; Prettier sin punto y coma y con comillas simples.
  • Conventional Commits.
  • El conocimiento es solo lectura en tiempo de ejecución: nada se escribe en disco ni se descarga.

Ramas y publicación

El trabajo nace en una rama que sale de dev y el PR va contra dev. Después de probar localmente, dev se promueve a main con merge de la rama completa (sin qa desde el 30/10/2026). El CI corre lint y build en Node 18, 20 y 22.

Para publicar, sube la versión en package.json y CHANGELOG.md y empuja un tag v*: el workflow publish.yml compila, publica en npm con provenance, crea el GitHub Release y publica el server.json en el MCP Registry. Los cambios de cada versión están en CHANGELOG.md.

Contribuir · Licencia

Abre un issue o un PR contra dev. MIT.


Hecho por commente.me · [email protected]

來源:README.md,提交 6eb200e

工具

9

lookup-block-props

Look up the props, description, and usage examples for any VTEX IO Store Framework block (e.g. rich-text, flex-layout.row, shelf, image, info-card)

輸入參數blockName必填

add-block

Generate a JSONC snippet for a VTEX IO block ready to paste into blocks.jsonc. Validates props against the block schema.

輸入參數propsblockIdchildrenblockName必填

scaffold-vtex-app

Generate a complete VTEX IO app scaffold with manifest.json and all folder structures for the selected builders (store, react, node, graphql, styles, messages, admin, pixel)

輸入參數vendor必填appName必填versionbuilders必填description

scaffold-node-service

Generate a complete Node.js service scaffold for VTEX IO including index.ts, service.json, clients, and middleware handlers for specified routes and events

輸入參數eventsmemoryroutesvendor必填appName必填timeout

scaffold-graphql

Generate a GraphQL schema and resolver files for a VTEX IO app, including schema.graphql and TypeScript resolver stubs for queries and mutations

輸入參數vendor必填appName必填queriesmutations

search-courses

Search for a term across all VTEX IO official courses (basic-blocks, layout-blocks, styles-course, store-block, service-course, admin, calling-commerce-apis, content-workflow, store-performance). Returns excerpts with surrounding context.

輸入參數query必填courseId

explain-concept

Get full documentation for a VTEX concept by exact ID (e.g. "vtex-io-builders", "vtex-io-css-handles", "vtex-io-service-json"). Use search-concepts to find the right ID first.

輸入參數concept必填

search-concepts

Search across 391 VTEX documentation files by keywords. Returns ranked results with excerpts. Use this to find concepts before calling explain-concept.

輸入參數query必填maxResults

lookup-vtex-api

Look up VTEX REST API reference (endpoints, auth, request/response models) for any VTEX API: catalog, orders, checkout, master-data, logistics, pricing, intelligent-search, session, headless-cms, promotions, payments-gateway, license-manager

輸入參數api必填

版本歷史

1
  1. v0.2.0最新Oct 30, 2026

評分

已滿足適用檢查項的 90%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分
  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。

  • 已列出工具必需15 分
  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分