Skip to main content
skill CX Codex

vtex-io-data-access-patterns — Claude Code skill: overview

Guides AI coding agents on picking the right storage layer across VTEX IO apps. It helps design read pipelines, caching strategies, and data boundaries.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add vtex/skills --skill vtex-io-data-access-patterns -a claude-code
Open on GitHub

What vtex-io-data-access-patterns does

This skill guides decisions on where data belongs across VTEX IO apps. It directs assistants to keep merchant toggles and base endpoints inside app settings. Storing arrays or operational state in settingsSchema is forbidden. Operational entities belong in Master Data or VBase instead.

VTEX platform APIs must remain the primary source of truth for orders and pricing. Local copies must stay strictly limited to lightweight derived attributes. Large reads must rely on database pagination and targeted field selection. Filtering full collections inside Node memory is blocked.

The rules do not cover granular Master Data schema modeling, auth tokens, or runtime sizing.

What it helps with

  • pick between VBase, Master Data, and app settings
  • remove operational transaction arrays from settingsSchema
  • replace in-memory collection filtering with paginated database queries
  • build lean cache representations without cloning core commerce models

Example prompts for the agent

  • Review this VTEX IO service to ensure operational data is not stored in app settings
  • Decide whether we should use VBase or Master Data for storing temporary customer export snapshots
  • Refactor this Master Data query to use server-side pagination instead of loading everything into memory

How to install vtex-io-data-access-patterns

1Skills CLI (Vercel)

npx skills add vtex/skills --skill vtex-io-data-access-patterns -a claude-code

2Manually: put the files in place

~/.claude/skills/vtex-io-data-access-patterns/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/vtex-io-data-access-patterns/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about vtex-io-data-access-patterns

How to install vtex-io-data-access-patterns in Claude Code?

Run npx skills add vtex/skills --skill vtex-io-data-access-patterns -a claude-code in your terminal.

What does vtex-io-data-access-patterns do?

It teaches coding assistants how to choose appropriate data stores and prevents memory-heavy scans in VTEX IO apps.

What falls outside the scope of this skill?

It does not cover Master Data entity modeling, authorization token setup, manifest permissions, or service resource sizing.

Similar skills

All skills for Backend and APIs →

From the same set38

vtex-io-events-and-workers Guides the agent in writing VTEX IO event handlers and workers that survive duplicate delivery. Useful when slow work should leave your HTTP routes. CX Codex +1 1,100installs vtex-io-service-configuration-apps Guides the agent through building VTEX IO configuration apps using the configuration builder. Helps inject decoupled workspace settings into service runtimes. CX Codex +1 1,100installs vtex-io-app-contract Checks the VTEX IO app contract in manifest.json, including builders and dependency links. Use it when creating, splitting, or publishing apps. CX Codex +1 1,100installs vtex-io-service-runtime Guides the runtime layout of a VTEX IO backend app: the Service entrypoint, typed context, and service.json execution settings. CX Codex +1 1,100installs vtex-io-auth-tokens-and-context Decides which VTEX IO token should back a backend request: the app itself, a shopper, or an Admin user. CX Codex +1 1,100installs vtex-io-render-runtime-and-blocks Teaches the agent to expose React components as Store Framework blocks in VTEX IO: store/interfaces.json entries, composition and theme wiring. CX Codex +1 1,100installs vtex-io-client-integration Guides backend integrations in VTEX IO apps using @vtex/api and @vtex/clients. Helps select client classes, configure runtime options, and replace raw HTTP calls. CX Codex +1 1,100installs vtex-io-auth-and-policies This skill guides VTEX IO permission design for integrations, protected routes, and manifest policies. Use it when access boundaries need review or change. CX Codex +1 1,100installs

Project sponsors

Companies that keep this analytics open
Gold sponsor

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor