VTEX IO MCP

io.github.zeluizrPublished by GitHub account zeluizrv0.1.8Updated Oct 24, 2026

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

VerifiedSTDIODesktop onlyKnowledge & MemoryDeveloper Tools

Overview

AI-generated overview

Local MCP server that helps an assistant scaffold VTEX IO apps, Node services and GraphQL schemas, look up Store Framework block props, and search bundled…

What you can do
  • Scaffold VTEX IO apps: generate manifest.json and folders for chosen builders such as store, react, node, graphql, styles, messages, admin, pixel and docs.
  • Scaffold backend code: Node services with service.json, clients, HTTP routes and event handlers, plus GraphQL schemas with typed resolvers.
  • Work with Store Framework blocks: look up props and examples for a block, and generate validated JSONC fragments for blocks.jsonc.
  • Search bundled documentation: keyword search over 391 VTEX documents and official courses, full concept documents, and REST reference for VTEX APIs such as catalog, orders, checkout and master data.
  • Browse resources: concept and course indexes and full course contents…
When to use it
Useful when building or extending VTEX IO storefronts and backends and you want the assistant to generate boilerplate, check block props, or answer VTEX questions from bundled docs without leaving the editor.
Requirements
Runs locally over stdio via npx, so Node.js 18 or newer is needed; no installation is required. No credentials, API keys or network calls are used, since all knowledge ships in the package.
Before you install
The README says the server makes no external API calls and asks for no keys, and that bundled knowledge is read-only at runtime. Generated files are written by your assistant into your project, so review scaffolding output before committing. Block coverage is currently limited to a handful of blocks.

Installation

In SourceWeft

  1. Open VTEX IO MCP in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Desktop only via STDIO. STDIO servers start a local process, so they need the SourceWeft desktop host.

Other MCP clients

Follow the launch instructions in the repository.

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, Codex, Cursor, Gemini CLI, GitHub Copilot, 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"]    }  }}

Codex, con el CLI (queda en ~/.codex/config.toml):

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

O a mano, en ~/.codex/config.toml o en .codex/config.toml del proyecto:

toml
[mcp_servers.vtex-io]command = "npx"args = ["-y", "@commenteme/vtex-io-mcp"]

Gemini CLI, con el CLI (-s user lo deja en ~/.gemini/settings.json; sin -s, en .gemini/settings.json del proyecto):

bash
gemini mcp add -s user vtex-io npx -y @commenteme/vtex-io-mcp

GitHub Copilot CLI, en ~/.copilot/mcp-config.json o en .mcp.json del proyecto, con el mismo JSON de mcpServers de arriba. En VS Code, Copilot usa el .vscode/mcp.json.

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]

Source: README.md at commit 7ff8413

Tools

0
SourceWeft has not started this package in its sandbox yet, so its tools are not known.

Version history

1
  1. v0.1.8LatestSep 27, 2026

Score

50% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 days25 pts

    Keep the endpoint answering the MCP handshake; SourceWeft probes it every 30 days.

  • Auth declared10 pts

    Declare the credential headers in the registry entry, or keep the endpoint answering the probe so its auth can be classified.

  • Tools listed15 pts

    Answer tools/list without a credential, or ship a package that starts in a sandbox without one.

  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts