vtex-io-app-contract — Claude Code skill
Checks the VTEX IO app contract in manifest.json, including builders and dependency links. Use it when creating, splitting, or publishing apps.
npx skills add vtex/skills --skill vtex-io-app-contract -a claude-codeWhat vtex-io-app-contract does
This skill reviews the parts that define a VTEX IO app: vendor, name, version, builder declarations, dependencies, peerDependencies, and billingOptions. It connects the manifest with the capabilities the app actually owns.
It helps choose builders for node, graphql, react, admin, store, messages, pixel, and masterdata, and flags cases where a separate app should own a capability. It also targets link and publish failures caused by manifest-level contract decisions.
An app that ships backend or GraphQL code without the matching builder in manifest.json has an incomplete contract, so the platform ignores that capability.
What it helps with
- define a VTEX IO app contract in
manifest.json - match builders to the app’s shipped capabilities
- choose between
dependenciesandpeerDependencies - trace link or publish failures to the manifest
- check app identity and version before publishing
Example prompts for the agent
- Review
manifest.jsonfor this VTEX IO app and recommend the builders it should declare. - Find capabilities that should move into a separate app because the manifest mixes unrelated responsibilities.
- Investigate this publish failure by checking
dependencies,peerDependencies,billingOptions, and the app version.
How to install vtex-io-app-contract
1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-app-contract -a claude-code2Manually: put the files in place
~/.claude/skills/vtex-io-app-contract/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/vtex-io-app-contract/
1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-app-contract -a codex2Manually: put the files in place
.agents/skills/vtex-io-app-contract/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-app-contract -a cursor2Manually: put the files in place
.cursor/skills/vtex-io-app-contract/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install vtex/skills vtex-io-app-contract2Manually: put the files in place
.github/skills/vtex-io-app-contract/SKILL.md1Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-app-contract -a gemini-cli2Platform CLI
gemini skills install https://github.com/vtex/skills --path skills/vtex-io-app-contractManually: put the files in place
.devin/skills/vtex-io-app-contract/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add vtex/skills --skill vtex-io-app-contract -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-app-contract
How do I install vtex-io-app-contract in Claude Code?
Run npx skills add vtex/skills --skill vtex-io-app-contract -a claude-code, then check ~/.claude/skills/vtex-io-app-contract/SKILL.md.
What does vtex-io-app-contract do?
It helps define and review a VTEX IO app contract through manifest.json, builders, dependency relationships, identity, and billing settings.
When should I use dependencies instead of peerDependencies?
Use dependencies for apps that can be installed automatically with the current app. Use peerDependencies for externally managed apps and apps that declare billingOptions.