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.
npx skills add vtex/skills --skill vtex-io-data-access-patterns -a claude-codeWhat 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-code2Manually: put the files in place
~/.claude/skills/vtex-io-data-access-patterns/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/vtex-io-data-access-patterns/
1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-data-access-patterns -a codex2Manually: put the files in place
.agents/skills/vtex-io-data-access-patterns/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-data-access-patterns -a cursor2Manually: put the files in place
.cursor/skills/vtex-io-data-access-patterns/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install vtex/skills vtex-io-data-access-patterns2Manually: put the files in place
.github/skills/vtex-io-data-access-patterns/SKILL.md1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-data-access-patterns -a gemini-cli2Platform CLI
gemini skills install https://github.com/vtex/skills --path skills/vtex-io-data-access-patternsManually: put the files in place
.devin/skills/vtex-io-data-access-patterns/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-data-access-patterns -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
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.